Buka dokumen Alpine untuk mengetahui banyak hal: Dokumen Alpine
Anda dipersilakan untuk mengirimkan pembaruan pada dokumen dengan mengirimkan PR ke repo ini. Dokumen terletak di direktori /packages/docs
.
Tetap di sini untuk informasi terkait kontribusi.
Mencari dokumen V2? ini dia
npm install
& npm run build
/packages/alpinejs/dist/cdn.js
dari tag
di halaman web dan Anda siap melakukannya! Anda dapat menginstal semuanya dengan: npm install
di direktori root repo ini setelah mengkloningnya secara lokal.
Repo ini adalah "mono-repo" yang menggunakan ruang kerja npm untuk mengelola paket. Setiap paket memiliki foldernya sendiri di direktori /packages
.
Daripada harus menjalankan build terpisah untuk setiap paket, semua bundel paket ditangani dengan perintah yang sama: npm run build
Berikut ini sekilas setiap paket dalam repo ini:
Kemasan | Keterangan |
---|---|
alpinejs | Repo Alpine utama dengan semua inti Alpine |
runtuh | Sebuah plugin untuk memperluas dan menciutkan elemen menggunakan animasi yang halus |
csp | Repo untuk menyediakan build Alpine yang "aman untuk CSP". |
dokumen | Dokumentasi Alpen |
fokus | Sebuah plugin yang memungkinkan Anda mengelola fokus di dalam suatu elemen |
sejarah | Sebuah plugin untuk mengikat data ke parameter string kueri menggunakan API riwayat (nama mungkin berubah) |
memotong | Sebuah plugin untuk memicu ekspresi JS berdasarkan elemen yang berpotongan dengan viewport |
masker | Sebuah plugin untuk secara otomatis memformat kolom input teks saat pengguna mengetik |
berubah | Sebuah plugin untuk mengubah HTML (seperti morphdom) di dalam halaman dengan cerdas |
bertahan | Sebuah plugin untuk mempertahankan status Alpine di seluruh pemuatan halaman |
File JS yang dikompilasi (sebagai hasil dari menjalankan npm run [build/watch]
) untuk dimasukkan sebagai tag misalnya disimpan di direktori
packages/[package]/dist
setiap paket.
Setiap paket setidaknya harus memiliki: build "cdn" yang menginisialisasi sendiri dan dapat disertakan menggunakan atribut src
dalam tag , dan file
module.[esm/cjs].js
yang digunakan untuk mengimpor sebagai modul JS (cjs untuk node, esm untuk yang lainnya).
Bundling untuk Alpine V3 ditangani secara eksklusif oleh ESBuild. Semua konfigurasi untuk build ini disimpan dalam file scripts/build.js
.
Ada 2 alat pengujian berbeda yang digunakan dalam repo ini: Cypress (untuk pengujian integrasi), dan Jest (untuk pengujian unit).
Semua tes disimpan di dalam folder /tests
di bawah /tests/cypress
dan /tests/jest
.
Anda dapat menjalankan keduanya dari baris perintah menggunakan: npm run test
Jika Anda hanya ingin menjalankan cypress dan membuka antarmuka penggunanya (disarankan selama pengembangan), Anda dapat menjalankan: npm run cypress
Jika Anda hanya ingin menjalankan pengujian Jest, Anda dapat menjalankan npm run jest
seperti biasa dan menargetkan pengujian tertentu. Anda dapat menentukan opsi konfigurasi baris perintah untuk meneruskan ke perintah jest dengan --
seperti: npm run jest -- --watch