https://github.com/imcuttle/directory-tree
get directory tree string on node.
https://github.com/imcuttle/directory-tree
Last synced: 4 months ago
JSON representation
get directory tree string on node.
- Host: GitHub
- URL: https://github.com/imcuttle/directory-tree
- Owner: imcuttle
- Created: 2016-09-12T07:56:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T14:03:37.000Z (over 4 years ago)
- Last Synced: 2025-04-10T10:09:49.126Z (about 1 year ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# directory-tree
print your directory on shell and clipboard.
## Get Started
- Bash
```sh
npm i -g print-dir
pdir -h
pdir [.] [-t ./theme.json] [--igd "node,theme"] [--sort dir] [-o ./out.txt] [-m 5]
```
- Package
```js
var dirTree = require('print-dir')
let treeData = dirTree({
dir: '.',
theme: {
"node": "├── ",
"pipe": "│ ",
"last": "└── ",
"indent": " ",
"dir_suffix": "/"
},
maxLev: 2,
ignoresFile: [],
ignoresDir: [],
prefix: " ",
isLine: false, // don't print line by line
sort: ""
})
/*
return
treeData.treeString
treeData.infoString
treeData.fileNum
treeData.dirNum
*/
```
## Default Options
```js
const default_options = {
t: path.resolve(__dirname, "./themes/default.json"), // theme of char
_: [process.cwd()], // directory
igf: "", // ignores files (regular expression matching)
igd: "", // ignores dirs (regular expression matching)
prefix: '', // prefix of each line
pa: false, // print all at once
sort: '' // file sort by "file"/"dir", default is sort by filename.
// o: "./out.txt" // store where
//m: 1 // max Level
}
```
## Default Theme
```json
{
"node": "├── ",
"pipe": "│ ",
"last": "└── ",
"indent": " ",
"dir_suffix": "/"
}
```