Structure Lint 📁

A linter to check the directory/file structure of your projects.

Install CLI

Install globally with npm

npm install -g structure-lint

Or with Yarn

yarn global add structure-lint

Install as a package

npm install structure-lint

Or with Yarn

yarn add structure-lint

Then add the following command to your package.json file:

{
  "scripts": {
    "structure-lint": "structure-lint"
  }
}

Usage

Create a .structlintrc file in the root of your project. See the example config file below:

{
  "root": "src",
  "rules": [
    "utils/*.ts",
    "hooks/*.ts",
    "interfaces/I*.ts",
    "components/**/*.tsx",
    "deeply/**/nested/**/folder/*.{tsx,ts,js}"
  ]
}