npmで独自のパッケージを公開するための小さなガイドがあります。

あなたは本当に便利だと思うソフトウェアコードをいくつか書きました! 次に、 npm で公開して、他の人があなたのすばらしいコードのバンドルを使用できるようにします。

npm xmas

ターミナルの発砲

npm には多くの構成がありますが、多くの場合、これらはプロジェクト固有です。 この記事では、npmでパッケージを公開するための基本事項について説明します。

npmはNode.jsに含まれています。 npmがシステムにインストールされているかどうかを確認するには、ターミナルで次のコマンドを実行します:npm -v

ディレクトリを作成する

パッケージのソースコードを保持するフォルダを作成しましょう。 ターミナルで:

# This will create, and navigate
# into the `wonderful-bundle` directory
$ mkdir wonderful-bundle
$ cd wonderful-bundle

npmパッケージの初期化

これでフォルダに移動したので、ここからnpmコマンドの使用を開始します。

$ npm init

npm initを実行すると、いくつかのセットアップに関する質問が表示されます(たとえば、パッケージの名前、パッケージの説明など)。

質問ごとに「Enter」を押すだけで、package.jsonファイルのこのデフォルトの定型文がディレクトリに作成されます。

package.json
{
  "name": "wonderful-bundle",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
      "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

package.jsonファイルとは何ですか?

package.jsonファイルをお気に入りの食事のレシピカードと比較できます。

package.jsonファイルには、プロジェクトに関するすべての記述メタデータ(「アップルパイ」という名前など)と、プロジェクトを適切に実行するために必要なすべての依存関係(「リンゴ」、「パイクラスト」など)が含まれています。 、「砂糖」など)。

このすべての情報を使用して、npmはすべてをまとめ、パッケージを他の人が簡単にダウンロードして実行できるようにします。


package.jsonを編集して、説明と作成者情報を含めましょう。

{
  "name": "wonderful-bundle",
  "version": "1.0.0",
  "description": "outputs an uplifting message",
  "main": "index.js",
  "author": "Chompy MacPherson <[email protected]>",
  "license": "ISC"
}

package.jsonで必要なフィールドは、「name」、「version」、および「main」のみです。 まだテストが作成されていないため、「scripts」フィールドは削除されました。

「メイン」フィールドは、JavaScriptコードへのファイルパスです。 誰かがあなたのパッケージを使用すると、このJavaScriptファイルが使用されます。 ターミナルでindex.jsファイルを作成しましょう。

$ touch index.js

お好みのテキストエディタで…

index.js
module.exports = function() {
  console.log("you're wonderful!");
  return;
};

ソフトウェアプロジェクトにローカルなファイルの場合と同じ方法で、コードをexportすることを忘れないでください。

READMEの作成

一般に、他の人がその使用方法を知っているように、パッケージのドキュメントを含めることをお勧めします。 READMEファイルは通常、この目的で使用されます。

パッケージのディレクトリのルートにREADMEファイルを作成しましょう。

# create the README file
$ touch README

# put some text into README
$ echo "## Wonderful Bundle \n\n Get an uplifting message!" > README

…そして公開

現在、wonderful-bundleのファイルディレクトリは次のようになっています。

wonderful-bundle
 |_ index.js
 |_ README
 |_ package.json

基本的に、これはnpmパッケージの基本構造です。 ソフトウェアをnpmに公開するのにそれほど多くは必要ありません!

パッケージにかなり満足しているので、公開しましょう!

$ npm publish

npmレジストリのWebサイトにアカウントが必要です。CLIからログインしていない場合は、ログインするように求められます。 また、レジストリでまだ使用されていないパッケージ名を使用する必要があります。

まとめ

それでおしまい! これで、パッケージがnpm公開されました。 要約すると、ゼロから公開に移行するためのステップは3つだけです。

  • 初期化:npm init
  • ソースコードを追加します:index.jsおよびREADME
  • 公開:npm publish

今、誰かがあなたのパッケージを使いたいとき、彼らは彼らのターミナルでこれを実行するだけです:

$ npm install wonderful-bundle

これにより、パッケージに必要な依存関係がダウンロードされ、他の人のソフトウェアプロジェクトにインストールされます。 テクノロジーは素晴らしいです🤤


このガイドが、ソフトウェアがどれほど重要か小さいかに関係なく、オープンソースコミュニティにソフトウェアを提供することがいかに簡単であるかを示してくれることを願っています📦👉🌎

Yarn を使用したい場合は、次のガイドを確認してください: npm vsYarnCommandsチートシート