folder-generator 1.3.5 → 1.3.7

package/README.md

@@ -1,152 +1,143 @@
-📂 Folder Structure Generator CLI
-A powerful command-line tool to generate complete folder structures from a simple text diagram. Perfect for quickly scaffolding projects, boilerplates, or standardized directory layouts.
-
-🌟 Features
-Generate nested folders and files with a single command
-
-Supports both direct input and file input
-
-Clear visual feedback with color-coded output
-
-Flexible output directory specification
-
-Lightweight with zero dependencies (except for development)
-
-Cross-platform (Windows, macOS, Linux)
-
-📦 Installation
-Global Installation (Recommended)
-bash
-npm install -g folder-structure-generator
-(This allows running the tool from anywhere using foldgen)
-
-Local Installation
-bash
-npm install folder-structure-generator --save-dev
-(Useful when you want it as part of your project's dev tools)
-
-🚀 Basic Usage
-1. Direct Input
-bash
-foldgen --input "src/
-├── App.js
-├── index.js
-└── components/
-    ├── Button.js
-    └── Header.js"
-2. From a File
-bash
-foldgen --file structure.txt
-3. From STDIN (Piping)
-bash
-echo "config/
-├── default.json
-└── production.json" | foldgen
-🔧 Advanced Usage
-Specify Output Directory
-bash
-foldgen --input "lib/utils.js" --output ./my-project
-Combine with Other Tools
-bash
-curl https://example.com/structure.txt | foldgen --output ./src
-Generate in Current Directory
-bash
-foldgen --input "README.md"  # Creates in current folder
-📝 Syntax Guide
-The generator understands standard tree diagram notation:
-
-text
-root/
-├── file.ext
-└── folder/
-    ├── nested_file.ext
-    └── empty_folder/
-Special Characters:
-
-├── for intermediate items
-
-└── for the last item in a level
-
-│ for vertical connections
-
-(spaces) for indentation (4 spaces per level)
-
-🛠️ API Reference (for programmatic use)
-javascript
-const { parseStructure, createFiles } = require('folder-structure-generator');
-
-// Parse text to structure object
-const structure = parseStructure(`src/index.js`);
-
-// Generate files
-createFiles(structure, './output-path');
-🧩 Integration with Other Tools
-With curl:
-bash
-curl -s https://raw.githubusercontent.com/your/repo/base-structure.txt | foldgen
-In package.json scripts:
-json
-{
-  "scripts": {
-    "setup": "foldgen --file project-structure.txt --output ./src",
-    "create:components": "foldgen --input 'src/components/\n├── Button.js\n└── Modal.js'"
-  }
-}
-🏗️ Example Structures
-React Project
-text
-src/
-├── App.js
-├── index.js
-├── components/
-│   ├── Button/
-│   │   ├── index.js
-│   │   ├── styles.css
-│   │   └── tests.js
-│   └── Header.js
-├── pages/
-│   └── Home.js
-└── utils/
-    └── api.js
-Node.js API
-text
-app/
-├── config/
-│   └── database.js
-├── controllers/
-│   └── userController.js
-├── models/
-│   └── User.js
-├── routes/
-│   └── index.js
-├── app.js
-└── package.json
-❓ FAQ
-Q: Can I add content to the generated files?
-A: Currently the tool creates empty files. We're working on template support in the next version!
-
-Q: How do I handle spaces in file names?
-A: Just include them normally in your input: "My Document.docx"
-
-Q: What if I make a mistake in the syntax?
-A: The tool will show you an error with the problematic line number.
-
-🐛 Troubleshooting
-Error: EACCES permission denied
-Solution: Run with sudo or fix your npm permissions:
-
-bash
-sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}
-Error: Missing input
-Solution: Either provide --input, --file, or pipe content to the command
-
-🤝 Contributing
-Fork the repository
-
-Create a feature branch (git checkout -b feature/awesome-feature)
-
-Commit your changes (git commit -am 'Add awesome feature')
-
-Push to the branch (git push origin feature/awesome-feature)
-
-Open a Pull Request
+# 📁 Folder Structure Generator CLI
+
+[![npm version](https://img.shields.io/npm/v/folder-structure-generator)](https://www.npmjs.com/package/folder-structure-generator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A powerful CLI tool that generates complete folder structures from simple text diagrams. Perfect for quickly scaffolding projects, boilerplates, or standardized directory layouts.
+
+## ✨ Features
+
+- Generate nested folders and files with a single command
+- Supports both direct input and file input
+- Cross-platform (Windows, macOS, Linux)
+- Clear visual feedback with color-coded output
+- Flexible output directory specification
+- Lightweight with minimal dependencies
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+```bash
+npm install -g folder-structure-generator
+```
+
+### Local Installation
+```bash
+npm install folder-structure-generator --save-dev
+```
+
+## 🚀 Usage
+
+### From Direct Input
+```bash
+foldgen --input "src/
+├── App.js
+├── index.js
+└── components/
+    ├── Button.js
+    └── Header.js"
+```
+
+### Using npx
+```bash
+npx folder-generator --file structure.txt
+``` 
+
+### From File
+```bash
+foldgen --file structure.txt
+```
+
+### From STDIN (Piping)
+```bash
+echo "config/
+├── default.json
+└── production.json" | foldgen
+```
+
+
+### Specify Output Directory
+```bash
+foldgen --file structure.txt --output ./my-project
+```
+
+## 📝 Syntax Guide
+
+The generator understands standard tree diagram notation:
+
+```
+project/
+├── README.md
+├── src/
+│   ├── index.js
+│   └── utils/
+│       └── helpers.js
+└── tests/
+    └── index.test.js
+```
+
+**Special Characters:**
+
+- `├──` for intermediate items
+- `└──` for the last item in a level
+- `│` for vertical connections
+- Spaces for indentation (4 spaces per level)
+
+## 🛠️ Programmatic API
+
+```javascript
+const { parseStructure, createFiles } = require('folder-structure-generator');
+
+const structure = parseStructure(`src/index.js`);
+createFiles(structure, './output');
+```
+
+## 📂 Example Structure Files
+
+**React Project (react-structure.txt):**
+```
+src/
+├── App.jsx
+├── index.js
+├── components/
+│   ├── Button/
+│   │   ├── index.jsx
+│   │   └── styles.module.css
+│   └── Header.jsx
+├── pages/
+│   └── Home.jsx
+└── utils/
+    └── api.js
+```
+
+**Node.js API (node-structure.txt):**
+```
+app/
+├── config/
+│   └── database.js
+├── controllers/
+│   └── userController.js
+├── models/
+│   └── User.js
+├── routes/
+│   └── api.js
+├── app.js
+└── package.json
+```
+
+## 🤝 Contributing
+
+- Fork the repository
+- Create your feature branch (`git checkout -b feature/amazing-feature`)
+- Commit your changes (`git commit -m 'Add some amazing feature'`)
+- Push to the branch (`git push origin feature/amazing-feature`)
+- Open a Pull Request
+
+## 📜 License
+
+MIT © Shreyash Ghanekar
+
+## 🙏 Acknowledgments
+
+- Inspired by the need for quick project scaffolding
+- Built with Node.js and love

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "folder-generator",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "CLI tool to generate folder structures from text input",
   "bin": {
     "foldgen": "./bin/cli.js"