# fs-listr

> List of files and directories from a specific path.

Latest version **1.0.2** (published 2016-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-listr
pnpm add fs-listr
yarn add fs-listr
bun add fs-listr
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-08-25 |
| First published | 2016-08-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | robert |
| Maintainers | dobre-robert-marius |
| Keywords | ncl |

## Links

- npm: https://www.npmjs.com/package/fs-listr
- npm.io page: https://npm.io/package/fs-listr

## Recent versions

- 1.0.2 (latest) — 2016-08-25
- 1.0.1 — 2016-08-25

## README

## 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](https://twitter.com/robert_cnih87)

## Versioning ##

This library follows [Semantic Versioning](http://semver.org)

## 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.

---
_Source: https://npm.io/package/fs-listr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._