自作のプラグインをnpmで公開しよう *

なでしこは、Node.jsのエコシステム上で動作するように配慮されています。
そのため、自分の作ったプラグインをnpm上で公開すると、みんなに使ってもらいやすくなります。

npmでプロジェクトを初期化 *

コマンドラインで以下のコマンドを実行します。以下は「nadesiko3-fuga」という名前のプロジェクトを作成します。なでしこのプラグインは「nadesiko3-xxx」という名前にしておくと、みんなから探しやすくなります。

# プロジェクトフォルダを作成
mkdir nadesiko3-fuga
cd nadesiko3-fuga
# npm でプロジェクトを初期化
npm -f init
# 開発用になでしこをインストール
npm install nadesiko3 --save-dev

プラグインを作成 *

以下を参考にプラグインを作りましょう。

なお、ひな形となるプロジェクトがnadesiko3-hogeです。このプロジェクトを参考に作ってみてください。

npmでプラグインを公開 *

まず、npmにユーザー登録(Sign Up)します。

公開情報をpackage.jsonに記述します。特に、versionが重要で、同じバージョンを公開することができないようになっています。

{
  "name": "ライブラリ名",
  "version": "バージョン情報(重要)",
  "description": "ライブラリの説明",
  ....
}

最後に以下のコマンドを実行して公開します。

npm publish

npmで公開すると... *

jsDeliverというCDNを介して、世界中にライブラリが公開されます。

●jsDelivrのURL規則
https://cdn.jsdelivr.net/npm/パッケージ名@バージョン/ファイル名

例えば、ライブラリ「nadeisko3-hoge」のバージョン3.6.15に含まれるファイル「nadesiko3-hoge.mjs」を取得するURLは以下のようになります。

https://cdn.jsdelivr.net/npm/nadesiko3-hoge@3.6.15/nadesiko3-hoge.mjs

使用例 *

!「https://cdn.jsdelivr.net/npm/nadesiko3-hoge@3.6.15/nadesiko3-hoge.mjs」を取り込む。
3と5をHOGE足して表示。

命名規則をうまく利用しよう *

命名規則をうまく利用すると拡張プラグインとしてURLの省略記法が可能です。
以下の二つの記述方法は同じ意味になります。

!「https://cdn.jsdelivr.net/npm/nadesiko3-hoge@0.0.6/nadesiko3-hoge.mjs」を取り込む
!「拡張プラグイン:hoge.mjs@0.0.6」を取り込む

つまり、npmに公開したプラグインであれば、下記のように指定することで、プラグインの取り込みが可能です。

!「拡張プラグイン:nadesiko3-(名前)@0.0.6/nadesiko3-(名前).mjs」を取り込む
FAQ/作ったプラグインをnpmで公開する方法 (1177)