@webscopeio/eslint-config

eslint-config

ESLint config package according to Webscope guidelines.

The idea

Webscope's ESLint plugin is based on Prettier. The result set of rules is then further extended by Webscope's custom rules. You can find all the info you need in index.js.

How to use on a Webscope project

1. Install the package: npm install @webscopeio/eslint-config --save-dev
2. Use the config in your .eslintrc file:

extends: [
  '@webscopeio/eslint-config',
  ...
],

Configs do not ship dependencies. You'll have to install all the necessary dev dependencies on the level of your project. You can do it all at once by running this command:

npm install eslint-plugin-import eslint-plugin-jest eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks --save-dev

The dependencies are:

• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-jsx-a11y
• eslint-plugin-react
• eslint-plugin-react-hooks If the linter is failing with this type of error Definition for rule RULE_NAME was not found .., then your associated plugin does not contain RULE_NAME. To resolve this, try bumping the plugin version.

How to publish new version to NPM

For Webscope employees.

1. Create a PR with changes you want to publish.
2. Run npm whoami. The command should return your NPM name. If it does not then it is either because you are not logged in (in this case run npm login), or because you are not registered (create new NPM account by npm adduser or via NPM website).
3. Make sure that one of the code-owners (listed in .github/CODEOWNERS.md) added your NPM account to the Webscope organization.
4. Run npm version <update_type>. E.g. npm run minor. Reach out to the code-owners if you're not sure about the version update.
5. Finally, run npm publish.
6. :tada: If you are in Webscope organization & logged in, you just successfully published new version! :tada: