Oraksoft Node Tools

Node.js projeleriniz için kullanışlı CLI araçları koleksiyonu.

• Oraksoft Node Tools
  • Kurulum
    • Global kurulum (önerilen)
    • Proje bazında kurulum
  • Konfigürasyon
  • Komutlar
    • orak-copy-deps
    • orak-deploy-ftp
    • orak-zip-content
    • orak-zip-package
    • orak-env-change
  • Kullanım Örnekleri
    • 1. Bağımlılık Kopyalama
    • 2. Arşiv Oluşturma ve FTP Yükleme
    • 3. Ortam Değiştirme
  • Gereksinimler
  • Lisans
  • Katkıda Bulunma
  • Sorun Bildirimi

Kurulum

Global kurulum (önerilen)

pnpm install -g oraksoft-node-tools

Proje bazında kurulum

pnpm install oraksoft-node-tools --save-dev

Konfigürasyon

Bu araçlar orak-config.json dosyasını kullanarak konfigüre edilir. Bu dosyayı proje kök dizininizde oluşturun:

{
  "copyDepsModulesToCopy": [
    {
      "name": "module-name",
      "file": "dist/module.js"
    }
  ],
  "copyDepsLibFolder": "lib",
  "copyDepsLibFolderEmpty": true,
  "zip_package": ["lib/", "bin/"],
  "zip_package_out_file": ".orak-dist/deploy1.tar.gz",
  "zip_content": ["bin", "lib"],
  "zip_content_out_file": ".orak-dist/deploy.tar.gz"
}

Komutlar

orak-copy-deps

Node.js bağımlılıklarınızı belirtilen klasöre kopyalar.

orak-copy-deps

Gerekli orak-config.json ayarları:

{
  "copyDepsModulesToCopy": [
    {
      "name": "module-name",
      "file": "dist/module.js"
    }
  ],
  "copyDepsLibFolder": "lib",
  "copyDepsLibFolderEmpty": true
}

orak-deploy-ftp

Belirtilen dosyayı FTP sunucusuna yükler.

orak-deploy-ftp [--profile <name>] [--v]

Gerekli .env.orakconfig dosyası:

osf_ftp_host=ftp.example.com
osf_ftp_user=username
osf_ftp_password=password
osf_ftp_secure=false
osf_ftp_local_file=deploy.tar.gz
osf_ftp_remote_path=public_html

• osf_ftp_host: FTP sunucusunun adresi
• osf_ftp_user: FTP kullanıcı adı
• osf_ftp_password: FTP şifresi
• osf_ftp_secure: true FTPS kullanır, false FTP kullanır (varsayılan: false)
• osf_ftp_local_file: Yüklenmek istenen dosyanın proje köküne göre yolu (uzantılı olarak yazın, ör: deploy.tar.gz)
• osf_ftp_remote_path: Uzak sunucudaki hedef klasör yolu (varsayılan: /)
• Dosya adı otomatik olarak osf_ftp_local_file'ın son bölümünden alınır

Ek opsiyonlar:

• --profile <name>: Belirtilen profil için önce osf_ftp_local_file_<name> (veya orak-config.json içinde aynı anahtar) aranır. Örnek: --profile test -> osf_ftp_local_file_test. Konsolda: test profil uygulandı.

• --v: Paket sürümünü (package.json içindeki version) dosya adına ekler. Noktalar _ ile değiştirilecek (örn. 1.2.3 -> 1_2_3) ve çok parçalı uzantılar korunacaktır (deploy.tar.gz -> deploy-1_2_3.tar.gz). Konsolda: 📦 Versiyon eklendi: 1_2_3 ve 📄 Güncel dosya adı: ...

❗ Güvenlik Notları:

• .env.orakconfig dosyası zaten .gitignore'da bulunuyor
• Web sunucunuzda .env.orakconfig dosyalarına erişimi engelleyin (.htaccess)
• Dosya izinlerini kısıtlayın: chmod 600 .env.orakconfig

