ESLint Configurations for the DevExtreme Source Code

This repository collects ESLint configurations that enforce the code style used by the DevExtreme development team. These configurations are based on the Airbnb JavaScript Style Guide and cover most frequently encountered cases.

Note: Adding new configurations is possible but discouraged. Double-check that none of the existing configurations fits for your case before you add a new configuration.

Required packages

• eslint: 9.18.0
• @eslint/eslintrc: ^3.3.1
• @eslint-stylistic/metadata: ^4.4.1

List of Configurations

1. TypeScript
2. JavaScript
3. Spell Check
4. Jest Tests
5. QUnit Tests
6. TestCafe Tests
7. React
8. Angular
9. Vue

TypeScript

• Usage Add the following line to your eslint.config.mjs file:

  import { typescript } from 'eslint-config-devextreme';
  export default [
    ...typescript,
  ]

• Required packages

  • @typescript-eslint
  • airbnb-base
  • @stylistic/eslint-plugin
  • eslint-plugin-import

• Extended plugins and configurations

  • plugin:@typescript-eslint/recommended

JavaScript

• Usage Add the following line to your eslint.config.mjs file:

  import { javascript } from 'eslint-config-devextreme';
  export default [
    ...javascript,
  ]

• Required packages

  • airbnb-base

Spell Check

Lists words that the spell check should ignore.

• Usage Add the following line to your eslint.config.mjs file:

  import { spellCheck } from 'eslint-config-devextreme';
  export default [
    ...spellCheck,
  ]

• Required packages

  • spellcheck

Jest Tests

• Usage Add the following line to your eslint.config.mjs file:

  import { jest } from 'eslint-config-devextreme';
  export default [
      ...jest.map(config => ({
        ...config,
        settings: {
          jest: {
            version: 'your jest version'
          }
        }
      })),
  ]

• Required packages

  • jest
  • jest-formatting

• Extended plugins

  • jestPlugin.configs['flat/recommended']
  • jestFormatting.configs['flat/recommended']

QUnit Tests

• Usage Add the following line to your eslint.config.mjs file:

  import { qunit } from 'eslint-config-devextreme';
  export default [
    ...qunit,
  ]

• Required packages

  • qunit

• Extended plugins

  • eslintPluginQunitRecommended.plugins.qunit

TestCafe Tests

• Usage Add the following line to your eslint.config.mjs file:

  import { testcafe } from 'eslint-config-devextreme';
  export default [
    ...testcafe,
  ]

React

• Usage Add the following line to your eslint.config.mjs file:

  import { react } from 'eslint-config-devextreme';
  export default [
    ...react,
    settings: {
      react: {
        version: 'detect',
      },
    },
  ]

• Required packages

  • eslint-plugin-react
  • eslint-plugin-react-perf
  • airbnb-base
  • airbnb-typescript/base
  • @stylistic/eslint-plugin

Angular

• Usage Add the following line to your eslint.config.mjs file:

  import angular from 'eslint-config-devextreme';
  export default [
    ...angular,
  ]

• Required packages

  • eslint-plugin-no-only-tests

Vue

• Usage Add the following line to your eslint.config.mjs file:

  import vue from 'eslint-config-devextreme';
  export default [
    ...vue,
  ]

• Required packages

  • eslint-plugin-vue