openstapps/README.md

@openstapps/eslint-config

Installation

Put this into your .eslintrc

{
  "extends": "@openstapps"
}

Unfortunately, ESLint requires you to define plugins and configs your config depends on as peerDependencies, which means they have to be installed manually.

Use the command

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

Or, alternatively, add the following to your package.json:

{
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": ">=5.15.0",
    "@typescript-eslint/parser": ">=5.15.0",
    "eslint": ">=8.11.0",
    "eslint-config-prettier": ">=8.5.0",
    "eslint-plugin-jsdoc": ">=38.0.6",
    "eslint-plugin-prettier": ">=4.0.0",
    "eslint-plugin-unicorn": ">=41.0.1",
    "prettier": ">=2.6.0"
  }
}