https://github.com/welldone-software/eslint-plugin-welldone

Custom eslint rules helpful for our needs
https://github.com/welldone-software/eslint-plugin-welldone

Last synced: 12 months ago
JSON representation

Custom eslint rules helpful for our needs

• Host: GitHub
• URL: https://github.com/welldone-software/eslint-plugin-welldone
• Owner: welldone-software
• Created: 2019-10-10T15:06:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-24T19:38:12.000Z (about 4 years ago)
• Last Synced: 2025-04-06T12:46:09.883Z (about 1 year ago)
• Language: JavaScript
• Size: 136 KB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# @welldone-software/eslint-plugin

Prevent to use anything except import/export

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `@welldone-software/eslint-plugin`:

```

$ npm install @welldone-software/eslint-plugin --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@welldone-software/eslint-plugin` globally.

## Usage

Add `@welldone-software` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

  "plugins": ["@welldone-software"]

}

```

Then configure the rules you want to use under the rules section.

```json

{

  "rules": {

    "@welldone-software/modules-engagement": "error",

  }

}

```

## Plugins

### Rules of Modules Engagement

([`@welldone-software/modules-engagement`](./rules/modules-engagement))

This rule enforces Welldone's standard file structure.

[More details about the rule](https://welldone-software.gitbook.io/welldone-file-structure/modules/modules#rules-of-engagement)

can be found here.

### config:

These are the possible configs and their defaults for the rule:

```json5

{

  "rules": {

    "@welldone-software/modules-engagement": ["error", {

      // provide a glob to only lint certain paths. F.E:

      //   glob": "/packages/!(common-package)/**/!(*.stories|*.test).js"

      "glob": null, 

      

      // path of modules under package.json's

      "modulesPath": "/src",

      

      // Levels to enforce imports between modules

      "modulesLevels": {'common': 1, 'shared': 1, 'app': 3},

      

      // Default level for other modules

      "middleModulesLevel": 2,

      

      // Allow importing from inner paths in modules. F.E:

      // "moduleInnerPaths": ['/components']

      "moduleInnerPaths": [],

      

      // Array of modules that can be used not only from their root path

      "ignoreInnerPathsForModules": ['common', 'shared']

    }],

  }

}

```

## Supported Rules

- Fill in provided rules here