Skip to content

foxglove/eslint-plugin

Repository files navigation

@foxglove/eslint-plugin

npm package

Foxglove default eslint configuration & rules.

Rules

See rules/README.md for details on each rule.

Installation

yarn add -D \
    @foxglove/eslint-plugin \
    typescript-eslint \
    eslint \
    prettier

In your eslint.config.cjs:

const foxglove = require("@foxglove/eslint-plugin");
const tseslint = require("typescript-eslint");

module.exports = tseslint.config(
  ...foxglove.configs.base,
  ...foxglove.configs.react,
  ...foxglove.configs.jest,
  ...foxglove.configs.typescript
);

License

@foxglove/eslint-plugin is released under the MIT License.

Releasing

Note: You must use npm 7+ (not yarn) to test this repo locally, due to the self link in package.json.

tag=$(npm version minor) && echo "$tag"
git push && git push origin "$tag"

Stay in touch

Join our Slack channel to ask questions, share feedback, and stay up to date on what our team is working on.