eslint config

@ code-pushup / eslint-config

Préréglages Eslint recommandés par Puspup de code.

Configuration

Empiler	Configurer	Description
	javascrip	Configuration par défaut, adaptée à tout projet JavaScript / TypeScript .
	manuscrit	Config pour des projets de type dactylographiques stricts.
	nœud	Config pour les projets Node.js.
	angulaire	Config pour les projets angulaires .
	ngrX	Config pour les projets angulaires à l'aide de la bibliothèque NGRX .
	graphique	Config pour les serveurs GraphQL implémentés dans Node.js.
	plaisanter	Config pour les projets utilisant une plaisanterie pour les tests.
	le plus vide	Config pour des projets utilisant Virest pour les tests.
	cyprès	Config pour des projets utilisant Cypress pour les tests.
	livre de contes	Config pour des projets utilisant un livre de contes pour les composants de l'interface utilisateur.

Certaines configurations étendent d'autres configurations, comme illustré ci-dessous. Ainsi, par exemple, l'extension de la configuration angular étend implicitement implicitement les configurations typescript et javascript .

 graphique bt;
    javascript ("javascript")
    TypeScript ("TypeScript")
    nœud ("nœud")
    angulaire ("angulaire")
    ngrx ("ngrx")
    GraphQL ("GraphQL")
    TypeScript - ExtendS -> JavaScript
    node --extends -> javascript
    Angular - ExtendS -> TypeScript
    ngrx --extends -> Angular
    GraphQL - EXTENDS -> NODE

Installation

Pour utiliser la configuration par défaut, suivez ces étapes:

1. Vous devez d'abord installer toutes les dépendances de pairs requises (si vous ne l'avez pas déjà fait):

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

2. Installer @code-pushup/eslint-config avec:

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

3. Inclure la configuration par défaut dans votre fichier de configuration Eslint (généralement eslint.config.js ):

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

Selon votre pile technologique, vous souhaiterez peut-être également prolonger d'autres configurations (énumérées ci-dessus). Cela nécessitera l'installation de dépendances supplémentaires des pairs. Pour plus de détails, reportez-vous à la configuration des documents pour les configurations que vous souhaitez utiliser.

? Dépendances des pairs

Toutes les dépendances par les pairs utilisées par @code-pushup/eslint-config sont répertoriées ci-dessous, ainsi que leurs versions prises en charge. Seules les dépendances de la configuration par défaut sont requises, d'autres sont facultatives.

	Package NPM	Version	Requis
	eslint	^9.0.0	✅
	@ eslint / js	^9.0.0	✅
	eslint-plugin fonctionnel	^7.0.0	✅
	Eslint-Plugin-Import	^2.31.0	✅
	Eslint-Import-Resolver-Typescript	^3.0.0
	Eslint-Plugin-Promise	>=6.4.0	✅
	Eslint-Plugin-sonarjs	^1.0.4	✅
	Eslint-Plugin-Unicorn	>=50.0.0	✅
	global	>=14.0.0	✅
	dyscript-eslint	^8.0.0	✅
	@ graphql-eslint / Eslint-Plugin	^3.0.0
	@ ngrx / Eslint-Plugin	^18.0.0
	aslint angulaire	^18.0.0
	Eslint-Plugin-Cypress	>=3.3.0
	Eslint-Plugin-Jest	^28.8.0
	Eslint-Plugin-Jest-formatting	^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

? Test Overrides

Pour le code de non-production, certaines règles sont désactivées (ou rétrogradées des erreurs aux avertissements).

Cela s'applique aux chemins de fichier correspondant à l'un des globs suivants:

• **/*.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

? Contributif

L'installation de Node.js est une condition préalable (version LTS). Installez les dépendances avec NPM:

npm install

Pour exécuter des tests:

npm test

Pour générer une documentation:

npm run docs