GIS フロントエンド プログラミング - Leaflet プラグインのリリース
Leaflet には強力なプラグイン エコシステムがあります。Leaflet プラグイン ページには数十の優れたプラグインがリストされており、ユーザーが使用できるように多くのプラグインが毎週プラグイン リポジトリに追加されます。
ユーザーは、一定の規格や仕様に従ってプラグインの機能や関連ファイルの記述を完成させ、ファイルをアップロードし、審査に合格すると正式にプラグインのリリースが完了します。Leafletプラグインリリースのプロセスを図に示します。
図 リーフレットプラグインリリースの流れ
- Leaflet プラグインの仕様（準備ファイル）
Leaflet プラグインの開発とリリースは 1. Leaflet プラグインの仕様（準備ファイル）
Leaflet プラグインの開発とリリースはいくつかの品質基準と拡張仕様に従う必要があります。
(1) デモファイル。
• ストレージ。Leaflet プラグインは別の GitHub リポジトリに保存されます。
• ネーミング。プラグインの名前は Leaflet.MyPluginName の形式で付けられますが、他の形式 (leaflet-my-plugin-name など) を使用することもできます。プラグインがプラグインであることが明確にわかるように、名前に Leaflet という単語を必ず含めてください。チラシプラグイン。
• サンプル ファイル。デモ ファイルは、プラグインを公開するファイルに含まれている必要があります。なぜなら、ユーザーはプラグインを探すとき、まずプラグインのインスタンス ファイルを参照するからです。デモを行う最も簡単な方法は、GitHub Pages を使用することです。できればリポジトリ内に GitHub Pages フォークを作成し、そこにindex.html ページを追加します。
• Readme ファイル。README.md (または同様のコンテンツを含む Web サイトへのリンク) を作成する必要があります。少なくとも、プラグインの名前、単純かつ簡潔な説明、要件 (バージョン、その他の外部依存関係、ブラウザーまたはデバイス) が含まれている必要があります。互換性）、デモ リンク、プラグインの説明、簡単なサンプル コード。
• ライセンス ファイル。すべてのオープン ソース リポジトリには、MIT ライセンスや BSD 2 条項ライセンスなどのライセンス ファイルが含まれている必要があります。
(2) コード。
• ファイル構造。他のユーザーがプラグイン ファイルを簡単に読んですぐに学習できるように、ファイル構造をクリーンかつシンプルに保ちます。最も基本的なプラグイン ファイル構造のコードは次のとおりです。
比較的複雑なプラグイン ファイル構造のコードは次のとおりです。
• コード規則。人はそれぞれ異なる習慣を持っていますが、作成するコードは人々の読書習慣に準拠している必要があります。
• API プラグイン。プラグインでグローバル変数を公開しないでください。新しいクラスがある場合は、それを L 名前空間 (L.MyPlugin) に直接配置します。既存のクラスを継承する場合は、子プロパティ(L.TileLayer.Banana)にします。各クラスには、L.TileLayer.Banana など、キャメルケースを使用して名前を付ける必要があります。既存の Leaflet クラスに新しいメソッドを追加したい場合は、L.Marker.include({myPlugin: …}) を実行できます。
関数、メソッド、プロパティ、およびファクトリー名にはキャメルケースを使用する必要があります。クラス名は大文字で、キャメルケースの命名規則に従う必要があります。
関数に多くのパラメーターがある場合は、パラメーター オブジェクトを定義することを検討してください (ユーザーがすべての値を指定する必要がないように、可能な場合はデフォルト値を設定します)。コードは次のとおりです。
(3) NPM のリリース。NPM (Node Packaging Module) は、JavaScript のパッケージ マネージャーおよびコード リポジトリです。NPM でモジュールを公開すると、他のユーザーがプラグインやそれに依存する他のプラグインをすぐに見つけてインストールできるようになります。NPM には、このプロセスを通じてユーザーを支援する優れた開発者ガイドが用意されています。ユーザーがプラグインを公開すると、Leaflet への依存関係が package.json ファイルに追加されます。ユーザーがソフトウェアをインストールすると、Leaflet が自動的にインストールされます。
以下は、Leaflet プラグインを記述する package.json ファイルです。コードは次のとおりです。
(4) モジュールローダー。モジュール ローダー (RequireJS および Browserify) は、AMD (Asynchronous Module Definition) モジュールや CommonJS モジュールなどのモジュール システムを実装し、ユーザーがモジュール形式でコードをロードできるようにします。AMD モジュールと CommonJS モジュール ローダーのサポートは、次のコードを使用して、共通モジュール定義に基づくパターンに従って Leaflet プラグインに追加できます。
このプラグインは AMD モジュールおよび CommonJS モジュールとして利用可能になり、RequireJS および Browserify のモジュール ローダーで使用できます。
2. リーフレットプラグインアップロード（ファイルアップロード）
プラグインが正常にリリースされると、Leaflet公式サイトのプラグイン一覧にプラグインが表示されます。Leaflet プラグインを公開する手順は次のとおりです。
(1) Leafletリポジトリを取得します。
(2) カテゴリの確認: docs/plugins.md ファイル内で、プラグインを挿入する部分を見つけ、プラグインに関連する情報とリンクを追加します。
(3) コードを送信します。
(4) 審査に合格します。
リクエストが送信されると、Leaflet の管理者がユーザーのプラグインを迅速にレビューします。アップロードされた Leaflet プラグインが仕様要件を満たしている場合、すぐにレビューに合格し、プラグインが正常にアップロードされたことが示されます。