@amaurym/eslintrc

Mostly common-sense configuration for eslintrc

Usage no npm install needed!

<script type="module">
  import amaurymEslintrc from 'https://cdn.skypack.dev/@amaurym/eslintrc';
</script>

README

npm License code style: prettier dependencies Status Buy me a tree

@amaurym/eslintrc

💯 Mostly common-sense configuration files for eslint.

🚀 Get Started

Install the package

yarn add --dev @amaurym/eslintrc

In your project's root folder:

echo "module.exports = require('@amaurym/eslintrc');" > .eslintrc.js
echo "module.exports = require('@amaurym/eslintrc/prettierrc');" > .prettierrc.js

And now you should be able to lint your project.

📖 Included Rules

The set of rules I use is the following:

  • @typescript-eslint/recommended: Recommended rules by the typescript-eslint team. See all rules.
  • prettier: Opiniated code formatter. See their homepage for more info https://prettier.io/.
  • react/recommended: Recommended rules for React, harmless if you don't use React.

I believe that Prettier is not enough, because it's only a code formatter, and doesn't check for code quality rules. This is the reason I chose to add @typescript-eslint/recommended on top of Prettier.