eslint-config-szum-tech

Github

Github Actions

NPM

These are settings for ESLint working as shareable config.

What it does 🤔

This setup lints your JavaScript code based on practices. It supports React projects with typescript and uses plugins like:

Check the index.js file to see what is included. Feel free to override the rules that make sense for you.

Installing ⚙️

In your project folder, run:

npm i -D @szum-tech/eslint-config-szum-tech 
# or yarn install --dev @szum-tech/eslint-config-szum-tech

npx install-peerdeps --dev @szum-tech/eslint-config-szum-tech

Usage

Once the @szum-tech/eslint-config-szum-tech package is installed, you can use it by specifying @szum-tech/eslint-config-szum-tech in the extends section of your ESLint configuration.

Set configuration

Use one of following way:

1. Create (or update) a .eslintrc.yml file with the following content:

extends:
  - "@szum-tech/eslint-config-szum-tech"

2. Or add to package.json file the following content:

{
  "eslintConfig": {
    "extends": [
      "@szum-tech/eslint-config-szum-tech"
    ]
  }
}

---

Add scripts to package.json

{
  "scripts": {
    "lint": "eslint {**/*,*}.{js,ts,jsx,tsx}",
    "lint:fix": "eslint --fix {**/*,*}.{js,ts,jsx,tsx}"
  }
}

License

MIT © Szum-Tech