wotan

Proyek Fimbullinter

Naskah type pluggable dan lintript javascript

Paket yang tersedia

Wotan

Runtime linter utama dengan serangkaian aturan builtin yang dipilih dengan baik. Dapat disesuaikan dengan aturan, prosesor, format, konfigurasi yang dapat dibagikan, dan modul plugin.

Silakan merujuk ke dokumen untuk penjelasan terperinci tentang aturan, konfigurasi, dan penggunaan yang tersedia.

Vé

Prosesor resmi untuk VUE Single File Components (SFC). Mengekstrak konten skrip dari file *.vue Anda untuk berbaris.

Heimdall

Lapisan Kompatibilitas untuk memungkinkan penggunaan aturan dan format TSLINT di dalam runtime Wotan.

Valtýr

Buat Wotan berperilaku hampir seperti tslint. Gunakan kembali tslint.json Anda yang ada tanpa perubahan.

Bifröst

Memungkinkan penulis aturan dan format TSLINT untuk menyediakan paket mereka untuk digunakan di dalam Wotan. Aturan dan format yang menggunakan Bifröst tidak perlu Heimdall berfungsi dengan benar.

Ymir

Memberikan jenis inti untuk aturan khusus dan penulis plugin.

Mímir

Berisi semua aturan inti, format dan preset konfigurasi.

Mithotyn

Plugin LangiseService untuk TypeScript. Memberikan linting in-editor real-time saat Anda mengetik.

Dokumentasi lebih lanjut

• Memahami API TypeScript
• Aturan menulis
• Aturan pengujian
• Menggunakan aturan lokal
• Menulis konfigurasi yang dapat dibagikan
• Menggunakan API

Resep

• File vue berbaris dengan aturan tslint
• Penggantian untuk tslint --type-check
• Mendeteksi variabel yang tidak digunakan

Tentang apa ini?

Ada apa dengan nama -nama itu?

Mitologi Norse:

Fimbullinter berasal dari Fimbulwinter, musim dingin yang berlangsung selama 3 tahun yang mendahului peristiwa Ragnarök. 'Fimbul' berarti 'The Great', 'Linter' adalah alat yang mendeteksi dan memperingatkan tentang pola pengkodean tertentu.

Wotan adalah salah satu dari banyak nama Odin, semua ayah. Anda mungkin juga mengenalnya dengan nama Woden, Wodan, Wensley, dll. Woden adalah dewa pengorbanan, haus darah dan kejam. Dia terus -menerus berjuang untuk kebijaksanaan. Dari singgasananya dia bisa melihat segala sesuatu di sembilan dunia terjadi.

Vé adalah yang termuda dari tiga Woden, Vili dan Vé yang bersama -sama yang bersama -sama membunuh Ymir raksasa dan menciptakan sembilan dunia dari tubuhnya.

Kepada pasangan manusia pertama, tanyakan dan embla, Odin memberi jiwa dan kehidupan; Vili memberi kecerdasan (kecerdasan) dan rasa sentuhan; dan Vé memberikan wajah (penampilan, ekspresi wajah), pidato, pendengaran, dan penglihatan.

Heimdall (juga dikenal sebagai Heimdallr), yang terletak di mana Jembatan Pelangi yang terbakar Bifröst bertemu Surga, berjaga -jaga untuk timbulnya Ragnarök.

Bifröst adalah jembatan pelangi yang terbakar yang menghubungkan dunia manusia dengan ranah dewa.

Valtýr , dari "Valr" (orang mati, terbunuh dalam pertempuran) dan "týr" (Tuhan), berarti Tuhan yang terbunuh dan sering digunakan untuk merujuk pada Odin.

Ymir adalah raksasa dari tubuh yang seluruh dunia diciptakan. Dia adalah leluhur dari semua Jötnar.

Mímir ("The Remainer, The Wise One") terkenal karena pengetahuan dan kebijaksanaannya. Dewa Odin membawa di sekitar kepala Mímir dan itu melafalkan pengetahuan dan nasihat rahasia kepadanya.

Mithotyn (sebenarnya "Mitoðinn", yang berarti "Dispenser of Fate") memperkenalkan aturan di mana tidak ada. Mengisi tempat Odin selama perjalanannya ke tanah asing.

Mengapa Linter Lain?

Yang ini mencoba menghindari keputusan desain dari serangkaian lain yang ternyata bermasalah:

• Hindari konflik nama dengan adanya nama aturan tergantung pada paket mereka berasal.
  • Tslint menempatkan semua aturan dalam namespace global dan mencari di semua direktori aturan yang tersedia. Urutan direktori penting sementara aturan inti mengesampingkan lebih diutamakan.
  • Eslint memungkinkan direktori aturan lokal sebagai bendera CLI. Aturan dalam direktori itu dapat mengganti aturan inti.
