@finos/eslint-plugin-legend-studio

@finos/eslint-plugin-legend-studio

This plugin includes 3 configs:

• recommended: This config turns on rules in recommended configs for ESLint, eslint-plugin-import, React, Prettier, and Typescript. These rules are light-weighted, and suitable to run on incremental build during development.
• computationally-expensive: This config turns on computationally expensive rules. For example: Typescript type-ware checks, import rules that require checking multiple files, indentation rules, etc. These rules are not suitable to run on incremental build as they seriously increase effective rebuild time.
• scripts-override: This config turns off certain rules which are not suitable for script files or Javascript files (i.e. Typescript-specific rules). As such, this config if used in tandem with other configs, should go last.

Following is an example of usage:

module.exports = {
  root: true, // tell ESLint to stop looking further up in directory tree to resolve for parent configs
  parserOptions: {
    // `parserOptions.project` is required for generating parser service to run specific Typescript rules
    project: ['packages/*/tsconfig.json'],
  },
  plugins: ['@finos/legend-application-studio'],
  extends: [
    'plugin:@finos/legend-application-studio/recommended',
    'plugin:@finos/legend-application-studio/computationally-expensive',
    'plugin:@finos/legend-application-studio/scripts-override',
  ].filter(Boolean),
};

Note that for the imports, we can use either @finos/legend-application-studio/ or @finos/eslint-plugin-legend-studio/ as prefix and the rules, configs, and plugin will be picked up by ESLint just fine.