📝 osf_ftp_host, osf_ftp_local_file ve osf_ftp_remote_path değerleri orak-config.json içinde de tanımlanabilir. .env.orakconfig'de yoksa orak-config.json'a bakar. Profil kullanılıyorsa osf_ftp_local_file_<profile> anahtarı da desteklenir.

orak-zip-content

Belirtilen dosya ve klasörleri tar.gz formatında arşivler.

orak-zip-content [--profile <name>] [--v]

Gerekli orak-config.json ayarları:

{
  "zip_content": ["bin", "lib"],
  "zip_content_out_file": ".orak-dist/deploy"
}

• zip_content: Arşive dahil edilecek dosya ve klasörler
• zip_content_out_file: Oluşturulacak arşiv dosyasının tam yolu (uzantısız; .tar.gz kod tarafından eklenir)

Ek opsiyonlar:

• --profile <name>: Profil adı verildiğinde zip_content_out_file_<name> anahtarı tercih edilir (örn: zip_content_out_file_test). Konsolda: test profil uygulandı.

• --v: Paket sürümünü (package.json içindeki version) dosya adına ekler; noktalar _ ile değişir ve dosya uzantısı korunur (örn. .orak-dist/deploy -> .orak-dist/deploy-1_2_3.tar.gz). Konsolda: 📦 Versiyon eklendi: 1_2_3

orak-zip-package

Belirtilen dosya ve klasörleri tar.gz formatında paket arşivi olarak oluşturur.

orak-zip-package [--profile <name>] [--v]

Gerekli orak-config.json ayarları:

{
  "zip_package": ["lib/", "bin/"],
  "zip_package_out_file": ".orak-dist/deploy1"
}

• zip_package: Paket arşivine dahil edilecek dosya ve klasörler
• zip_package_out_file: Oluşturulacak paket arşiv dosyasının tam yolu (uzantısız; .tar.gz kod tarafından eklenir)

Ek opsiyonlar:

• --profile <name>: Profil adı verildiğinde zip_package_out_file_<name> anahtarı tercih edilir (örn: zip_package_out_file_test).

• --v: Paket sürümünü (package.json içindeki version) dosya adına ekler; noktalar _ ile değişir ve dosya uzantısı korunur (örn. .orak-dist/deploy1 -> .orak-dist/deploy1-1_2_3.tar.gz).

orak-env-change

Ortam dosyalarını (.env) değiştirir.

orak-env-change dev
# veya
orak-env-change production

Opsiyonel orak-config.json ayarları:

{
  "fiEnvChangeStatus": "dev"
}

Bu durumda parametre vermeden orak-env-change komutunu çalıştırabilirsiniz.

Kullanım Örnekleri

1. Bağımlılık Kopyalama

# orak-config.json'da tanımlanan modülleri kopyala
orak-copy-deps

2. Arşiv Oluşturma ve FTP Yükleme

# .env.orakconfig dosyası oluşturun ve FTP bilgilerinizi ekleyin

# İçerik arşivi oluştur
orak-zip-content

# FTP'ye yükle
orak-deploy-ftp

# Alternatif olarak paket arşivi oluştur
orak-zip-package

3. Ortam Değiştirme

# Development ortamına geç
orak-env-change dev

# Production ortamına geç
orak-env-change prod

Gereksinimler

• Node.js >= 14.0.0
• NPM veya Yarn

Lisans

MIT

Katkıda Bulunma

1. Fork edin
2. Feature branch oluşturun (git checkout -b feature/amazing-feature)
3. Değişikliklerinizi commit edin (git commit -m 'Add amazing feature')
4. Branch'i push edin (git push origin feature/amazing-feature)
5. Pull Request oluşturun

Sorun Bildirimi

Sorunlarınızı GitHub Issues sayfasından bildirebilirsiniz.