@brandsinsurance/eslint-plugin v3.0.0

= @brandsinsurance/eslint-plugin

Plugin for custom ESLint rules for BrandsInsurance

== Installation

You'll first need to install link:https://eslint.org/[ESLint]:

source, shell

npm i eslint --save-dev

Next, install @brandsinsurance/eslint-plugin:

source, shell

npm install @brandsinsurance/eslint-plugin --save-dev

== Usage

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

source, javascript

{ plugins: '@brandsinsurance'

}

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

source,javascript

module.exports = { rules: { '@brandsinsurance/spaces-in-ifs': 'error', },

};

Or, you can extend either built-in config.

source,javascript

module.exports = { plugins: '@brandsinsurance', extends: 'plugin:@brandsinsurance/all-js-only', };

module.exports = { plugins: '@brandsinsurance', '@typescript-eslint', extends: 'plugin:@brandsinsurance/all',

};

== Rules

• xref:./docs/rules/array-reduce-second-arg/README.adocarray-reduce-second-arg
• xref:./docs/rules/no-spaces-in-catches/README.adocno-spaces-in-catches
• xref:./docs/rules/spaces-in-dowhiles/README.adocspaces-in-dowhiles
• xref:./docs/rules/spaces-in-fors/README.adocspaces-in-fors
• xref:./docs/rules/spaces-in-ifs/README.adocspaces-in-ifs
• xref:./docs/rules/spaces-in-switches/README.adocspaces-in-switches
• xref:./docs/rules/spaces-in-whiles/README.adocspaces-in-whiles

== Configs

• :xref:./src/configs/all.tsall ** All eslint rules we've discussed, including those linting TypeScript
• :xref:./src/configs/all_js_only.tsall-js-only ** All javascript eslint rules we've discussed

== Contributing

See xref:./CONTRIBUTING.adocCONTRIBUTING for how to add your own rule

== Changelog

See xref:./CHANGELOG.adocCHANGELOG see see changes