Generate an index for a given directory
This module generates a tree view of a given directory.
Usage
CLI API
Usage: indexifier [options] <dir>
Options:
-h, --help output usage information
-V, --version output the version number
-e, --extensions <list> The extensions to take into account (defaults to .htm,.html)
-I, --include <regexp> Include files and directories that are matched by this regular expression (defaults to all)
-E, --exclude <regexp> Exclude files and directories that are matched by this regular expression (defaults to none)
-H, --html Enable to generate HTML output
-L, --no-link-folders Do not link folders when in HTML output mode
-F, --no-empty-directories Do not include empty directories
-D, --max-depth Limit results to a maximum sub-directory depth
Install
npm install -g indexifierExamples
indexifier ./ --extensions .html,.htmwould generate something like this:
A
├─┬ B
│ └── c.html
├── d.html
└── e.html
There is also an HTML flag that would generate the above output as linked HTML:
indexifier --extensions .html --html .<!-- ... -->
<a href="./">A</a><br/>
├─┬ <a href="./B">B</a><br/>
│ └── <a href="./B/c.html">c.html</a><br/>
├── <a href="./d.html">a.html</a><br/>
└── <a href="./e.html">b.html</a><br/>
<!-- ... -->The links are always relative to the given directory.
Node API
indexifier(String directory [, opts={
fileTypes: Array.<String>,
include=undefined: Regexp,
exclude=undefined: Regexp,
isHtml=false: Boolean,
linkFolders=true: Boolean,
emptyFolders=true: Boolean,
maxDepth=Infinity: Number,
}]);
Install
npm install indexifier --saveExamples
Tree of files:
const indexifier = require('indexifier');
const treeOfFiles = indexifier(__dirname);Tree of HTML files:
const indexifier = require('indexifier');
const treeOfHtmlFiles = indexifier(__dirname, { fileTypes: ['.html'] });or for HTML output:
const indexifier = require('indexifier');
const treeOfJpegFiles = indexifier(__dirname, {
fileTypes: ['.jpg', '.jpeg'],
isHtml: true
});
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent