npmパッケージの開発と公開

「.NET 開発基盤部会 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

• 戻る
  • npm
  • JavaScriptライブラリの作り方

目次 †

概要 †

NuGet同様、npmにもパッケージを登録してみる。

詳細 †

npmアカウントを作成する。 †

サインアップ †

https://npmjs.org/signup

以下をメモ。

• username
• password
• email address

npm adduser †

• ターミナルからnpm adduserを実行

  > npm adduser
  Username: XXXXX
  Password: YYYYY
  Email: (this IS public) ZZZZZ@ZZZZZ

• /.npmrcにtoken情報が書き込まれ、

• npmモジュールを公開する準備が整う。

モジュールを実装する †

package.json †

モジュールの名前や、依存関係などを記載する（nspec的なファイル）。

*.jsファイル †

• モジュール実装方法

• タイプ
  • ライブラリ的なモジュール：
    • index.js
    • indexは既定値ではなく、実際は、
      package.jsonのmainプロパティで指定したファイルを読む

• サーバやコンソールのコード：
  • app.js
  • node appで起動する。

• コマンドライン・ツール：
  以下が参考になる。
  • コマンドラインで動作する npm ライブラリを作る - Qiita
    https://qiita.com/star__hoshi/items/51c6cc719793abfb337d
  • Node で作るオレオレ CLI と npm への登録までの道のり - Qiita
    https://qiita.com/astronaughts/items/0ada9ad61a8956f647f0

• gruntのplugin：
  • ...

*.d.tsファイル †

• TypeScriptの型定義ファイル

ライブラリとして公開し更新を行う。 †

npm publishで公開と更新を行う。

公開 †

• 個人スコープ or スコープなし

  npm publish

• 組織スコープ
  では既定値が、privateになるので。

• private

  npm publish

• public

  npm publish --access public

更新 †

npm publish

※ 公開と同じ。
　ただしversion番号は上げておく。

公開したライブラリを利用 †

require構文で利用 †

https://github.com/OpenTouryoProject/SampleProgram/tree/master/PkgMgr/npm/ossc/console-app1

module構文(import)で利用 †

...

webpackで利用 †

https://github.com/OpenTouryoProject/SampleProgram/tree/master/PkgMgr/npm/ossc/browser-app1

参考 †

• 自作の非公開npmモジュールの作成と共通ライブラリ化
  https://www.usagi1975.com/23feb172352/

• npm でコマンド登録するパッケージ作ってみた
  http://var.blog.jp/archives/70303113.html

Qiita †

• 3分でできるnpmモジュール
  https://qiita.com/fnobi/items/f6b1574fb9f4518ed520
• grunt-pluginの作り方と解剖
  https://qiita.com/fnobi/items/5590e7e92b4f2bd81d04

• 初めてのnpm パッケージ公開
  https://qiita.com/TsutomuNakamura/items/f943e0490d509f128ae2

• npmのorganizationアカウント運営
  https://qiita.com/zprodev/items/a257510899e7f13c0b56

left-pad †

話題となった事もアリ、既にdeprecatedだが、
ミニマムな実装事例として参考にできる。

• left-pad/left-pad: String left pad
  deprecated, use String​.prototype​.pad​Start()
  https://github.com/left-pad/left-pad

test-library1 †

ossc-test-library1 †

OSSコンソーシアム 開発基盤部で登録したテスト用ライブラリ

• SampleProgram?/PkgMgr?/npm/ossc at master · OpenTouryoProject?/SampleProgram?
  https://github.com/OpenTouryoProject/SampleProgram/tree/master/PkgMgr/npm/ossc
  • ossc-test-library1
  • console-app1
  • browser-app1

• ossc-test-library1 - npm
  https://www.npmjs.com/package/ossc-test-library1

touryo-test-library1 †

前述のライブラリを組織スコープの名前空間に対応させたもの。

• SampleProgram?/PkgMgr?/npm/touryo at master · OpenTouryoProject?/SampleProgram?
  https://github.com/OpenTouryoProject/SampleProgram/tree/master/PkgMgr/npm/touryo
  • touryo-test-library1
  • console-app1
  • browser-app1

• @touryo/test-library1 - npm
  https://www.npmjs.com/package/@touryo/test-library1

※ npmでは、名前空間対応させたライブラリをscoped packagesと言うらしい。