1313</p >
1414
1515## Table of Contents
16+
1617- [ Features] ( #features )
1718- [ Quick Start] ( #quick-start )
1819- [ Detailed Usage] ( #detailed-usage )
19- - [ Copy Folder Structure] ( #copy-folder-structure )
20- - [ Create Folder Structure] ( #create-folder-structure )
21- - [ Copy File Name] ( #copy-file-name )
20+ - [ Copy Folder Structure] ( #copy-folder-structure )
21+ - [ Create Folder Structure] ( #create-folder-structure )
22+ - [ Copy File Name] ( #copy-file-name )
2223- [ Settings] ( #settings )
2324- [ Preview] ( #preview )
24- - [ Setting] ( #settings-1 )
25- - [ Context Menu] ( #context-menu )
26- - [ Copy File Name] ( #copy-file-name-2 )
27- - [ Create Folder Structure] ( #create-folder-structure-2 )
28- - [ Common Usage] ( #common-usage )
29- - [ With Git Ingest] ( #with-git-ingest )
25+ - [ Setting] ( #settings-1 )
26+ - [ Context Menu] ( #context-menu )
27+ - [ Copy File Name] ( #copy-file-name-2 )
28+ - [ Create Folder Structure] ( #create-folder-structure-2 )
29+ - [ Common Usage] ( #common-usage )
30+ - [ With Git Ingest] ( #with-git-ingest )
3031- [ Copy Folder Structure Output] ( #copy-folder-structure-output )
3132- [ How It Works] ( #how-it-works )
3233- [ Troubleshooting] ( #troubleshooting )
3334- [ License] ( #license )
3435- [ Contact] ( #contact )
3536
3637## Features
38+
3739- Copy Folder Structure
38- - Two output formats:
39- - Plain Text (GitIngest-style tree)
40- - JSON
41- - Context menu integration
42- - Respects .gitignore
40+ - Two output formats:
41+ - Plain Text (GitIngest-style tree)
42+ - JSON
43+ - Context menu integration
44+ - Respects .gitignore
4345
4446- Create Folder Structure
45- - JSON and Plain Text inputs
46- - Modern UI with live preview, validation, and line numbers
47- - Replace/Skip existing items prompt (Replace sends to Trash)
47+ - JSON and Plain Text inputs
48+ - Modern UI with live preview, validation, and line numbers
49+ - Replace/Skip existing items prompt (Replace sends to Trash)
4850
4951- Copy File Name
50- - Quick file name copying to clipboard
52+ - Quick file name copying to clipboard
5153
5254## Quick Start
55+
53561 . Install the extension
54572 . Right-click any folder in Explorer
55583 . Choose "Copy Folder Structure" or "Create Folder Structure"
5659
5760## Detailed Usage
5861
5962### Copy Folder Structure
63+
60641 . Right-click a folder in Explorer
61652 . Select Copy Folder Structure
62663 . Structure is copied in your preferred format (JSON/Plain Text)
6367
6468### Create Folder Structure
69+
65701 . Right-click in Explorer or use Command Palette
66712 . Choose Create Folder Structure
67723 . Select the target directory
68734 . Select format and paste structure
69745 . Click Create
7075
7176### Copy File Name
77+
7278- Right-click any file → Copy File Name
7379
7480## Settings
81+
7582- outputFormat: JSON Format | Plain Text Format
7683- ignorePatterns: patterns to ignore when copying
7784- respectGitignore: whether to honor .gitignore
7885
7986## Preview
8087
8188### Settings
89+
8290<img src =" ./assets/cfs_settings.webp " alt =" Settings " style =" height : 250px ; border : 4px solid rgba (255 , 255 , 255 , 0.9 ); border-radius : 8px ; box-shadow : 0 4px 8px rgba (0 , 0 , 0 , 0.1 );" >
8391
8492### Context Menu
93+
8594<img src =" ./assets/cfs_explorer_context.webp " alt =" Explorer Context " style =" height : 300px ; border : 4px solid rgba (255 , 255 , 255 , 0.9 ); border-radius : 8px ; box-shadow : 0 4px 8px rgba (0 , 0 , 0 , 0.1 );" >
8695
8796### Copy File Name
97+
8898<img src =" ./assets/copy_file_name.gif " alt =" Copy File Name Example " style =" height : 300px ; border : 4px solid rgba (255 , 255 , 255 , 0.9 ); border-radius : 8px ; box-shadow : 0 4px 8px rgba (0 , 0 , 0 , 0.1 );" >
8999
90100### Create Folder Structure
91101
92102#### Common Usage
103+
93104<img src =" ./assets/common_usage.gif " alt =" Common Usage " style =" width : 100% ; border : 4px solid rgba (255 , 255 , 255 , 0.9 ); border-radius : 8px ; box-shadow : 0 4px 8px rgba (0 , 0 , 0 , 0.1 );" >
94105
95106#### With Git Ingest
107+
96108<img src =" ./assets/usage_with_gitIngest.gif " alt =" Usage With Git Ingest " style =" width : 100% ; border : 4px solid rgba (255 , 255 , 255 , 0.9 ); border-radius : 8px ; box-shadow : 0 4px 8px rgba (0 , 0 , 0 , 0.1 );" >
97109
98110## Copy Folder Structure Output
99111
100112- JSON (files as type strings):
113+
101114``` json
102115{
103- "app" : {
104- "api" : {
105- "analyze-typography" : {
106- "route" : " ts"
107- }
108- },
109- "favicon" : " ico" ,
110- "globals" : " css" ,
111- "layout" : " tsx" ,
112- "page" : " tsx"
113- }
116+ "app" : {
117+ "api" : {
118+ "analyze-typography" : {
119+ "route" : " ts"
120+ }
121+ },
122+ "favicon" : " ico" ,
123+ "globals" : " css" ,
124+ "layout" : " tsx" ,
125+ "page" : " tsx"
126+ }
114127}
115128```
116129
117130- Plain Text (GitIngest-style, human-friendly):
131+
118132```
119133Directory structure:
120134└── app/
@@ -128,39 +142,46 @@ Directory structure:
128142```
129143
130144Plain Text rules:
145+
131146- First line is ignored as a header (may contain any text)
132147- Every line must use connectors (├── or └──; ASCII |-- or `-- also supported)
133148- Exactly one root directory (level 0) and it must end with ` / `
134149- Indentation must increase by exactly one level
135150- The UI shows invalid line numbers; if invalid, Create asks for confirmation before proceeding
136151
137152## How It Works
153+
138154### Copy Folder Structure
155+
1391561 . Scans the folder while respecting .gitignore
1401572 . Excludes node_modules and hidden files by default
1411583 . Copies in the selected format:
142- - JSON: hierarchical object; files are type strings (e.g., "index": "ts")
143- - Plain Text: GitIngest-style tree
159+ - JSON: hierarchical object; files are type strings (e.g., "index": "ts")
160+ - Plain Text: GitIngest-style tree
144161
145162### Create Folder Structure
163+
1461641 . Reads input from the webview
1471652 . Validates and parses (JSON or Plain Text)
1481663 . Prompts to Replace/Skip if target items exist; Replace sends to Trash
1491674 . Generates folders and files (no overwrite by default)
150168
151169### Copy File Name
170+
1521711 . Right-click a file in Explorer
1531722 . Copies the file name to clipboard
154173
155174## Troubleshooting
175+
156176- No Option in Context Menu: Reload VS Code (Ctrl+Shift+P → Reload Window)
157177- Clipboard Not Working: Check system permissions
158178- Input Error (Create): Ensure input follows JSON or Plain Text format
159179- Copy File Name Not Working: Ensure a valid local file is selected
160180
161181## License
182+
162183MIT — see [ LICENSE] ( ./LICENSE )
163184
164185## Contact
165- Open an issue on the [ GitHub repository] ( https://github.com/ShreyPurohit/folder-structure-pro-vscode/issues )
166186
187+ Open an issue on the [ GitHub repository] ( https://github.com/ShreyPurohit/folder-structure-pro-vscode/issues )
0 commit comments