@distributive/eslint-plugin

An ESLint rule to enforce brace styles according to the Distributive style guide.

Table of Contents

• Install
• Usage
• Rules
• Contributing
• License

Install

npm add --save-dev eslint @distributive/eslint-plugin

Usage

You can extend from the plugin's recommended configuration:

module.exports = {
  extends: [
    'plugin:@distributive/recommended',
  ],
};

Or, add @distributive to the plugins section of your .eslintrc configuration file and configure the rules you want to use under the rules section:

module.exports = {
  plugins: [
    '@distributive',
  ],
  rules: {
    '@distributive/brace-style': 'error',
  },
};

Rules

💼 Configurations enabled in.
✅ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.

| Name        | Description | 💼 | 🔧 | | :--------------------------------------- | :------------------------------------------------------------------- | :- | :- | | brace-style | Enforce bracing styles in accordance to the Distributive style guide | ✅ | 🔧 |

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2023 Distributive Corp.