Skip to content

CRA based including custom prettier config ready to be used in satellite studio projects

License

Notifications You must be signed in to change notification settings

satellitestudio/eslint-config

Repository files navigation

@satellitestudio/eslint-config

npm version GitHub license

Eslint config based on eslint-config-react-app with some custom rules and prettier integration

Installation

npx install-peerdeps --dev @satellitestudio/eslint-config

# or
yarn add @satellitestudio/eslint-config -D --peer

Usage

Eslint

Now add the config to either your package.json:

JS

{
  "eslintConfig": {
    "extends": "@satellitestudio/eslint-config"
  }
}

to your .eslintrc:

{
  "extends": "@satellitestudio/eslint-config"
}

Typescript

{
  "eslintConfig": {
    "extends": "@satellitestudio/eslint-config/typescript"
  }
}

to your .eslintrc:

{
  "extends": "@satellitestudio/eslint-config/typescript"
}

Prettier

to your .prettierrc.js:

module.exports = require('@satellitestudio/eslint-config/prettier.config')

Recommendations

VS Code

Install the ESLint and Prettier VSCode extensions:

ext install esbenp.prettier-vscode dbaeumer.vscode-eslint

Copy this to settings.json

  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": false, // avoids running the format twice,
  "eslint.autoFixOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },

LICENCE

MIT

About

CRA based including custom prettier config ready to be used in satellite studio projects

Resources

License

Stars

Watchers

Forks

Packages