https://github.com/itwillwork/eslint-plugin-exports-control

https://github.com/itwillwork/eslint-plugin-exports-control

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/itwillwork/eslint-plugin-exports-control
• Owner: itwillwork
• Created: 2023-04-26T17:08:31.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-04-26T17:27:33.000Z (over 1 year ago)
• Last Synced: 2024-10-05T09:47:28.869Z (about 1 month ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-plugin-exports-control

Eslint plugin for linting exports

## Installation

```

npm i --save-dev eslint-plugin-exports-control

```

## Usage

Create an .eslint.json file with the following:

```json

"plugins": [

    "exports-control"

]

```

Then, you can add the custom rules to the .eslint.json file:

```json

"rules": {

  "exports-control/exports-control": "error",

}

```

To lint your project with ESLint, add the following script to your package.json:

```json

{

  "scripts": {

    "lint": "eslint ."

  }

}

```

and run the linter with:

```

npm run lint

```

## Rules

#### exports-control/exports-control

Config example:

```js

"exports-control/exports-control": ['error', [{

    paths: {

      includes: ['endpoints/*'],

      excludes: ['endpoints/models/*'],

    },

    patterns: ['EndpointT$'],

    description: 'There is only endpoints models, with names end of ...EndpointT',

  }]],

```

Examples of incorrect code for this rule:

```js

// in file "endpoints/user.ts"

export const CurrentUserT = ...

// or

export { CurrentUserT }

```

Examples of correct code for this rule:

```js

// in file "endpoints/user.ts"

export const CurrentUserEndpointT = ...

// or

export { CurrentUserEndpointT }

// in file  "endpoints/models/roles.ts"

export enum RolesEnum { ... }

// or

export { RolesEnum }

```