make-folder-txt 1.4.2 → 1.4.4
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.
- package/README.md +12 -1
- package/bin/make-folder-txt.js +6 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
Perfect for sharing your codebase with **AI tools**, **teammates**, or **code reviewers** — without zipping files or giving repo access.
|
|
13
13
|
|
|
14
|
-
[Installation](#-installation) · [Usage](#-usage) · [Output Format](#-output-format) · [What Gets Skipped](#-what-gets-skipped) · [Contributing](#-contributing)
|
|
14
|
+
[Installation](#-installation) · [Usage](#-usage) · [Help](#-get-help) · [Output Format](#-output-format) · [What Gets Skipped](#-what-gets-skipped) · [Contributing](#-contributing)
|
|
15
15
|
|
|
16
16
|
</div>
|
|
17
17
|
|
|
@@ -22,7 +22,9 @@ Perfect for sharing your codebase with **AI tools**, **teammates**, or **code re
|
|
|
22
22
|
Ever needed to share your entire project with ChatGPT, Claude, or a teammate — but copy-pasting every file one by one is painful? **make-folder-txt** solves that in one command.
|
|
23
23
|
|
|
24
24
|
- ✅ Run it from any project directory — no arguments needed
|
|
25
|
+
- ✅ Built-in help system with `--help` flag
|
|
25
26
|
- ✅ Generates a clean folder tree + every file's content
|
|
27
|
+
- ✅ `.txtignore` support (works like `.gitignore`)
|
|
26
28
|
- ✅ Automatically skips `node_modules`, binaries, and junk files
|
|
27
29
|
- ✅ Zero dependencies — pure Node.js
|
|
28
30
|
- ✅ Works on Windows, macOS, and Linux
|
|
@@ -50,6 +52,15 @@ make-folder-txt
|
|
|
50
52
|
|
|
51
53
|
That's it. A `my-project.txt` file will be created in the same directory.
|
|
52
54
|
|
|
55
|
+
### 📖 Get Help
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
make-folder-txt --help # Show all options and examples
|
|
59
|
+
make-folder-txt -h # Short version of help
|
|
60
|
+
make-folder-txt --version # Show version info
|
|
61
|
+
make-folder-txt -v # Short version of version
|
|
62
|
+
```
|
|
63
|
+
|
|
53
64
|
Ignore specific folders/files by name:
|
|
54
65
|
|
|
55
66
|
```bash
|
package/bin/make-folder-txt.js
CHANGED
|
@@ -176,8 +176,10 @@ if (args.includes("--help") || args.includes("-h")) {
|
|
|
176
176
|
console.log(`
|
|
177
177
|
\x1b[33mmake-folder-txt\x1b[0m
|
|
178
178
|
Dump an entire project folder into a single readable .txt file.
|
|
179
|
+
|
|
179
180
|
\x1b[33mUSAGE\x1b[0m
|
|
180
181
|
make-folder-txt [options]
|
|
182
|
+
|
|
181
183
|
\x1b[33mOPTIONS\x1b[0m
|
|
182
184
|
--ignore-folder <names...> Ignore specific folders by name
|
|
183
185
|
--ignore-file <names...> Ignore specific files by name
|
|
@@ -185,15 +187,18 @@ Dump an entire project folder into a single readable .txt file.
|
|
|
185
187
|
--only-file <names...> Include only specific files
|
|
186
188
|
--help, -h Show this help message
|
|
187
189
|
--version, -v Show version information
|
|
190
|
+
|
|
188
191
|
\x1b[33mEXAMPLES\x1b[0m
|
|
189
192
|
make-folder-txt
|
|
190
193
|
make-folder-txt --ignore-folder node_modules dist
|
|
191
194
|
make-folder-txt --ignore-file .env .env.local
|
|
192
195
|
make-folder-txt --only-folder src docs
|
|
193
196
|
make-folder-txt --only-file package.json README.md
|
|
197
|
+
|
|
194
198
|
\x1b[33m.TXTIGNORE FILE\x1b[0m
|
|
195
199
|
Create a .txtignore file in your project root to specify files/folders to ignore.
|
|
196
200
|
Works like .gitignore - supports file names, path patterns, and comments.
|
|
201
|
+
|
|
197
202
|
Example .txtignore:
|
|
198
203
|
node_modules/
|
|
199
204
|
*.log
|
|
@@ -389,4 +394,4 @@ const sizeKB = (fs.statSync(outputFile).size / 1024).toFixed(1);
|
|
|
389
394
|
console.log(`✅ Done!`);
|
|
390
395
|
console.log(`📄 Output : ${outputFile}`);
|
|
391
396
|
console.log(`📊 Size : ${sizeKB} KB`);
|
|
392
|
-
console.log(`🗂️
|
|
397
|
+
console.log(`🗂️ Files : ${filePaths.length}\n`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "make-folder-txt",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.4",
|
|
4
4
|
"description": "Generate a single .txt file containing the full folder structure and file contents of any project, ignoring node_modules and other junk.",
|
|
5
5
|
"main": "bin/make-folder-txt.js",
|
|
6
6
|
"bin": {
|