この記事の最終更新日: 2023年3月17日
NPM（Node Package Manager）は、Node.jsで使用される最も一般的なパッケージ管理システムです。NPMを使用して自分のモジュールを作成し、他の開発者がそれを使用できるようにすることができます。この記事では、NPMモジュールの作成方法について、ステップバイステップで解説します。
プロジェクトディレクトリを作成する
まず、NPMモジュールを作成するために、プロジェクトディレクトリを作成します。このディレクトリは、すべてのファイルが含まれる場所です。
mkdir my-npm-module
cd my-npm-modulepackage.jsonファイルを作成する
次に、package.jsonというファイルを作成します。このファイルには、パッケージのメタデータが含まれます。
npm initコマンドを実行すると、いくつかの質問が表示されます。必要な情報を入力して、package.jsonファイルを作成します。
npm initモジュールのコードを作成する
次に、モジュールのコードを作成します。この例では、my-npm-moduleという名前の単純なモジュールを作成します。
my-npm-module.jsファイルを作成し、以下のようにコードを記述します。
module.exports = {
sayHello: function() {
console.log('Hello from my NPM module!');
}
};モジュールを公開する
モジュールが完成したら、それをNPMレジストリに公開する必要があります。
まず、NPMアカウントを作成します。NPMアカウントがある場合は、次のコマンドでログインします。
npm login次に、npm publishコマンドを使用してモジュールを公開します。
npm publishこれで、自分が作成したNPMモジュールが公開されました！
モジュールを使用する
他の開発者が自分のモジュールを使用するには、以下のコマンドを使用します。
npm install my-npm-moduleモジュールをインストールすると、以下のように使用できます。
const myModule = require('my-npm-module');
myModule.sayHello();バージョン管理する
自分が作成したNPMモジュールが改善されたり、バグ修正がある場合は、新しいバージョンをリリースする必要があります。そのためには、package.jsonのversionプロパティを変更します。
"version": "1.0.1"バージョンを変更したら、npm publishコマンドで新しいバージョンを公開します。
npm publish依存関係を追加する
自分のモジュールが他のモジュールに依存している場合は、package.jsonファイルに依存関係を追加する必要があります。依存関係は、dependenciesプロパティに記述されます。
"dependencies": {
"lodash": "^4.17.21"
}この例では、Lodashというライブラリに依存していることを示しています。^4.17.21は、4.x.xバージョンのLodashを使用することを示しています。
依存関係を追加したら、npm installコマンドを使用して、必要なすべての依存関係をインストールします。
npm installREADMEファイルを作成する
自分が作成したモジュールについて説明するために、README.mdファイルを作成することをお勧めします。このファイルには、モジュールの概要、使用方法、APIドキュメントなどを含めることができます。
テストを作成する
品質を確保するために、モジュールに対してテストを実行することが重要です。テストフレームワークとしては、JestやMochaなどがあります。
テストコードをtestsディレクトリに保存し、package.jsonファイルにテストコマンドを追加します。
"scripts": {
"test": "jest"
}
テストを実行するには、以下のコマンドを使用します。
npm testまとめ
以上が、NPMモジュールの作成方法についてのステップバイステップガイドでした。NPMモジュールを作成すると、自分が作成したコードを世界中の開発者と共有できます。必要なステップを踏んで、自分のモジュールを公開して、他の開発者に利用してもらいましょう！
大阪のエンジニアが書いているブログ。
コメント