ESLint Configuration

This package provides a shared ESLint configuration for the project. It includes rules and settings to ensure consistent code quality and style across all JavaScript files.

Installation

For install eslint config run command:

npm install --save-dev @imagespark/eslint-config

Usage

To use this ESLint configuration in your project, add it as a dev dependency and extend it in your eslint.config.js file:

import { jsConfig }  from "@imagespark/eslint-config";

export default [jsConfig()];

Configs

Configs are functions that return ESLint configuration objects.

• jsConfig - config for js, mjs and cjs files

• tsConfig - config for ts, mts and cts files

• vueConifg - config for Vue.js files. vueConfig contain configs for other versions of framework. Available variants for Vue.js: vue2/js, vue2/ts,vue3/js, vue3/ts.

• vueCustomConifg - config for vue with its own rules. You can use rules from eslint-plugin-vue, stylistic rules and TypeScript rules for ts language

  import { jsConifg, vueConfig } from "@imagespark/eslint-config";
  
  // for Vue2 without typescript
  export default [jsConifg(), vueConfig('vue2/js')];

  // vueCustomConfig usage
  import { jsConifg, vueConfig, vueCustomConfig } from "@imagespark/eslint-config";
  
  // for Vue2 with typescript
  export default [
      jsConifg(),
      vueConfig('vue2/ts'),
      vueCustomConfig('ts', {
          'vue/no-undef-components': ['error', {
              'ignorePatterns': ['AwesomGlobalComponent']
          }],
          '@typescript-eslint/array-type': 'off',
      })
  ];

  // custom rules for js and ts
  import { jsConifg, tsConfig } from "@imagespark/eslint-config";
  
  // for Vue2 with typescript
  export default [
      jsConifg({
          'no-undef': 'off',
          '@stylistic/indent': 'off',
      }),
      tsConfig({
          '@typescript-eslint/array-type': 'off',
      })
  ];

Migration in existing project

You can pass a list of rules whose severity should be set to 'warning'.

usage

import { jsConfig, vueConfig }  from "@imagespark/eslint-config";

export default [
    jsConfig({}, ['no-unused-vars']),
    vueConfig('vue2/js', ['no-console'])
];

Use the 'all' keyword to set the severity for all rules to 'warning'.

usage

import { jsConfig, vueConfig }  from "@imagespark/eslint-config";

export default [
    jsConfig({}, 'all'),
    vueConfig('vue2/js', 'all')
];

License

This package is licensed under the MIT License.