``text
├── folder-tree-generator
│ ├── .editorconfig
│ ├── .gitignore
│ ├── .prettierrc.json
│ ├── README.md
│ ├── package-lock.json
│ ├── package.json
│ ├── src
│ │ ├── example
│ │ │ └── index.ts
│ │ ├── folder1
│ │ │ ├── folder2
│ │ │ ├── folder3
│ │ │ │ └── folder4
│ │ ├── index.ts
│ │ ├── bin
│ │ │ └── index.ts
│ │ ├── utils
│ │ │ ├── drawTreeFromJsonDir.ts
│ │ │ ├── ftg.ts
│ │ │ ├── index.ts
│ │ │ ├── parseDirToJson.ts
│ │ │ └── sortFolder.ts
│ └── tsconfig.json
`

CLI Usage

$3

`sh
npm i folder-tree-generator -g
`

$3

`sh
$ ftg [options]
`

Help options

`sh
$ ftg --help

Usage: dist [options]

Options:
-V, --version output the version number
-d, --directory [dir] Directory path. (default: "[current path]")
-f, --folder-only Draw folders only.
-s, --sort Sort alphabetically and put folders first and then files.
-c, --comments Show "Empty folder" comment (--folder-only must be false)
-e, --export [path] Set the folder path to export "ftg_tree_[date].txt" or just -e or --export for the default export to the current path
-i, --ignore [regex] Regex list to ignore folders and/or files (separated by commas) - eg: "example($|/.*),index.ts"
--emojis Show emojis - folder: 📁 - File: 📄
-h, --help display help for command
`

$3

`sh
npx folder-tree-generator [options]
`

Code Usage

`sh
npm i folder-tree-generator
`

`typescript
import { ftg, FtgOptions } from 'folder-tree-generator'

// get current path
const path = process.cwd()

// ftg options
const options: FtgOptions = { sort: true, emojis: true }

console.log('👇👇 Tree with options:', options)


const tree = ftg(path, options)
console.log(tree)

// OUTPUT

👇👇 Tree with options: { sort: true, emojis: true }
├── 📁 folder-tree-generator
│ ├── 📁 src
│ │ ├── 📁 example
│ │ │ └── 📄 index.ts
│ │ ├── 📁 bin
│ │ │ └── 📄 index.ts
│ │ ├── 📁 utils
│ │ │ ├── 📄 drawTreeFromJsonDir.ts
│ │ │ ├── 📄 ftg.ts
│ │ │ ├── 📄 index.ts
│ │ │ ├── 📄 parseDirToJson.ts
│ │ │ └── 📄 sortFolder.ts
│ │ └── 📄 index.ts
│ ├── 📄 .editorconfig
│ ├── 📄 .gitignore
│ ├── 📄 .prettierrc.json
│ ├── 📄 README.md
│ ├── 📄 package-lock.json
│ ├── 📄 package.json
│ └── 📄 tsconfig.json

`

$3

| Terminal | Code | Type | Default | Description |
| -------------------- | ------------------- | ------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| -d -directory [dir] | Path is a parameter | string | Terminal: currentFolder - Code: path is required param | Folder Path |
| -f, --folders-only | folderOnly | boolean | false | generate tree only with folders (ignore files) |
| -s, --sort | sort | boolean | false | Sort alphabetically and put folders first and then files. |
| -c, --comments | comments | boolean | false | Show "Empty folder" comment (--folder-only must be false) |
| -e, --export [path] | [Not Available] | string | false | Set the folder path to export "ftg_tree_[date].txt" or just -e or --export for the default export to the current path |
| -i, --ignore [regex] | ignore | string | false | Regex list to ignore folders and/or files (separated by commas) - eg: "example($|/.\*),index.ts" |
| --emojis | emojis | boolean | false | Show emojis - folder: 📁 - File: 📄 |

Ignore files/folders

By default ftg ignore the following files and folders

- .vscode
- .DS_Store
- .git
- node_modules
- dist
- coverage
- .husky

$3

Example

Ignore all index.ts files and folders named "/example"

`sh
ftg -i 'example($|/.*),index.ts'
`

Output

`sh
├── folder-tree-generator
│ ├── .editorconfig
│ ├── .prettierrc.json
│ ├── .versionrc
│ ├── CHANGELOG.md
│ ├── LICENSE
│ ├── README.md
│ ├── package-lock.json
│ ├── package.json
│ ├── src
│ │ ├── bin
│ │ ├── utils
│ │ │ ├── drawTreeFromJsonDir.ts
│ │ │ ├── ftg.ts
│ │ │ ├── parseDirToJson.ts
│ │ │ └── sortFolder.ts
│ └── tsconfig.json
`

Comments

If files and folders are included and the comments option is also added, empty folders will show the comment "# Empty folder"

`sh
├── folder-tree-generator
│ ├── .editorconfig
│ ├── .gitignore
│ ├── .prettierrc.json
│ ├── README.md
│ ├── package-lock.json
│ ├── package.json
│ ├── src
│ │ ├── example
│ │ │ └── index.ts
│ │ ├── folder1
│ │ │ ├── folder2 # Empty folder
│ │ │ ├── folder3
│ │ │ │ └── folder4 # Empty folder
│ │ ├── index.ts
│ │ ├── bin
│ │ │ └── index.ts
│ │ ├── utils
│ │ │ ├── drawTreeFromJsonDir.ts
│ │ │ ├── ftg.ts
│ │ │ ├── index.ts
│ │ │ ├── parseDirToJson.ts
│ │ │ └── sortFolder.ts
│ └── tsconfig.json
``

TODO

- Unit testing jest
- Add command flags
- --sort ✅
- --folder-only ✅
- --ignore (regex[]) ✅
- --export ✅
- --size (include file/folder size)
- add ftg() options
- sort ✅
- folderOnly ✅
- ignore (regex[]) ✅
- size (include file/folder size)
- Add comment "# Empty folder" (if you are including files but the folder is empty literally) ✅
- Interactive terminal
- Show available version in terminal ✅
- Show emojis ✅
- CHANGELOG.md ✅