• Ketergantungan file konfigurasi diselesaikan relatif terhadap file itu.
  • Tslint sudah melakukan itu.
  • Eslint tidak mendukung itu.
• Tidak ada perbedaan antara konfigurasi dan plugin yang dapat dibagikan. Faktanya keduanya hanya konfigurasi yang dapat diperpanjang yang secara opsional dapat memberikan direktori, pengaturan, aturan, dan prosesor aturan.
  • TSLINT memungkinkan Anda untuk memilih antara extends dan rulesDirectory . Direktori aturan paket adalah detail implementasi dan tidak boleh menjadi bagian dari konfigurasi pengguna.
  • Eslint menangani konfigurasi dan plugin yang sangat berbeda. Bahkan mereka mencoba untuk mencela konfigurasi yang dapat dibagikan demi plugin.
• Memuat aturan malas untuk mengurangi waktu startup.
  • Tslint sudah melakukan itu.
  • Eslint mengharapkan plugin untuk memberikan aturan sebagai objek yang sudah dimuat. Itu menyebabkan banyak overhead jika Anda hanya menggunakan beberapa aturan paket besar.
• Caching akses dan konfigurasi sistem file. Karena cache adalah layanan DI, pengguna API dapat menghapus cache saat dibutuhkan.
• Dukungan untuk prosesor sejak awal. Mengaktifkan serat file *.vue dan banyak lagi.
• Alias ​​untuk aturan dengan konfigurasi. Dapat digunakan untuk memperlakukan aturan seperti no-resticted-syntax Eslint sebagai aturan bernama yang berbeda untuk setiap opsi konfigurasi.
• Seluruh API ditenagai oleh wadah DI. Itu membuatnya mudah untuk menyuntikkan layanan yang berbeda. Anda bahkan dapat menggunakan plugin melalui CLI untuk menyuntikkan layanan yang berbeda.
• File konfigurasi "Global" (selain .wotanrc.yaml ) untuk konfigurasi default dan plugin CLI: .fimbullinter.yaml . File ini juga dapat digunakan oleh plugin editor, jadi tidak perlu menduplikasi konfigurasi umum.
  • Eslint tidak memiliki file seperti itu dan menolak untuk menambahkan satu di masa depan. Alat seperti standard atau xo tidak perlu ada jika Anda hanya perlu membuat file konfigurasi dengan default CLI.
  • Tslint mulai memasukkannya ke dalam tslint.json mereka yang mengarah pada pengguna yang bingung.
• Laporkan tidak digunakan dan redundan mengaktifkan dan menonaktifkan komentar (atau bagiannya) dengan --report-useless-directives .
  • Eslint melaporkan hanya menonaktifkan komentar. Ini hanya melaporkan komentar yang sama sekali tidak digunakan. Komentar yang berlebihan tidak dilaporkan serta mengaktifkan komentar untuk aturan yang tidak ada.
  • Tslint tidak mendukung itu.

Perbedaan Tslint

• Untuk memperluas plugin atau konfigurasi yang dapat dibagikan, gunakan extends: plugin-name . Nama akan diselesaikan sesuai dengan algoritma resolusi modul Node relatif terhadap file konfigurasi.
• Untuk menggunakan aturan yang dikelola di dalam proyek Anda, gunakan rulesDirectory: {"my-prefix": "./path/to/rules"} dan konfigurasinya sebagai my-prefix/rule-one: "error" . Direktori Aturan adalah jalur relatif terhadap file konfigurasi.
• Overrides: Anda dapat menimpa kofigurasi utama dengan menentukan satu atau lebih overrides. Jika nama file cocok dengan pola Glob dari override, semua pengaturan yang disediakan oleh override itu diterapkan. Overrides diproses secara berurutan, kemudian menimpa pengaturan override dari overrides sebelumnya.
  • Pola cocok dengan relatif dengan file konfigurasi yang ditentukan dalam.
  • Pola tanpa tebasan hanya cocok dengan nama dasar setiap file.
  • Untuk membatasi kecocokan dengan direktori saat ini, awalkan pola dengan ./ .
  • Pola yang dinegasikan dapat digunakan untuk mengurangi dari kecocokan pola sebelumnya.
• linterOptions.exclude -> exclude
  • Tidak termasuk tidak ditimpa saat memperluas konfigurasi.
  • Pencocokan pola mengikuti aturan yang sama dengan overrides (lihat di atas).
