Skip to content

Commit

Permalink
Updated icon and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonnathan committed Oct 12, 2024
1 parent 179e1ce commit 8460372
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 12 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# Skeletor - Ultra-Fast Directory Structure Creator
# Skeletor - Fast and Flexible Directory Structure Generator

[Skeletor](https://www.npmjs.com/package/@seriously/skeletor) is an incredibly fast CLI tool designed to create directory structures and files based on a configuration file in YAML format. Whether you're scaffolding new projects or organising file hierarchies, Skeletor completes the job in milliseconds.
<div><img src="./skeletor.webp" alt="Skeletor Icon" width="150" /></div>

## Key Features
- **Customisable**: Define directory structures in a `.skeletorrc` or YAML file.
- **Non-Destructive**: Existing files and directories are preserved.
- **Simple CLI Interface**: Easy-to-use commands to automatically detect your configuration or specify input files manually.

## Getting Started
[Skeletor](https://www.npmjs.com/package/@seriously/skeletor) is an ultra-fast, customizable CLI tool for generating directory structures and files based on YAML or JSON configuration files. Perfect for scaffolding projects, organizing file hierarchies, or automating file generation tasks.

## Key Features
- **Blazing Fast**: Generate thousands of files and folders in under a second.
- **Flexible Configuration**: Supports both YAML and JSON formats for easy customization.
- **Non-Destructive**: Keeps your existing files safe by default.
- **Cross-Platform**: Works seamlessly on Linux, macOS, and Windows.

## Why Use Skeletor?
If you're a developer or system administrator who frequently needs to set up or scaffold directory structures for new projects, Skeletor is the ideal tool. It's perfect for:
- Rapid **project scaffolding**.
- Organizing complex **file hierarchies**.
- Automating **directory and file creation**.
### Installation

Install Skeletor globally using npm:
Expand Down
Binary file modified bun.lockb
Binary file not shown.
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@
},
"scripts": {
"test": "bun test",
"prepare": "bun link"
"prepare": "bun link",
"coverage": "nyc bun test"
},
"dependencies": {
"marked": "^4.1.0",
"marked-terminal": "^7.1.0",
"yaml": "^2.5.1"
},
"devDependencies": {
"@faker-js/faker": "^9.0.3",
"@types/bun": "latest",
"@faker-js/faker": "^9.0.3"
"nyc": "^17.1.0"
},
"keywords": [
"cli",
Expand Down
2 changes: 0 additions & 2 deletions skeletor.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,6 @@ it("should display help information when --help argument is passed", () => {
// Capture the output of the --help command
const helpOutput = execSync(`bun skeletor.mjs --help`, { encoding: "utf-8" });

console.log(helpOutput)

// Verify that the output contains key phrases from the help text
expect(helpOutput).toContain("# Skeletor"); // Check for 'Usage' section
expect(helpOutput).toContain("Create a .skeletorrc or another YAML file"); // Part of description
Expand Down
Binary file modified skeletor.webp
Binary file not shown.

0 comments on commit 8460372

Please sign in to comment.