eslint config

@Code-Pushup/Eslint-Config

Preset ESLINT yang direkomendasikan oleh kode pushup.

Konfigurasi

Tumpukan	Konfigurasi	Keterangan
	Javascript	Konfigurasi default, cocok untuk proyek JavaScript/TypeScript .
	naskah	Konfigurasi untuk proyek naskah yang ketat.
	node	Konfigurasi untuk proyek Node.js.
	Angular	Konfigurasi untuk proyek sudut .
	Ngrx	Konfigurasi untuk proyek sudut menggunakan perpustakaan NGRX .
	graphql	Konfigurasi untuk server GraphQL diimplementasikan di Node.js.
	bersenda gurau	Konfigurasi untuk proyek menggunakan JEST untuk pengujian.
	vitest	Konfigurasi untuk proyek menggunakan Vitest untuk pengujian.
	Cypress	Konfigurasi untuk proyek menggunakan Cypress untuk pengujian.
	buku cerita	Config for Projects Menggunakan Storybook untuk Komponen UI.

Beberapa konfigurasi memperluas konfigurasi lain, seperti yang diilustrasikan di bawah ini. Jadi, misalnya, memperluas konfigurasi angular secara implisit memperluas typescript dan javascript juga.

 grafik bt;
    Javascript ("JavaScript")
    TypeScript ("TypeScript")
    node ("node")
    Angular ("Angular")
    NGRX ("NGRX")
    graphql ("graphql")
    TypeScript --Extends-> JavaScript
    node --extends-> javascript
    Angular --Extends-> TypeScript
    NGRX --Extends-> Angular
    graphql --Extends-> node

Pengaturan

Untuk menggunakan konfigurasi default, ikuti langkah -langkah ini:

1. Anda harus terlebih dahulu menginstal semua dependensi rekan yang diperlukan (jika belum):

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

2. Instal @code-pushup/eslint-config dengan:

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

3. Sertakan konfigurasi default di file konfigurasi eslint Anda (biasanya eslint.config.js ):

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

Bergantung pada tumpukan teknologi Anda, Anda mungkin juga ingin memperluas konfigurasi lain (tercantum di atas). Ini akan membutuhkan pemasangan dependensi rekan tambahan. Untuk detail lebih lanjut, lihat setup dokumen untuk konfigurasi yang Anda minati.

? Ketergantungan sebaya

Semua dependensi rekan yang digunakan oleh @code-pushup/eslint-config tercantum di bawah ini, bersama dengan versi yang didukung. Hanya dependensi konfigurasi default yang diperlukan, yang lain opsional.

	Paket NPM	Versi	Diperlukan
	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
	janji eslint-plugin	>=6.4.0	✅
	Eslint-plugin-sonarjs	^1.0.4	✅
	Eslint-plugin-unicorn	>=50.0.0	✅
	global	>=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

? Uji tes

Untuk kode non-produksi, beberapa aturan dinonaktifkan (atau diturunkan dari kesalahan menjadi peringatan).

Ini berlaku untuk jalur file yang cocok dengan salah satu dari Globs berikut:

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

? Berkontribusi

Instalasi Node.js adalah prasyarat (versi LTS). Instal dependensi dengan NPM:

npm install

Untuk menjalankan tes:

npm test

Untuk menghasilkan dokumentasi:

npm run docs