https://github.com/jrainlau/filemap
A tool for creating files structure tree map.
https://github.com/jrainlau/filemap
Last synced: 20 days ago
JSON representation
A tool for creating files structure tree map.
- Host: GitHub
- URL: https://github.com/jrainlau/filemap
- Owner: jrainlau
- License: mit
- Created: 2016-07-14T12:39:42.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-06T09:02:26.000Z (almost 7 years ago)
- Last Synced: 2025-03-24T20:40:52.374Z (about 1 month ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 41
- Watchers: 5
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduce
`filemap.js` is a tool for creating files structure tree map. It's light, fast, and clever. It helps you to creat a files structure tree map automatically by one line of command.
if -d dir contains .gitignore, the script will read it and add lines to ignore configure.
## Usage && Example
```
npm install filemap.js -g
filemap
```
And you will get a files structure tree map like this
```
The files tree is:
=================
|__ empty.js
|__ folder1
|__ folder-inside.md
|__ folder2
|__ inside1
|__ 5555.txt
|__ inside2
|__ hello.txt
|__ staff
|__ test.txt
|__ some.html
|__ TEST
|__ xxx
|__ test.md
```
## Options
```
node tree.js -d ./project/ -i node_modules .DS_Store .dist > tree.text
```
- -d: Read from dir.
- -i: In order to ignore some folders which contains lots of files and folders, such as `node_modules` etc, you could use this command to avoid them to be unfolded. Use blank to split each `folder-name`.
## Update
Set the `filemap.js` into global command.
## License
MIT