• Dukungan JSON5 untuk file konfigurasi.
• Pengaturan aturan-independen yang dapat diambil oleh aturan dan prosesor.
• Prosesor, bahkan mendukung --project .
• Alias, lihat di atas
• Pendekatan yang waras dan aman untuk memperbaiki:
  • Tidak memperbaiki file dengan kesalahan sintaks.
  • Tidak termasuk penggantian yang tumpang tindih untuk mencegah menghancurkan kode Anda.
  • Menjalankan jumlah iterasi yang dapat dikonfigurasi per file untuk menerapkan perubahan yang bertentangan dalam iterasi berikutnya.
  • Berhenti jika perbaikan akan menimbulkan kesalahan sintaksis.
  • Memperbaiki dengan --project tidak membuat seluruh program dari awal, yang membuatnya cepat.
• Pengujian
  • Tes dikonfigurasi dalam file JSON yang dapat mengonfigurasi semua yang dapat Anda tentukan melalui CLI
  • File uji tidak mengandung markup kesalahan. Itu menghindari kesalahan sintaksis dan membuatnya lebih mudah dipelihara. Hasil serat dan konten tetap disimpan dalam file baseline yang terpisah.
  • Kode yang sama dapat diuji dengan pengaturan yang berbeda.
• Mendukung referensi proyek TypeScript.
• Memuat nilai default untuk opsi CLI dari .fimbullinter.yaml .
• Tidak menggunakan informasi tipe dalam file javascript yang tidak dicentang ( // @ts-nocheck atau "checkJs": false ).
• Laporan yang tidak digunakan dan berlebihan mengaktifkan dan menonaktifkan komentar dengan --report-useless-directives .

Lingkungan yang didukung

Proyek ini berjalan pada semua versi Node.

Proyek ini secara resmi mendukung 3 versi naskah stabil terbaru. Saat menulis ini adalah 3.0 - 3.2. Ini harus berfungsi dengan build malam TypeScript ( typescript@next ), tetapi tidak ada jaminan.

Aturan khusus setidaknya harus menggunakan ES6 untuk memiliki dukungan untuk kelas asli. Kalau tidak, Anda mengalami masalah ketika mencoba memperluas kelas yang diekspor dari salah satu paket.

Versi Semantik (Kebijakan SEMVER)

️ Kebijakan berikut hanya berlaku untuk 1.x dan rilis berikut. Setiap rilis dalam kisaran 0.x dianggap eksperimental. Ada dan akan melanggar perubahan API tanpa penghentian.

Secara teori setiap perubahan ke aturan dapat melanggar pengguna dan dapat dianggap sebagai perubahan besar. Untuk menghindari merilis versi utama baru untuk setiap perbaikan bug, kami memiliki pedoman yang sedikit berbeda seperti yang diuraikan di bawah ini.

Prereleases (build malam)

• tidak dijamin stabil
• Ditandai sebagai NPM next sehingga Anda dapat menginstal @fimbul/wotan@next
• Berisi perubahan terbaru yang dimaksudkan untuk rilis berikutnya
  • x.0.0-dev* berisi semua perubahan termasuk yang melanggar untuk versi utama berikutnya
  • xy0-dev* berisi semua perubahan untuk versi minor berikutnya
  • Tidak ada prerelease untuk versi tambalan

Rilis Patch

• perbaikan crash
• perbaikan regresi
• refactorings fungsi internal yang tidak mengubah perilaku menghadap pengguna

Rilis kecil

• Menambahkan aturan baru, opsi aturan, formatter, prosesor, API
• Aturan dapat menambahkan cek baru yang dapat menyebabkan temuan baru
• Aturan dan opsi baru diaktifkan di wotan:latest
• Aturan dapat mengubah pesan penemuan mereka
• Formatters yang ditujukan untuk konsumsi manusia (misalnya stylish ) dapat mengubah output mereka
• Aturan, Opsi Aturan, Formatters, Prosesor dan API dapat ditinggalkan
• Opsi konfigurasi baru dapat ditambahkan ke file konfigurasi

Rilis utama

• berisi perubahan API yang melanggar
• Menghapus aturan, opsi, format, dll.
• Formatters yang ditujukan untuk konsumsi mesin (misalnya json atau tap ) dapat mengubah outputnya
• wotan:recommended diperbarui ke konten wotan:latest

Jadwal rilis

Saat ini tidak ada jadwal rilis tetap. Bangunan malam diterbitkan setiap malam jika ada perubahan pada master. Rilis tambalan diterbitkan segera setelah bug diidentifikasi dan diperbaiki. Rilis kecil diterbitkan setiap atau dua minggu jika ada perubahan pada master. Rilis besar diterbitkan begitu perubahan yang cukup melanggar telah menumpuk.

Lisensi

Apache-2.0 © Klaus Meinhardt