eslint-plugin-chalk

ESLint plugin that always reports with configurable message

The project is based on eslint-plugin-always but not output with warn or error, it makes the plugin won't interrupt the check process.

Why?

It sounds a bit strange to have a ESLint rule that always reports. The reason why this plugin was created is a special use case:

The root ESLint configuration in the project fits for the build scripts but not for the rest of the project. There is a subfolder that resets the ESLint configuration:

{
  "root": true
}

So all files in this folder structure won't check any ESLint rules. The subfolders must contain ESLint configurations which can differ between each subfolder.

For the case that someone adds a subfolder and forgets the ESLint configuration this rule was created. So every file within the subfolder will report an error

No ESLint configuration present.

Installation

$ npm i -D eslint-plugin-chalk

Usage

Add the plugin to your ESLint configuration:

{
  "plugins": [
    "chalk"
  ]
}

And then add the following rule:

{
  "rules": {
    "chalk/chalk": ["error", {
      "hexColor": "#00f",
      "icon": "💡",
      "message": "Hello World"
    }]
  }
}

License

MIT © 2022 Jens Simon & XQ Kuang