eslint config

@code-pushup/eslint-config

코드 푸시 업으로 권장되는 eslint 사전 설정.

구성

스택	구성	설명
	자바 스크립트	모든 JavaScript/TypeScript 프로젝트에 적합한 기본 구성.
	TypeScript	엄격한 TypeScript 프로젝트에 대한 구성.
	마디	node.js 프로젝트에 대한 구성.
	모난	각도 프로젝트 구성.
	ngrx	NGRX 라이브러리를 사용한 각도 프로젝트 구성.
	그래프 QL	node.js에서 구현 된 GraphQL 서버 에 대한 구성
	농담	테스트를 위해 농담을 사용하는 프로젝트 구성.
	최소한	테스트를 위해 Vitest를 사용하는 프로젝트에 대한 구성.
	사이프러스	테스트를 위해 Cypress를 사용하는 프로젝트 구성.
	스토리 북	UI 구성 요소에 스토리 북을 사용하는 프로젝트 구성.

일부 구성은 아래 그림과 같이 다른 구성을 확장합니다. 예를 들어, angular 구성을 확장하면 암시 적으로 typescript 및 javascript 구성이 확장됩니다.

 그래프 BT;
    JavaScript ( "JavaScript")
    TypeScript ( "typecript")
    노드 ( "노드")
    Angular ( "Angular")
    ngrx ( "ngrx")
    GraphQL ( "GraphQL")
    TypeScript -Extends-> javaScript
    노드 -extends-> javaScript
    angular -extends-> typeScript
    ngrx-extends-> angular
    GraphQL -extends-> 노드

설정

기본 구성을 사용하려면 다음 단계를 따르십시오.

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 configuration 파일에 기본 구성을 포함시킵니다 (일반적으로 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 패키지	버전	필수의
	eslint	^9.0.0	✅
	@eslint/js	^9.0.0	✅
	eslint-plugin- 기능	^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	✅
	글로벌	>=14.0.0	✅
	TypeScript-Elint	^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-Jest	^28.8.0
	eslint-plugin-jest- 형성	^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