dirfy 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +33 -26
- data/lib/dirfy/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9baf3d0385df461b2d8557113658e3a9c49a6410e96bf81022fe72956c0b958f
|
|
4
|
+
data.tar.gz: 2358d42079537d3f2c8d9de9ca0518381add42673b0838c690d4ad57d09792da
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d1a052b6c69e6d8bc7fc7a99564a15f6336f949c942649c5c0bb904fe7070c3b1b719b2a8e9d965c096d33d444925876bcdbe7beab3a59c945fedafb5f756649
|
|
7
|
+
data.tar.gz: db1c3f4085caa42ac0360d23b4228d16d576f3e371e85eba27c4f3612cb407ec76dcfb97381917c5bf007e9bc0b65d2023dab072573b4d0547baec21afa880ae
|
data/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# Dirfy
|
|
2
2
|
|
|
3
3
|
[](https://github.com/ahmedmelhady7/dirfy/actions)
|
|
4
|
-
[](
|
|
6
|
-
[](https://rubygems.org/gems/dirfy)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](https://www.ruby-lang.org/)
|
|
7
7
|
[](https://github.com/ahmedmelhady7/dirfy/issues)
|
|
8
8
|
|
|
9
9
|
> **Instantly scaffold directory & file structures from any ASCII/Unicode “tree” diagram** 🚀
|
|
@@ -16,21 +16,21 @@ Modern AI code generators (ChatGPT, Copilot, etc.) excel at producing code snipp
|
|
|
16
16
|
|
|
17
17
|
- **Time-consuming & error-prone** when projects are large or deeply nested
|
|
18
18
|
- **Tedious** to type out dozens or hundreds of `mkdir -p` / `touch` commands
|
|
19
|
-
- **Prone to typos** and forgotten directories
|
|
19
|
+
- **Prone to typos** and forgotten directories
|
|
20
20
|
|
|
21
|
-
**Dirfy**
|
|
21
|
+
**Dirfy** automates the entire process: feed it any tree diagram (text or file), and it creates the exact structure—no matter how big—in seconds.
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
|
|
25
25
|
## ✨ Features
|
|
26
26
|
|
|
27
27
|
- **Parse ASCII & Unicode** tree diagrams
|
|
28
|
-
- **Dry-run mode** (`-d`) to preview changes without writing
|
|
29
|
-
- **Verbose logging** (`-v`) for full action reports
|
|
30
|
-
- **Custom indent** support (`-i N`) for non-standard tree outputs
|
|
31
|
-
- **Path prefixing** (`-p DIR/`) to scaffold under any base folder
|
|
28
|
+
- **Dry-run mode** (`-d`, `--dry-run`) to preview changes without writing
|
|
29
|
+
- **Verbose logging** (`-v`, `--verbose`) for full action reports
|
|
30
|
+
- **Custom indent** support (`-i N`, `--indent=N`) for non-standard tree outputs
|
|
31
|
+
- **Path prefixing** (`-p DIR/`, `--prefix=DIR/`) to scaffold under any base folder
|
|
32
32
|
- **Live progress bar** and clear success/failure summary
|
|
33
|
-
- **Zero external dependencies** (pure Ruby ≥2.
|
|
33
|
+
- **Zero external dependencies** (pure Ruby ≥ 2.7)
|
|
34
34
|
|
|
35
35
|
---
|
|
36
36
|
|
|
@@ -65,13 +65,13 @@ cat tree.txt | dirfy
|
|
|
65
65
|
|
|
66
66
|
### Common Options
|
|
67
67
|
|
|
68
|
-
| Flag
|
|
69
|
-
|
|
|
70
|
-
| `-d`, `--dry-run`
|
|
71
|
-
| `-v`, `--verbose`
|
|
72
|
-
| `-i N`, `--indent=N`
|
|
73
|
-
| `-p DIR/`, `--prefix
|
|
74
|
-
| `-h`, `--help`
|
|
68
|
+
| Flag | Description |
|
|
69
|
+
| ---------------------- | -------------------------------------------------- |
|
|
70
|
+
| `-d`, `--dry-run` | Preview actions without creating files/directories |
|
|
71
|
+
| `-v`, `--verbose` | Show each create/skip/fail action |
|
|
72
|
+
| `-i N`, `--indent=N` | Set spaces per tree level (default: `4`) |
|
|
73
|
+
| `-p DIR/`, `--prefix=` | Prepend `DIR/` to every generated path |
|
|
74
|
+
| `-h`, `--help` | Display help and exit |
|
|
75
75
|
|
|
76
76
|
---
|
|
77
77
|
|
|
@@ -110,22 +110,29 @@ Remove `-d` to actually scaffold.
|
|
|
110
110
|
|
|
111
111
|
---
|
|
112
112
|
|
|
113
|
-
##
|
|
113
|
+
## 🤝 Contributing
|
|
114
114
|
|
|
115
|
-
|
|
116
|
-
2. Create a feature branch (`git checkout -b feature/your-feature`)
|
|
117
|
-
3. Commit your changes (`git commit -m "Add feature"`)
|
|
118
|
-
4. Run tests (`bundle exec rake spec`)
|
|
119
|
-
5. Submit a pull request
|
|
115
|
+
We ❤️ pull-requests, issues, code-reviews, and — most importantly — your ideas to make **dirfy** even better.
|
|
120
116
|
|
|
121
|
-
|
|
117
|
+
1. Read our [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions, code style, and the PR process.
|
|
118
|
+
2. Fork the repo, branch off `main`, and open a PR.
|
|
119
|
+
3. Run tests locally:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
bundle install
|
|
123
|
+
bundle exec rake
|
|
124
|
+
```
|
|
125
|
+
4. Ensure your code follows our style (via `rake lint`) and has adequate test coverage.
|
|
126
|
+
5. Celebrate 🎉 — once your PR is merged, add yourself to `AUTHORS.md`!
|
|
127
|
+
|
|
128
|
+
Happy scaffolding! 🚀
|
|
122
129
|
|
|
123
130
|
---
|
|
124
131
|
|
|
125
132
|
## 📝 License
|
|
126
133
|
|
|
127
|
-
|
|
134
|
+
MIT © [Ahmed Elhady](https://github.com/ahmedmelhady7)
|
|
128
135
|
|
|
129
136
|
---
|
|
130
137
|
|
|
131
|
-
> Built with ❤️ to make AI-generated project scaffolding a breeze.
|
|
138
|
+
> Built with ❤️ to make AI-generated project scaffolding a breeze.
|
data/lib/dirfy/version.rb
CHANGED