Skip to content

An opinionated collection of ESLint shared configs and rules used by rezStream

License

Notifications You must be signed in to change notification settings

rezstream/eslint-plugin-rezstream

Repository files navigation

eslint-plugin-rezstream

CI npm version

An opinionated collection of ESLint shared configs and rules used by rezStream projects.

Installation

npm install --save-dev @rezstream/eslint-plugin

Inside your .eslintrc.cjs file:

{
  extends: [
    "plugin:@rezstream/recommended",
  ],
  plugins: [
    "@rezstream",
  ],
}

Available configs

Name Description
@rezstream/recommended Base config for all projects
@rezstream/browser Config for browser based projects
@rezstream/typescript Config for TypeScript projects

Using with Typescript

When adding this plugin to a TypeScript project, you'll need to install the following packages:

npm install --save-dev eslint-import-resolver-typescript

You may also need to add some or all of the following settings to your .eslintrc.cjs file:

{
  parserOptions: {
    project: "./tsconfig.json",
  },
  settings: {
    "import/resolver": {
      typescript: {
        alwaysTryTypes: true,
        project: join(__dirname, "./tsconfig.json"),
      },
    },
  },
}

About

An opinionated collection of ESLint shared configs and rules used by rezStream

Resources

License

Stars

Watchers

Forks