The common eslint rules useful for any projects.
This project is a collection of rule and configs for any types of projects.
It includes:
eslint
configuration.prettier
rules.
- Install the package:
yarn add eslint-config-detemiro -D
- Add utility dependencies to your project (you can compare them with the
peerDependencies
of this repository):
yarn add eslint prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-config-prettier eslint-plugin-prettier eslint-plugin-simple-import-sort eslint-plugin-import eslint-config-airbnb-typescript -D
- Connect the
prettier
configuration to your project in.prettierrc.js
:
module.exports = require('eslint-config-detemiro/prettier')
or in json:
{
"extends": "eslint-config-detemiro/prettier"
}
- Configure your
.eslintrc.js
by example:
module.exports = {
extends: ['eslint-config-detemiro'],
parserOptions: {
project: './tsconfig.json',
tsconfigRootDir: __dirname,
ecmaVersion: 2020,
sourceType: 'module',
},
}
- You are incredible! Now you can use the
eslint
andprettier
in your project.
I welcome contributions! Follow these steps to contribute:
- Setup environment
- Fork the repository.
- Clone your forked repository.
- Install dependencies by running
yarn install
.
- Making Changes
- Create a new branch for your changes.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Submitting a Pull Request
- Go to the original repository on GitHub and click the "New pull request" button.
- Select your branch and submit the pull request.
- Wait for the review and address any feedback.
You are the star of this project! 🌟