@netcom-force/nf-codestyle
v0.1.2
Published
NF CodeStyle CLI =================
Maintainers
Readme
NF CodeStyle CLI
Netcom Force projeleri için ortak kod stili kurulum ve araçları. ESLint/Prettier ayarlarını ve düzenleyici yapılandırmalarını hızlıca ekler, import sıralamasını kontrol eder ve isteğe bağlı olarak otomatik düzeltir.
Önkoşullar
- Node.js 18+
Kurulum
- Tek seferlik kullanım (önerilen):
npx @netcom-force/nf-codestyle@latest --help- Projeye devDependency olarak eklemek:
npm i -D @netcom-force/nf-codestyleHızlı Başlangıç
Bir projeye takım kod stili dosyalarını eklemek ve scriptleri tanımlamak:
# Dosyaları ekle
npx @netcom-force/nf-codestyle init
# Var olan dosyaları ezmek için
npx @netcom-force/nf-codestyle init --force
# Scriptleri ve devDependency'leri ekle (eslint, prettier)
npx @netcom-force/nf-codestyle setup
# (İsteğe bağlı) Sadece package.json güncelle, kurulum yapma
npx @netcom-force/nf-codestyle setup --no-installKomutlar
init
Geçerli projeye takım kod stili dosyalarını yazar.
nf-codestyle init [--force]Yazılan dosyalar:
TEAM-CODESTYLE.md.editorconfig.vscode/settings.json.eslintrc.cjs.prettierrc.cjs.prettierignore
setup
package.json içine scriptleri ekler ve eslint + prettier devDependency olarak yazar. Varsayılan olarak kurulum da yapar.
nf-codestyle setup [--no-install]Eklenen scriptler:
lint:eslint . --ext .js,.jsx,.ts,.tsxformat:prettier -w .check-imports:nf-codestyle check-importsfix-imports:nf-codestyle check-imports --fix
check-imports
Dosya veya klasörlerde üst kısımdaki import bloklarını kontrol eder ve isteğe bağlı olarak sıralamayı düzeltir.
nf-codestyle check-imports [paths...] [--fix]Import Sıralama Kuralları
- Dış (3. parti) ve iç (relative/
@/) importlar ayrı gruplara ayrılır - Her grup içinde uzun satırdan kısa satıra doğru sıralanır
- Gruplar arasında 1 boş satır bırakılır
Örnek Kullanımlar
# Sadece kontrol (tüm proje)
nf-codestyle check-imports
# Otomatik düzelt ve yaz
nf-codestyle check-imports --fix
# Belirli klasör veya dosyalar
nf-codestyle check-imports src apps/web/src/index.tsNPM Scriptleriyle Çalıştırma
setup çalıştıktan sonra:
npm run lint
npm run format
npm run check-imports
npm run fix-importsNotlar
initsırasında hedef dosya var ise, varsayılan davranış üzerine yazmamak;--forceile ezebilirsinizsetupWindows ve POSIX ortamlarında otomatik uyumlu kurulum çağırır
Lisans
MIT
