ほとんどのことについては、Alpine ドキュメントにアクセスしてください: Alpine Docs
このリポジトリに PR を送信して、ドキュメントの更新を送信してください。ドキュメントは/packages/docs
ディレクトリにあります。
貢献関連の情報については、ここをご覧ください。
V2 ドキュメントをお探しですか?ここにいます
npm install
とnpm run build
実行する<script>
タグから/packages/alpinejs/dist/cdn.js
ファイルをインクルードすれば準備完了です。ローカルに複製した後、このリポジトリのルート ディレクトリにnpm install
すると、すべてをインストールできます。
このリポジトリは、パッケージの管理に npm ワークスペースを使用する「モノリポジトリ」です。各パッケージには、 /packages
ディレクトリ内に独自のフォルダーがあります。
パッケージごとに個別のビルドを実行する必要はなく、すべてのパッケージ バンドルが同じコマンドnpm run build
で処理されます。
このリポジトリの各パッケージの概要は次のとおりです。
パッケージ | 説明 |
---|---|
アルピネス | Alpine のすべてのコアが含まれるメインの Alpine リポジトリ |
崩壊 | スムーズなアニメーションを使用して要素を展開および折りたたむためのプラグイン |
csp | Alpine の「CSP セーフ」ビルドを提供するリポジトリ |
ドキュメント | アルパインのドキュメント |
集中 | 要素内のフォーカスを管理できるプラグイン |
歴史 | 履歴 API を使用してデータをクエリ文字列パラメーターにバインドするためのプラグイン (名前は変更される可能性があります) |
交差する | ビューポートと交差する要素に基づいて JS 式をトリガーするプラグイン |
マスク | ユーザーの入力時にテキスト入力フィールドを自動的にフォーマットするプラグイン |
モーフ | ページ内の HTML (morphdom など) をインテリジェントにモーフィングするためのプラグイン |
持続する | ページの読み込み全体にわたって Alpine 状態を保持するためのプラグイン |
たとえば、 <script>
タグとして組み込まれるコンパイル済み JS ファイル ( npm run [build/watch]
の実行結果) は、各パッケージのpackages/[package]/dist
ディレクトリに保存されます。
各パッケージには少なくとも、自己初期化され、 <script defer>
タグのsrc
属性を使用して含めることができる「cdn」ビルドと、インポートに使用されるmodule.[esm/cjs].js
ファイルが必要です。 JS モジュールとして (ノードには cjs、その他すべてには esm)。
Alpine V3 のバンドルは ESBuild によって独占的に処理されます。これらのビルドの構成はすべてscripts/build.js
ファイルに保存されます。
このリポジトリでは、Cypress (統合テスト用) と Jest (単体テスト用) の 2 つの異なるテスト ツールが使用されています。
すべてのテストは/tests/cypress
および/tests/jest
の下の/tests
フォルダー内に保存されます。
npm run test
使用して、コマンドラインから両方を実行できます。
cypress を実行してそのユーザー インターフェイスを開くだけの場合は (開発中に推奨)、次のコマンドを実行できます: npm run cypress
Jest テストのみを実行したい場合は、通常のテストと同様にnpm run jest
実行し、ターゲット固有のテストを実行できます。 npm run jest -- --watch
のように、 --
使用して jest コマンドに転送するコマンド ライン設定オプションを指定できます。