概要: このチュートリアルでは、新しいパッケージを作成して npm レジストリに公開する方法を学びます。
npm へのパッケージ公開
まず、npmjs.com のサインアップページにアクセスして新しいアカウントを作成する必要があります。重要な情報は、ユーザー名、パスワード、公開メールアドレスです。パッケージを公開する際に、これらの情報が必要になります。
次に、新しいパッケージ(例: galaxy-lib
)を作成します。galaxy-lib
ディレクトリで、npm init --yes
コマンドを実行して、package.json
ファイルを作成します。
npm init --yes
Code language: Shell Session (shell)
package.json
ファイルを作成したら、銀河の数を返す簡単な関数を持つ index.js
という新しいモジュールを作成できます。
module.exports.count = function () {
return 1000000;
}
Code language: JavaScript (javascript)
3番目に、パッケージを npm に公開するには、ターミナルから npm login
コマンドを使用します。
npm login
Code language: Shell Session (shell)
username
、password
、email
の情報を入力するように求められます。
最後に、npm publish
コマンドを実行して、galaxy-lib
パッケージを npm レジストリに公開します。
npm publish
Code language: Shell Session (shell)
npm publish
コマンドの実行後にエラーが発生した場合、公開しようとしているパッケージの名前が既に存在している可能性があります。この場合は、package.json
ファイルでパッケージ名を一意のものに変更する必要があります。
公開されたパッケージの使用
galaxy-lib
パッケージを使用するには、galaxy-demo
という新しい Node プロジェクトを作成し、npm init
コマンドを実行します。
npm init --yes
Code language: Shell Session (shell)
公開した galaxy-lib
パッケージをインストールするには、npm install
コマンドを実行します。
npm install galaxy-lib
Code language: Shell Session (shell)
以下に app.js
を作成し、galaxy-lib
パッケージを使用します。
const galaxy = require('galaxy-lib');
console.log(galaxy.count());
Code language: JavaScript (javascript)
最後に、次のコマンドを使用して app.js
プログラムを実行します。
node app.js
Code language: Shell Session (shell)
出力
1000000
Code language: Shell Session (shell)
パッケージの公開取り消し
npm レジストリにパッケージを公開すると、他のユーザーがすでにそれを使用している可能性があります。そのため、npm レジストリからパッケージの公開を取り消すことは一般的に悪い行為と見なされます。
どうしても実行する必要がある場合は、npm unpublish
コマンドを実行してパッケージの公開を取り消すことができます。
npm unpublish [<@scope>/]<package_name>[@<version>]
Code language: HTML, XML (xml)
npm unpublish
コマンドは、npm レジストリからパッケージのバージョンを削除し、そのエントリを削除し、tarball を削除します。
他の開発者にパッケージを使用しないように勧めたり、バージョンを更新するように促すには、代わりに npm deprecate
コマンドを使用する必要があります。
npm deprecate <package_name>[@<version>] <deprecation_message>
Code language: HTML, XML (xml)
この npm deprecate
コマンドは、パッケージの npm レジストリを更新し、インストールしようとするすべてのユーザーに非推奨の警告を発行します。
まとめ
npm publish
コマンドを使用して、パッケージを npm レジストリに公開します。- 公開されたパッケージを npm レジストリから削除するために、npm unpublish コマンドを使用することは避けてください。
- 公開されたパッケージを非推奨にするには、
npm deprecate
コマンドを使用します。