eslint-plugin-aurora-rebrand

eslint-plugin-aurora-rebrand

Installation

You'll first need to install ESLint:

yarn add -D eslint

Next, install eslint-plugin-aurora-rebrand:

yarn add -D eslint-plugin-aurora-rebrand

Recommended dev dependencies for your project

    "@react-native/eslint-config": "^0.72.1",
    "@typescript-eslint/eslint-plugin": "^6.11.0",
    "@typescript-eslint/parser": "^6.11.0",
    "eslint": "^8.53.0",
    "eslint-config-prettier": "^9.0.0",
    "eslint-import-resolver-typescript": "^3.6.1",
    "eslint-plugin-ft-flow": "^3.0.1",
    "eslint-plugin-import": "^2.29.0",
    "eslint-plugin-jest": "^27.6.0",
    "eslint-plugin-prettier": "^5.0.1",
    "eslint-plugin-react": "^7.33.2",
    "eslint-plugin-react-hooks": "^4.6.0",
    "eslint-plugin-react-refresh": "^0.4.4",
    "prettier": "^3.1.0",

Usage

Add aurora-rebrand to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["aurora-rebrand"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "aurora-rebrand/deprecated-tokens": "error"
  }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.