eslint config

@code-pushup/eslint-config

Рекомендуемые предварительные предварительные устройства Eslint с помощью отжимания кода.

Конфигурации

Куча	Конфигурация	Описание
	JavaScript	Конфигурация по умолчанию, подходящая для любого проекта JavaScript/TypeScript .
	машинопись	Конфигурация для строгих проектов TypeScript .
	узел	Конфигурация для проектов node.js.
	угловой	Конфигурация для угловых проектов.
	ngrx	Конфигурация для угловых проектов с использованием библиотеки NGRX .
	graphql	Конфигурация для серверов GraphQL , реализованных в node.js.
	шутка	Конфигурация для проектов с использованием Jest для тестирования.
	Виды	Конфигурация для проектов с использованием визита для тестирования.
	кипарис	Конфигурация для проектов с использованием Cypress для тестирования.
	сборник рассказов	Конфигурация для проектов с использованием сборника рассказов для компонентов пользовательского интерфейса.

Некоторые конфигурации расширяют другие конфигурации, как показано ниже. Так, например, расширение angular конфигурации неявно расширяет конфигурации typescript и javascript .

 График Bt;
    JavaScript ("JavaScript")
    TypeScript ("TypeScript")
    Узел ("Узел")
    Угловая («угловая»)
    ngrx ("ngrx")
    graphql ("graphql")
    TypeScript-Extends-> JavaScript
    Узел-Extends-> JavaScript
    Angular-Extends-> TypeScript
    ngrx-extends-> Angular
    graphql-extends-> node

Настраивать

Чтобы использовать конфигурацию по умолчанию, выполните следующие действия:

1. Сначала вы должны установить все необходимые зависимости от одноранговых сверстников (если вы еще этого не сделали):

   npm install -D eslint @eslint/js eslint-plugin-{functional,import,promise,sonarjs,unicorn} globals typescript-eslint

2. Установить @code-pushup/eslint-config с:

   npm install -D @code-pushup/eslint-config

3. Включите конфигурацию по умолчанию в свой файл конфигурации Eslint (обычно eslint.config.js ):

    import javascript from '@code-pushup/eslint-config/javascript.js' ;
   import tseslint from 'typescript-eslint' ;
   
   export default tseslint . config ( ... javascript ) ;

В зависимости от вашего технического стека, вы можете также расширить другие конфигурации (перечисленные выше). Это потребует установки дополнительных зависимостей со сверстниками. Для получения более подробной информации обратитесь к настройке документов для конфигураций, которые вы заинтересованы в использовании.

? Зависимости от сверстников

Все зависимости от сверстников, используемые @code-pushup/eslint-config перечислены ниже, а также их поддерживаемые версии. Требуются только зависимости конфигурации по умолчанию, другие необязательны.

	Пакет NPM	Версия	Необходимый
	Эслинт	^9.0.0	✅
	@eslint/js	^9.0.0	✅
	Eslint-Plugin-функциональный	^7.0.0	✅
	Eslint-Plugin-Import	^2.31.0	✅
	Eslint-Import-Resolver-тип	^3.0.0
	Eslint-Plugin-Promise	>=6.4.0	✅
	Eslint-Plugin-Sonarjs	^1.0.4	✅
	Eslint-Plugin-Unicorn	>=50.0.0	✅
	глобальные вещества	>=14.0.0	✅
	TypeScript-Eslint	^8.0.0	✅
	@graphql-eslint/eslint-plugin	^3.0.0
	@ngrx/eslint-plugin	^18.0.0
	Угловой эзалин	^18.0.0
	Eslint-Plugin-Cypress	>=3.3.0
	Eslint-Plugin-Dest	^28.8.0
	Eslint-Plugin--кормить	^3.0.0
	Eslint-Plugin-N	>=17.0.0
	Eslint-Plugin-rxjs-x	>=0.6.0
	Eslint-Plugin Storybook	>=0.10.0
	Eslint-Plugin-Vitest	>=0.5.0

? Переопределение теста

Для непроизводственного кода некоторые правила отключены (или понижаются от ошибок до предупреждений).

Это относится к путям файлов, соответствующим любому из следующих глобусов:

• **/*.spec.?(c|m)[jt]s?(x)
• **/*.test.?(c|m)[jt]s?(x)
• **/__tests__/**/*.?(c|m)[jt]s?(x)
• **/__mocks__/**/*.?(c|m)[jt]s?(x)
• **/*.cy.?(c|m)[jt]s?(x)
• **/*.stories.?(c|m)[jt]s?(x)
• **/*.e2e.?(c|m)[jt]s?(x)
• **/*.mock.?(c|m)[jt]s?(x)
• **/*.mocks.?(c|m)[jt]s?(x)
• **/test/**/*.?(c|m)[jt]s?(x)
• **/tests/**/*.?(c|m)[jt]s?(x)
• **/mocks/**/*.?(c|m)[jt]s?(x)
• **/testing-utils/**/*.?(c|m)[jt]s?(x)
• **/test-utils/**/*.?(c|m)[jt]s?(x)
• **/fixtures/**/*.?(c|m)[jt]s?(x)
• **/*.config.?(c|m)[jt]s
• **/.prettierrc.?(c|m)[jt]s
• **/codegen.?(c|m)[jt]s
• **/test-setup.?(c|m)[jt]s

? Внося

Установка node.js является обязательным условием (версия LTS). Установите зависимости с NPM:

npm install

Для выполнения тестов:

npm test

Для генерации документации:

npm run docs