fs-listr

fs-listr

List of files and directories from a specific path.

Install

npm install

Example

Listr will receive a path as a string and (optionally) a list of excluded directories:

const listr = require('fs-listr')
const excluded = ['.git', 'node_modules', 'bower_components']

const result = listr('path/to/a/directory', excluded);

And it will return an object:

{
    type: 'directory',
    contents: [
        {name: 'a.js', type: 'file'},
        {name: 'b.js', type: 'file'},
        {
            name: 'c',
            type: 'directory',
            contents: [
                {name: 'd.js', type: 'file'},
                {name: 'e.js', type: 'file'}
            ]
        }
    ]
}

for a directory with the following structure:

/.git/
/node_modules/
/a.js
/b.js
/c/d.js
/c/e.js

Deploy

grunt deploy

Authors

• Robert Dobre

Versioning

This library follows Semantic Versioning

MIT License

The MIT License (MIT)

Copyright (c) 2015 - 2020 dobre robert marius

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.