【Node.js】自作ライブラリの公開

localtimeと名前の自作ライブラリをnpmに公開する時は次のようにする。
※「この記事では、『ライブラリ』という言葉は『Node.jsのnpmレジストリからインストール可能なパッケージ』という意味で使用している。
つまり、ここでは『ライブラリ』と『パッケージ』は同じ意味であり、再利用可能なコードや機能をまとめたものを指している。」

npmのアカウントは前もって作っておくこと。
文字コードはUTF-8(BOMなし)すること。
改行コードはLFにすること。
自作ライブラリをnpmに公開するだけならgithubに同じコードを公開する必要はない。
しかし、大抵の場合はgithubにnpmに公開するコードを同じコードを公開しておくみたいだな。

〇〇\localtime>npm login
〇〇\localtime>npm publish --access public

「npm publish」でプライベートコープに自作ライブラリが公開される。
しかし、「–access public」をオプションで付けるとパブリックスコープになり、誰でもインストール可能な公開されたライブラリになる。

次のコードも覚えておくと便利かも。
お試しで「npm publish –access public」にオプションで「–dry-run」を付けると、
npm v6.0以上でお試し実行が可能である。
pakage.jsonが同じversionで「–dry-run」を何回実行してもエラーにならない。これは正常な挙動である。

〇〇\localtime>npm publish --access public --dry-run

公開のプロジェクトにおけるpackage.jsonの設定例は次の通り。
(公開のプロジェクトで一般的に設定しておく最低限の項目の設定例)
package.jsonの必須設定項目は「name」と「version」の2つだけである。
name: パッケージの名前
version: パッケージのバージョン
main: エントリーポイントとなるメインファイルのパス
license: パッケージのライセンス(MITなど)
private: プライベートなパッケージかどうかを示すフラグ(世界に自作ライブラリを公開する場合は必ずfalse)

package.jsonの設定例は次の通り。

{
  "name": "@○○○○/△△△",
  "version": "1.0.0",
  "main": "△△△.js",
  "license": "MIT",
  "private":false
}

非公開のプロジェクトにおいるpackage.jsonの設定例は次の通り。
(非公開のプロジェクトで一般的に設定しておく最低限の項目の設定例)
package.jsonの必須設定項目は「name」と「version」である。
privateは「true」にする。このフィールドを「true」に設定することで、パッケージが非公開であることを示す。非公開プロジェクトの場合、この設定は必要である。
licenseは「UNLICENSED」にする。パッケージのライセンス情報を指定するとき、「UNLICENSED」はライセンスが未指定であることを示す。
非公開プロジェクトでは、通常、ライセンス情報を含めないため「UNLICENSED」を指定する。
「UNLICENSED」は通常は大文字である。

{
  "name": "@○○○○/△△△",
  "version": "1.0.0",
  "main": "△△△.js",
  "license": "UNLICENSED",
  "private":true
}

私が公開した自作ライブラリは次の通り。
@reiwa_info_fin_corp/localtime – npm (npmjs.com) ExternalLink

• 
• Tweet

• Node.js