dir-parser
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.4 • Public • Published

    😎 Dir Parser v2 😎

    dir-parser

    npm LICENSE MIT NPM Downloads Install Size

    Parse a directory and generate it's structure tree.

    Read this in other languages: English | 简体中文

    1. What is dir-parser

    1.1 Brief introduce

    👍👍👍Dir parser is a powerful folder analysis tool based on nodejs, which can be used in command line or JavaScript code. There are many practical parameters that can be set to help you get the formatted folder tree and internal information.

    1.2 Installation

    1.2.1 Global install

    • yarn: $ yarn global add dir-parser
    • npm: $ npm install -g dir-parser

    1.2.2 Local install

    • yarn: $ yarn add dir-parser or $ yarn add dir-parser -D
    • npm: $ npm install dir-parser or $ npm install dir-parser -D

    2. Command Line

    2.1 Print help info

    $ parser -h (or: $ parser --help)

    Usage: parser [options]
    
    Options:
      -V, --version                   output the version number
      -v, --version                   output the version number
      -c, --config [config]           config file, Optional.
      -i, --input <input>             target directory (default: "./")
      -o, --output <output>           output path (default: "./")
      -d, --depth <depth>             depth of a parse process, 0 means no limit (default: 0)
      -l, --lineType <lineType>       line type of tree, "dashed" or "solid" (default: "solid")
      -e, --excludes <excludes..>     exclude some directories or files by name.
      -x, --excPaths <excPaths..>     exclude directories or files by path.
      -p, --patterns <patterns...>    filter directories or files by RegExp.
      -g, --generate [fileName]       generate a dir-info file to the output path, "dir-info.txt" is default.
      -r, --reverse                   reverse the parsed dir-tree nodes.
      -s, --silent                    not show the parsed dir-tree in terminal.
      -f, --fileFirst                 print files first, before directories.
      -F, --fileOnly                  pase files only.
      -D, --dirOnly                   pase directories only, and it only takes effect when fileOnly is false.
      -I, --ignores <ignores..>       ignore some directories or files by name.
      -N, --no-dirInfo                hide file and directory number info on the result top.
      --paths <paths..>               filter directories or files by path.
      --includes <includes..>         filter directories or files by name.
      --excPatterns <excPatterns...>  exclude directories or files by RegExp.
      -H, --Help                      output chinese usage information.(打印中文帮助信息.)
      -h, --help                      output usage information
    

    2.2 Generate dir-tree

    To run demo, you need to install express-generator:
    Run:
    $ npm install -g express-generator
    $ express myapp
    $ cd myapp
    $ parser

    myapp ( directories: 7, Files: 9 )
     ├─ bin
     │ └─ www
     ├─ public
     │ ├─ images/
     │ ├─ javascripts/
     │ └─ stylesheets
     │   └─ style.css
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    2.3 With parameters

    2.3.1 excludes

    👉 Exclude some directories or files by name.
    $ # git init
    $ npm install
    $ parser -e .git,node_modules,public
    or: $ parser --excludes .git,node_modules,public

    myapp ( directories: 3, Files: 8 )
     ├─ bin
     │ └─ www
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    Name has white space:
    $ touch 'white space.txt'
    $ parser -e '[".git", "node_modules", "public", "white space.txt"]'

    myapp ( directories: 3, Files: 8 )
     ├─ bin
     │ └─ www
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    2.3.2 ignores

    👉 Ignore some directories or files by name.
    $ parser -e node_modules -I bin,public
    or: $ parser -e node_modules --ignores bin,public

    myapp ( directories: 4, Files: 7 )
     ├─ bin/
     ├─ public/
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    2.3.3 patterns

    👉 Filter directories or files by RegExp.
    $ parser -e node_modules -p .js$
    or: $ parser -e node_modules --patterns .js$

    myapp ( directories: 1, Files: 3 )
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     └─ app.js
    

    2.3.4 lineType

    👉 Line type of tree, "dashed" or "solid" (default: "solid")
    $ parser -e bin,node_modules -l dashed
    or: $ parser -e bin,node_modules --lineType dashed

    myapp ( directories: 6, Files: 8 )
     +-- public
     ¦   +-- images/
     ¦   +-- javascripts/
     ¦   +-- stylesheets
     ¦       +-- style.css
     +-- routes
     ¦   +-- index.js
     ¦   +-- users.js
     +-- views
     ¦   +-- error.jade
     ¦   +-- index.jade
     ¦   +-- layout.jade
     +-- app.js
     +-- package.json
    

    2.3.5 depth

    👉 Depth of a parse process, 0 means no limit (default: 0)
    $ parser -e node_modules,views -d 2
    or: $ parser -e node_modules,views --depth 2

    myapp ( directories: 6, Files: 5 )
     ├─ bin
     │ └─ www
     ├─ public
     │ ├─ images/
     │ ├─ javascripts/
     │ └─ stylesheets/*
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ app.js
     └─ package.json
    

    2.3.6 reverse

    👉 Reverse the parsed dir-tree nodes.
    $ parser -e node_modules,views -d 2 -r
    or: $ parser -e node_modules,views -d 2 --reverse

    myapp ( directories: 6, Files: 5 )
     ├─ routes
     │ ├─ users.js
     │ └─ index.js
     ├─ public
     │ ├─ stylesheets/*
     │ ├─ javascripts/
     │ └─ images/
     ├─ bin
     │ └─ www
     ├─ package.json
     └─ app.js
    

    2.3.7 fileFirst

    👉 Print files first, before directories.
    $ parser -e node_modules,bin,views -f
    or: $ parser -e node_modules,bin,views --fileFirst

    myapp ( directories: 5, Files: 6 )
     ├─ app.js
     ├─ dir-info.txt
     ├─ package.json
     ├─ public
     │ ├─ images/
     │ ├─ javascripts/
     │ └─ stylesheets
     │   └─ style.css
     └─ routes
       ├─ index.js
       └─ users.js
    

    2.3.8 fileOnly

    👉 Pase files only.
    $ parser -e node_modules,bin,views -F
    or: $ parser -e node_modules,bin,views --fileOnly

    myapp ( directories: 3, Files: 6 )
     ├─ public
     │ └─ stylesheets
     │   └─ style.css
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ app.js
     ├─ dir-info.txt
     └─ package.json
    

    2.3.9 dirOnly

    👉 Pase directories only, and it only takes effect when fileOnly is false.
    $ parser -e node_modules,bin,views -D
    or: $ parser -e node_modules,bin,views --dirOnly

    myapp ( directories: 5 )
     ├─ public
     │ ├─ images/
     │ ├─ javascripts/
     │ └─ stylesheets/
     └─ routes/
    

    2.3.10 dirInfo

    👉 Hide file and directory number info on the result top.
    $ parser -e node_modules,bin,public -N
    or: $ parser -e node_modules,bin,public --no-dirInfo

    myapp
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     ├─ dir-info.txt
     └─ package.json
    

    2.3.11 excPaths

    👉 Exclude directories or files by path.
    $ parser -e node_modules,bin -x myapp/public
    or: $ parser -e node_modules,bin -excPath myapp/public

    myapp ( directories: 2, Files: 7 )
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    2.3.12 excPatterns

    👉 Exclude directories or files by RegExp.
    $ parser -e node_modules,bin --excPatterns .jade$,.css$

    myapp ( directories: 6, Files: 4 )
     ├─ public
     │ ├─ images/
     │ ├─ javascripts/
     │ └─ stylesheets/
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views/
     ├─ app.js
     └─ package.json
    

    2.3.13 silent

    👉 Not show the parsed dir-tree in terminal.
    $ parser -e node_modules,bin,public -s
    or: $ parser -e node_modules,bin,public --silent

    2.3.14 generate

    👉 Generate a dir-info file to the output path, "dir-info.txt" is default.
    $ parser -e node_modules,bin,public -sg
    or: $ parser -e node_modules,bin,public -s --generate
    $ cat dir-info.txt

    myapp ( directories: 2, Files: 7 )
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     └─ package.json
    

    2.3.15 config

    👉 Config file, Optional.
    $ touch parser.conf.json
    $ vi parser.conf.json

    {
      "directory": "./",
      "excludes": [ ".git", "node_modules", "bin", "public", "parser.conf.json" ],
      "depth": "2",
      "generate": "info.txt"
    }

    $ parser -c ./parser.conf.json

    myapp ( directories: 2, Files: 8 )
     ├─ routes
     │ ├─ index.js
     │ └─ users.js
     ├─ views
     │ ├─ error.jade
     │ ├─ index.jade
     │ └─ layout.jade
     ├─ app.js
     ├─ dir-info.txt
     └─ package.json
    

    2.4 Use multiple commands together

    parser -e node_modules,bin -I views -d 2 -Nr

    myapp
     ├─ views/
     ├─ routes
     │ ├─ users.js
     │ └─ index.js
     ├─ public
     │ ├─ stylesheets/*
     │ ├─ javascripts/
     │ └─ images/
     ├─ parser.conf.json
     ├─ package.json
     └─ app.js
    

    3. In JavaScript

    3.1 Interface

    3.1.1 Main Function-parser

    parser(dirPath: string, options: Options): Promise<Parsed>

    3.1.2 Options

    interface Options {             
      depth?: number;
      reverse?: boolean;
      fileFirst?: boolean;
      fileOnly?: boolean;
      dirOnly?: boolean;
      getFiles?: boolean;
      getChildren?: boolean;
      dirTree?: boolean;             // default: true
      dirInfo?: boolean;             // default: true
      lineType?: 'solid' | 'dashed'; // default: 'solid'
      excludes?: Array<string>;      // eg: [ '.git', 'node_modules', '.idea' ];
      excPaths?: Array<string>;      // eg: [ 'src/app' ];
      excPatterns?: Array<string>;   // eg: [ 'src/*.js ]';
      ignores: Array<string>;        // eg: [ 'public' ];
      includes: Array<string>;       // eg: [ 'app.js' ];
      paths?: Array<string>;         // eg: [ 'src/public' ];
      patterns?: Array<string>;      // eg: [ '*.js ]';
    }

    3.1.3 Parsed

    interface Parsed extends DirInfo {
      dirTree: string;
      children: Array<DirInfo | FileInfo>
      files: Array<FileInfo>
    }

    3.1.4 DirInfo

    interface DirInfo {
      name: string;
      type: 'directory';
      size: number;
      size_kb: number;
      path: string;
      absPath: string;
      dir: string;
      absDir: string;
      dirNum: number;
      fileNum: number;
      children: Array<DirInfo | FileInfo>
    }

    3.1.5 FileInfo

    interface FileInfo {
      name: string;
      base: string;
      ext: string;
      type: 'file';
      size: number;
      size_kb: number;
      path: string;
      absPath: string;
      dir: string;
      absDir: string;
    }

    3.2 Get dir-tree

    3.2.1 Make dir-tree example

    $ npm install funclib
    $ touch test.js
    $ vi test.js

    const fn = require('funclib');
    const parser = require('dir-parser');
    
    parser('./', {
      excludes: excludes,
      // lineType: 'dashed',
      // fileFirst: true,
    }).then(parsed => {
      fn.log(parsed.dirTree, '# parsed.dirTree');
    
      // fn.log(fn.pick(parsed, prop => prop !== 'dirTree'), '# parsed result info');
      // fn.log(parsed.children, '# parsed.children');
      // fn.log(parsed.files, '# parsed.files');
    });

    3.2.2 Run dir-tree example

    $ node test.js

    ==================================================================
                      [17:06:57] # parsed.dirTree
    ------------------------------------------------------------------
    dir-parser ( directories: 8, Files: 30 )
     ├─ bin
     │ └─ parser.js
     ├─ node_modules
     │ ├─ commander
     │ │ ├─ typings
     │ │ │ └─ index.d.ts
     │ │ ├─ CHANGELOG.md
     │ │ ├─ index.js
     │ │ ├─ LICENSE
     │ │ ├─ package.json
     │ │ └─ Readme.md
     │ ├─ funclib
     │ │ ├─ funclib.core.js
     │ │ ├─ funclib.js
     │ │ ├─ funclib.min.js
     │ │ ├─ index.d.ts
     │ │ ├─ index.js
     │ │ ├─ package.json
     │ │ └─ README.md
     │ └─ progress
     │   ├─ lib
     │   │ └─ node-progress.js
     │   ├─ CHANGELOG.md
     │   ├─ index.js
     │   ├─ LICENSE
     │   ├─ Makefile
     │   ├─ package.json
     │   └─ Readme.md
     ├─ src
     │ ├─ base.js
     │ └─ dir-parser.js
     ├─ .gitignore
     ├─ dir-parser.png
     ├─ index.js
     ├─ package.json
     ├─ parser.conf.json
     ├─ README.md
     └─ test.js
    ==================================================================
    

    3.3 Get dir-info

    3.3.1 Make dir-info example

    $ vi test.js

    parser('./', {
      excludes: excludes,
      // lineType: 'dashed',
      // fileFirst: true,
    }).then(parsed => {
      console.log(fn.pretty(fn.pick(parsed, prop => prop !== 'dirTree')));
      
      // fn.log(parsed.dirTree, '# parsed.dirTree');
      // fn.log(parsed.children, '# parsed.children');
      // fn.log(parsed.files, '# parsed.files');
    });

    3.3.2 Run dir-info example

    $ node test.js

    {
      "name": "dir-parser",
      "type": "directory",
      "path": "./",
      "absPath": "E:\\work\\code\\dir-parser",
      "dir": ".",
      "absDir": "E:\\work\\code",
      "dirNum": 8,
      "fileNum": 30
    }

    3.3.3 Make dir-children example

    $ vi test.js

    parser('./', {
      excludes: excludes,
      getFiles: true,    // Default is false, If true, returns will conatins an array of all subfiles's info;
      getChildren: true, // Default is false, If true, returns will conatins an object of all children's info;
      dirTree: false     // Default is true, returns will conatins a tree of the directory;
    }).then(parsed => {
      console.log(fn.pretty(parsed.children));
      // fn.log(parsed.files, '# parsed.files');
    });

    3.3.4 Run dir-children example

    $ node test.js

    [
      {
        "name": "bin",
        "type": "directory",
        "size": 2920,
        "size_kb": "2.85kb",
        "path": "bin",
        "absPath": "E:\\work\\code\\dir-parser\\bin",
        "dir": ".",
        "absDir": "E:\\work\\code\\dir-parser",
        "dirNum": 0,
        "fileNum": 1,
        "children": [
          {
            "name": "parser.js",
            "base": "parser",
            "ext": ".js",
            "type": "file",
            "size": 2920,
            "size_kb": "2.85kb",
            "path": "bin\\parser.js",
            "absPath": "E:\\work\\code\\dir-parser\\bin\\parser.js",
            "dir": "bin",
            "absDir": "E:\\work\\code\\dir-parser\\bin"
          }
        ]
      },
      {
        "name": "src",
        "type": "directory",
        "size": 6488,
        "size_kb": "6.34kb",
        "path": "src",
        "absPath": "E:\\work\\code\\dir-parser\\src",
        "dir": ".",
        "absDir": "E:\\work\\code\\dir-parser",
        "dirNum": 0,
        "fileNum": 2,
        "children": [
          {
            "name": "base.js",
            "base": "base",
            "ext": ".js",
            "type": "file",
            "size": 1038,
            "size_kb": "1.01kb",
            "path": "src\\base.js",
            "absPath": "E:\\work\\code\\dir-parser\\src\\base.js",
            "dir": "src",
            "absDir": "E:\\work\\code\\dir-parser\\src"
          },
          {
            "name": "dir-parser.js",
            "base": "dir-parser",
            "ext": ".js",
            "type": "file",
            "size": 5450,
            "size_kb": "5.32kb",
            "path": "src\\dir-parser.js",
            "absPath": "E:\\work\\code\\dir-parser\\src\\dir-parser.js",
            "dir": "src",
            "absDir": "E:\\work\\code\\dir-parser\\src"
          }
        ]
      },
      {
        "name": ".gitignore",
        "base": ".gitignore",
        "ext": "",
        "type": "file",
        "size": 34,
        "size_kb": "0.03kb",
        "path": ".gitignore",
        "absPath": "E:\\work\\code\\dir-parser\\.gitignore",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "dir-parser.png",
        "base": "dir-parser",
        "ext": ".png",
        "type": "file",
        "size": 76316,
        "size_kb": "74.53kb",
        "path": "dir-parser.png",
        "absPath": "E:\\work\\code\\dir-parser\\dir-parser.png",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "index.js",
        "base": "index",
        "ext": ".js",
        "type": "file",
        "size": 45,
        "size_kb": "0.04kb",
        "path": "index.js",
        "absPath": "E:\\work\\code\\dir-parser\\index.js",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "package.json",
        "base": "package",
        "ext": ".json",
        "type": "file",
        "size": 732,
        "size_kb": "0.71kb",
        "path": "package.json",
        "absPath": "E:\\work\\code\\dir-parser\\package.json",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "parser.conf.json",
        "base": "parser.conf",
        "ext": ".json",
        "type": "file",
        "size": 111,
        "size_kb": "0.11kb",
        "path": "parser.conf.json",
        "absPath": "E:\\work\\code\\dir-parser\\parser.conf.json",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "README.md",
        "base": "README",
        "ext": ".md",
        "type": "file",
        "size": 11467,
        "size_kb": "11.2kb",
        "path": "README.md",
        "absPath": "E:\\work\\code\\dir-parser\\README.md",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "test.js",
        "base": "test",
        "ext": ".js",
        "type": "file",
        "size": 1196,
        "size_kb": "1.17kb",
        "path": "test.js",
        "absPath": "E:\\work\\code\\dir-parser\\test.js",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      }
    ]

    3.3.5 Make dir-files example

    $ vi test.js

    parser('./', {
      excludes: excludes,
      getFiles: true,
      getChildren: true,
      dirTree: false
    }).then(parsed => {
      // fn.log(parsed.children, '# parsed.children');
      console.log(fn.pretty(parsed.files));
    });

    3.3.6 Run dir-files example

    $ node test.js

    [
      {
        "name": "parser.js",
        "base": "parser",
        "ext": ".js",
        "type": "file",
        "size": 2920,
        "size_kb": "2.85kb",
        "path": "bin\\parser.js",
        "absPath": "E:\\work\\code\\dir-parser\\bin\\parser.js",
        "dir": "bin",
        "absDir": "E:\\work\\code\\dir-parser\\bin"
      },
      {
        "name": "base.js",
        "base": "base",
        "ext": ".js",
        "type": "file",
        "size": 1038,
        "size_kb": "1.01kb",
        "path": "src\\base.js",
        "absPath": "E:\\work\\code\\dir-parser\\src\\base.js",
        "dir": "src",
        "absDir": "E:\\work\\code\\dir-parser\\src"
      },
      {
        "name": "dir-parser.js",
        "base": "dir-parser",
        "ext": ".js",
        "type": "file",
        "size": 5450,
        "size_kb": "5.32kb",
        "path": "src\\dir-parser.js",
        "absPath": "E:\\work\\code\\dir-parser\\src\\dir-parser.js",
        "dir": "src",
        "absDir": "E:\\work\\code\\dir-parser\\src"
      },
      {
        "name": ".gitignore",
        "base": ".gitignore",
        "ext": "",
        "type": "file",
        "size": 34,
        "size_kb": "0.03kb",
        "path": ".gitignore",
        "absPath": "E:\\work\\code\\dir-parser\\.gitignore",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "dir-parser.png",
        "base": "dir-parser",
        "ext": ".png",
        "type": "file",
        "size": 76316,
        "size_kb": "74.53kb",
        "path": "dir-parser.png",
        "absPath": "E:\\work\\code\\dir-parser\\dir-parser.png",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "index.js",
        "base": "index",
        "ext": ".js",
        "type": "file",
        "size": 45,
        "size_kb": "0.04kb",
        "path": "index.js",
        "absPath": "E:\\work\\code\\dir-parser\\index.js",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "package.json",
        "base": "package",
        "ext": ".json",
        "type": "file",
        "size": 732,
        "size_kb": "0.71kb",
        "path": "package.json",
        "absPath": "E:\\work\\code\\dir-parser\\package.json",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "parser.conf.json",
        "base": "parser.conf",
        "ext": ".json",
        "type": "file",
        "size": 111,
        "size_kb": "0.11kb",
        "path": "parser.conf.json",
        "absPath": "E:\\work\\code\\dir-parser\\parser.conf.json",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "README.md",
        "base": "README",
        "ext": ".md",
        "type": "file",
        "size": 11467,
        "size_kb": "11.2kb",
        "path": "README.md",
        "absPath": "E:\\work\\code\\dir-parser\\README.md",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      },
      {
        "name": "test.js",
        "base": "test",
        "ext": ".js",
        "type": "file",
        "size": 1196,
        "size_kb": "1.17kb",
        "path": "test.js",
        "absPath": "E:\\work\\code\\dir-parser\\test.js",
        "dir": "",
        "absDir": "E:\\work\\code\\dir-parser"
      }
    ]

    Install

    npm i dir-parser

    DownloadsWeekly Downloads

    67

    Version

    2.1.4

    License

    MIT

    Unpacked Size

    563 kB

    Total Files

    13

    Last publish

    Collaborators

    • cntower