@itsae/genfolder NPM

Genfolder

CLI tool untuk menghasilkan struktur direktori dalam format Markdown dan menyisipkannya ke dalam README.md.

Fitur

Menghasilkan struktur folder dan file dari proyek Anda pada README.md
Output otomatis dalam format Markdown
Secara otomatis menyisipkan atau memperbarui bagian "Directory Hierarchy" di README.md
Melewati folder seperti node_modules, dist, .git,.vite,`.doc, dan bisa menambahkan pengecualian folder dengan cara menambahkan konfigurasi pada file .genfolderrc.json

Instalasi

npm install @itsae/genfolder

Atau dengan cara instalasi global:

npm install -g @itsae/genfolder

Konfigurasi (Opsional)

Untuk mengecualikan file/folder tertentu agar tidak muncul di hasil struktur, buat file .genfolderrc.json di root proyek. Penulisan Path menggunakan pola glob sama seperti .gitignore.

Contoh isi file .genfolderrc.json:

{
  "ignore": [
    "tests/**",
    "scripts/**",
    "**/*.log"
  ]
}

Cara menggunakan

Arahkan ke direktori proyek kamu, lalu jalankan:

npx genfolder

Jika instalasi global jalankan diterminal:

genfolder

atau dengan cara menambahkan skrip di package.json kamu seperti ini:

{
  "scripts": {
    "genfolder": "genfolder"
  }
}

lalu jalankan:

npm run genfolder

Perintah di atas akan Mencari semua file dan folder (dengan pengecualian tertentu). Membentuk struktur direktori dalam format Markdown. Menyisipkan atau memperbarui bagian

Setelah dijalankan, README.md kamu akan memiliki bagian seperti ini (Contoh):