🤏
Codely's ESLint + Prettier configuration
Opinionated linting configuration considering modern TypeScript best practices and providing consistency to your import
statements. Valid for your JavaScript or TypeScript projects
Take a look, play and have fun with this. Stars are welcome
👀
How to use
- Install the dependency
npm install --save-dev eslint-config-codely
- Add it to your
.eslintrc.js
file:{ extends: [ "eslint-config-codely" ] }
- If you are using TypeScript, extend the TypeScript configuration instead, and point to your
tsconfig.json
inparserOptions
:{ extends: [ "eslint-config-codely/typescript" ], parserOptions: { project: ["./tsconfig.json"], }, }
strict: true
in your tsconfig.json
.
🤔
What it does
- Lints JavaScript using
eslint:recommended
and Prettier - Additionally, lints TypeScript using
@typescript-eslint/recommended
and@typescript-eslint/recommended-requiring-type-checking
- Uses the following plugins:
import
: helps validate proper importssimple-import-sort
: sorts importsunused-imports
: finds and removes unused ES6 module imports
- Uses the following JavaScript rules and TypeScript rules
👌
Codely Code Quality Standards
Publishing this package we are committing ourselves to the following code quality standards:
-
🤝 Respect Semantic Versioning: No breaking changes in patch or minor versions -
🤏 No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose -
🎯 One specific purpose to meet without having to carry a bunch of unnecessary other utilities -
✅ Tests as documentation and usage examples -
📖 Well documented ReadMe showing how to install and use -
⚖️ License favoring Open Source and collaboration