Install

npm i --save-dev \
   eslint-config-qwarry \
   eslint \
   eslint-config-airbnb \
   eslint-config-airbnb-base \
   eslint-config-prettier \
   eslint-config-react-app \
   eslint-plugin-import \
   eslint-plugin-jest \
   eslint-plugin-jsonc \
   eslint-plugin-jsx-a11y \
   eslint-plugin-lodash \
   eslint-plugin-node \
   eslint-plugin-prettier \
   eslint-plugin-promise \
   eslint-plugin-react \
   eslint-plugin-react-hooks

Create a file named .eslintrc.js:

module.exports = {
  root: true,
  extends: ['qwarry', 'qwarry/react'], // or 'qwarry/node'
};

Adapt your package.json, this is the only way to pass options to your local prettier:

{
  ...yourpackagejsondata,
  "prettier": {
    "printWidth": 100,
    "singleQuote": true
  }
}

Contribute

Thank you for your interest in contributing to eslint-config-qwarry! Here's how you can adapt rules based on your needs:

1. Clone the eslint-config-qwarry repository to your local machine by running git clone [email protected]:Qwarry/eslint-qwarry.git in your terminal.
2. Make sure you have commitlint installed by running npm i in your terminal.
3. Push a commit with a commit message that follows the Semantic Versioning specifications.
   • This will trigger commitlint to check your commit message and ensure it follows the correct format.
   • If your commit message doesn't follow the correct format, commitlint will give you an error and ask you to correct it before you can proceed.
4. A tag will be automatically created and pushed to the npm repository based on your commit message.
5. Update the package.json file of your project with the new tag:
   • "eslint-config-qwarry": "X.Y.Z" where X.Y.Z is the version number you just pushed.
   • Alternatively, you can remove "eslint-config-qwarry" from your package.json file and run npm i --save-dev eslint-config-qwarry to install the latest version.