structurized

Follow defined structure of project.

npm i structurized --save-dev -g

Example

1. Define structure at root of project

• create structure.yml file at root path of project.
• write rules of structure in human readable form.

structure.yml

root:
 - Folder1
 - Folder2
 - File.any

Nested folders.

root:
  - Folder1:
    - Folder1-1
    - Folder1-2
    - File1-1.js
  - Folder2
  - File.js

Use micromatch's matching features format to match multiple files/folders

root:
  - Routes:
    - matcher:
        match: "*.Routes.js"  #don't include dash here (before match) 
  - Modals
  - index.js
 

Nest the matcher

root:
  - src:
    - Components:
      - matcher:
          match: "projectName-*"
          root:
            - index.js
    - Dashboard.js
  - index.js

Remember syntax for matcher, don't include dash before match as it will result in error.

2. Get report.

Type following command.

structurize

More features in upcoming versions.