Kigi

Kigi allows you to create a folder structure in the form of json or in the form of a string if you just want a nice way to see it.

 npm i -s kigi

Json example

const {
  treeJson
} = require('kigi')
async function showJson() {
  const options = {
    level: 2
  }
  const json = await treeJson(path.join(__dirname, 'levels', options)
  console.log(json)
}
showJson()
{ 
  path: '/path/tree-directory/test/levels',
  name: 'levels',
  size: 139,
  isSymbolicLink: false,
  createAt: 2018-08-30T01: 18: 57.086Z,
  updateAt: 2018-08-30T01: 18: 57.086Z,
  children: [
   {
       path: '/path/tree-directory/test/levels/2-file-1-link.txt',
       name: '2-file-1-link.txt',
       size: 76,
       isSymbolicLink: true,
       createAt: 2018-08-30T01: 18: 57.086Z,
       updateAt: 2018-08-30T01: 18: 57.086Z,
       realPath: '/path/tree-directory/test/levels/level1-dir-1/2-file-1.txt'
   },
   {
       path: '/path/tree-directory/test/levels/level1-dir-1',
       name: 'level1-dir-1',
       size: 0,
       isSymbolicLink: false,
       createAt: 2018-08-27T23: 09: 37.505Z,
       updateAt: 2018-08-27T23: 09: 37.505Z,
       children: [],
       type: 'directory'
    },
    { 
       path: '/path/tree-directory/test/levels/level1-dir-1-link',
       name: 'level1-dir-1-link',
       size: 63,
       isSymbolicLink: true,
       createAt: 2018-08-30T01: 08: 29.102Z,
       updateAt: 2018-08-30T01: 08: 29.102Z,
       realPath: '/path/tree-directory/test/levels/level1-dir-1'
   },
   {
       path: '/path/tree-directory/test/levels/level1-dir-2',
       name: 'level1-dir-2',
       size: 0,
       isSymbolicLink: false,
       createAt: 2018-08-27T23: 10: 43.674Z,
       updateAt: 2018-08-27T23: 10: 43.674Z,
       children: [{
        path: '/path/tree-directory/test/levels/level1-dir-3',
        name: 'level1-dir-3',
        size: 0,
        isSymbolicLink: false,
        createAt: 2018-08-27T23: 10: 43.674Z,
        updateAt: 2018-08-27T23: 10: 43.674Z,
        children: [],
        type: 'directory'
       }],
       type: 'directory'
  }],
  type: 'directory'
}

String example

const {
  tree
} = require('kigi')
async function showString () {
  const options = {
    showHiddenFiles: true,
    extensions: /txt|jpeg/
  }
  const string = await tree(path.join(__dirname, 'levels'),  options)
  console.log(string)
}

showString()

Options

options = {
    level: 20 // depth option, default 20
    onlyDir: false // Show only directories default false
    showHiddenFiles: false // Show files and folder that start with '.', default false
    exclude: /privatePath/ or [/privatePath/, /git/] // Excludes files or directories, default null
    extensions: /txt|png/ // show files only the extensions is txt or png, default null
}

The options can change the size of folder !

Try

node example/example.js

Todo

• Test
• More options