eslint config

@Code-Pushup/Eslint-Config

Predefinições de ESLint recomendadas por flexão de código.

Configurações

Pilha	Config	Descrição
	JavaScript	Config padrão, adequado para qualquer projeto JavaScript/TypeScript .
	TypeScript	Configurar para projetos rigorosos de texto datilografado .
	nó	Config para projetos Node.js.
	angular	Config para projetos angulares .
	NGRX	Config para projetos angulares usando a biblioteca NGRX .
	GraphQL	Config para servidores grafql implementados em node.js.
	Jove	Configuração para projetos usando o JEST para teste.
	Vitest	Config para projetos usando o Vitest para teste.
	cipreste	Configuração para projetos usando o CYPRESS para teste.
	Livro de histórias	Config para projetos usando o Storybook para componentes da interface do usuário.

Algumas configurações estendem outras configurações, como ilustrado abaixo. Assim, por exemplo, estender a configuração angular estende implicitamente as configurações typescript e javascript também.

 Gráfico BT;
    JavaScript ("JavaScript")
    TypeScript ("TypeScript")
    nó ("nó")
    Angular ("Angular")
    NGRX ("NGRX")
    GraphQL ("grafql")
    TypeScript-Extremcends-> JavaScript
    Node-Excendentes-> JavaScript
    Angular-extensões-> TypeScript
    NGRX-Extensões-> Angular
    grafql --extends-> nó

Configurar

Para usar a configuração padrão, siga estas etapas:

1. Você deve primeiro instalar todas as dependências de pares necessárias (se ainda não o fizeram):

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

2. Instale @code-pushup/eslint-config com:

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

3. Inclua configuração padrão no seu arquivo de configuração ESLint (geralmente eslint.config.js ):

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

Dependendo da sua pilha de tecnologia, você também pode estender outras configurações (listadas acima). Isso exigirá a instalação de dependências adicionais de pares. Para obter mais detalhes, consulte os documentos de configuração para as configurações que você está interessado em usar.

? Dependências de pares

Todas as dependências de pares usadas por @code-pushup/eslint-config estão listadas abaixo, juntamente com suas versões suportadas. Somente as dependências da configuração padrão são necessárias, outras são opcionais.

	Pacote npm	Versão	Obrigatório
	Eslint	^9.0.0	✅
	@eslint/js	^9.0.0	✅
	Eslint-plugin-funcional	^7.0.0	✅
	Eslint-Plugin-Import	^2.31.0	✅
	Eslint-Import-Resolver-typeScript	^3.0.0
	Eslint-Plugin-promese	>=6.4.0	✅
	Eslint-Plugin-Sonarjs	^1.0.4	✅
	Eslint-Plugin-Unicorn	>=50.0.0	✅
	Globals	>=14.0.0	✅
	TypeScript-eslint	^8.0.0	✅
	@graphql-eslint/eslint-plugin	^3.0.0
	@nGrx/eslint-plugin	^18.0.0
	Angular-eslint	^18.0.0
	Eslint-Plugin-Cypress	>=3.3.0
	Eslint-Plugin-jest	^28.8.0
	Eslint-plugin-jest-formating	^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

? Substituições de teste

Para código de não produção, algumas regras são desativadas (ou rebaixadas de erros para avisos).

Isso se aplica aos caminhos de arquivo que correspondem a qualquer um dos seguintes globs:

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

? Contribuindo

A instalação do Node.js é um pré -requisito (versão LTS). Instale dependências com NPM:

npm install

Para executar testes:

npm test

Para gerar documentação:

npm run docs