All Articles

npm fundとは何か

npmバージョン6.13から npm fund というコマンドが実装されました。 このコマンドがどういう動きをするのか解説します。

TL;DR

  • npm fundというコマンドが実装された
  • 資金提供のためのURLなどが表示される
  • 自分のパッケージにも funding フィールドを追加してURLを表示できる

細かい仕様はこちらに載っています

npm fundとは何か

上記で述べた通り、このコマンドは利用者が開発者に対して金銭的支援をするための情報を表示します。 開発者から資金援助のための情報を提供する手段が1つ増えたことになりますね。

This RFC identifies an initial means of tooling to describe & notify consumers of a package’s monetary support information.

initial means(最初の手段)として提供されているので、もしかすると今後のアップデートでより開発者の支援を後押しする機能が入ってくる可能性もあるのかなと思います。

fundingフィールドの設定

npm fund に情報を表示させるには、自身が公開しているnpmパッケージの package.json に以下のように追記します。 例ではpatreonのURLを入れています。

"funding": {
    "type": "patreon",
    "url": "https://www.patreon.com/user?u=26669499"
}

上記を設定して npm fund コマンドを打つと、以下のように出力されます。

$ npm fund
npm-fund-test@1.0.0
├── type: patreon
└── url: https://www.patreon.com/user?u=26669499

That’s it! これで誰でも「このパッケージめっちゃ使いやすいじゃん!支援したい!」というときに爆速で募金ページを表示することができるようになりましたね!

おまけ

サンプルはGitHubに置いていますので良ければ使って下さい。 npmにも置いているので以下のコマンドを使えばマッハで挙動を確認できます。

npm i npm-fund-test
npm fund