ESLINT ที่แนะนำไว้ล่วงหน้าด้วยรหัส pushup
| กองซ้อน | การกำหนดค่า | คำอธิบาย |
|---|---|---|
![]() | จาวาสคริปต์ | ค่าเริ่มต้นการกำหนดค่าเหมาะสำหรับโครงการ JavaScript/typeScript ใด ๆ |
![]() | ตัวพิมพ์ใหญ่ | กำหนดค่าสำหรับโครงการ พิมพ์ที่ เข้มงวด |
![]() | โหนด | กำหนดค่าสำหรับโครงการ node.js |
![]() | เชิงมุม | กำหนดค่าสำหรับโครงการ เชิงมุม |
![]() | NGRX | กำหนดค่าสำหรับโครงการ เชิงมุม โดยใช้ไลบรารี NGRX |
![]() | graphql | กำหนดค่าสำหรับ เซิร์ฟเวอร์ graphql ที่ใช้ใน node.js. |
![]() | ล้อเล่น | กำหนดค่าสำหรับโครงการที่ใช้ JEST สำหรับการทดสอบ |
![]() | การพูดด้วยน้ำ | กำหนดค่าสำหรับโครงการที่ใช้ Vitest สำหรับการทดสอบ |
![]() | ไซเปรส | กำหนดค่าสำหรับโครงการที่ใช้ Cypress สำหรับการทดสอบ |
![]() | หนังสือนิทาน | กำหนดค่าสำหรับโครงการที่ใช้ นิทาน สำหรับส่วนประกอบ UI |
การกำหนดค่าบางอย่างขยายการกำหนดค่าอื่น ๆ ดังที่แสดงด้านล่าง ตัวอย่างเช่นการขยายการกำหนดค่า angular ขยายการกำหนด typescript และ javascript โดยปริยายเช่นกัน
กราฟ bt;
JavaScript ("JavaScript")
typeScript ("typeScript")
โหนด ("โหนด")
Angular ("Angular")
ngrx ("ngrx")
graphql ("graphql")
TypeScript-Extends-> JavaScript
Node-Extends-> JavaScript
Angular-Extends-> typescript
ngrx-extends-> angular
graphql-extends-> โหนด
หากต้องการใช้การกำหนดค่าเริ่มต้นให้ทำตามขั้นตอนเหล่านี้:
คุณต้องติดตั้งการพึ่งพาเพียร์ที่จำเป็นทั้งหมดก่อน (ถ้าคุณยังไม่ได้):
npm install -D eslint @eslint/js eslint-plugin-{functional,import,promise,sonarjs,unicorn} globals typescript-eslint ติดตั้ง @code-pushup/eslint-config พร้อม:
npm install -D @code-pushup/eslint-config รวมการกำหนดค่าเริ่มต้นในไฟล์การกำหนดค่า 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 | รุ่น | ที่จำเป็น | |
|---|---|---|---|
![]() | eslint | ^9.0.0 | |
![]() | @eslint/js | ^9.0.0 | |
![]() | Eslint-plugin-functional | ^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-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-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 |
สำหรับรหัสที่ไม่ใช่การผลิตกฎบางอย่างจะถูกปิดใช้งาน (หรือปรับลดจากข้อผิดพลาดเป็นคำเตือน)
สิ่งนี้ใช้กับพา ธ ไฟล์ที่ตรงกับสิ่งใด ๆ ต่อไปนี้:
**/*.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