1. Install this package: npm install --save-dev @erento/eslint-plugin-erento-rules and any of missing peer dependencies, if any.
2. Add "@erento/erento-rules" into plugins in .eslintrc file.
3. Use any of rules directly in rules or use our opinionated set of rules:

   {
       "extends": [
           "plugin:@erento/erento-rules/recommended"
       ],
       "plugins": [
           "@erento/erento-rules"
       ]
   }

Each rule has emojis denoting:

• ✅ if it belongs to the recommended configuration
• 🔧 if some problems reported by the rule are automatically fixable by the --fix command line option
• 💡 if some problems reported by the rule are manually fixable by editor suggestions

To run tests:

npm run test

In case you can use published version, use dexcription in Usage section above. To check existing sources against development version, please, follow next steps:

1. In the folder of this repository run:

   npm run build
   npm pack

2. In the folder of your project's repository run:

   npm install <ESLINT_RULES_ROOT>/erento-eslint-plugin-erento-rules-X.Y.Z.tgz

Where:

• <RULES_ROOT> is e.g. /Users/konradcerny/Sites/Erento/eslint-rules
• X.Y.Z is current version in package.json - we follow SEMVER versioning.

Assuming you have installed all peer dependencies and defined .eslintrc file, you can now run: ./node_modules/.bin/eslint -c .eslintrc.json ./src/**/*.ts

You can run it also with the --fix argument to execute a fixer.