npmでpackageをパブリッシュする

6974 ワード

文書ディレクトリ
  • 一、関連package.json紹介
  • ファイルで参照されるパケット
  • を記述する.
  • コマンドラインで実行可能なパケット
  • を記述する.
  • 3. 推奨パッケージ
  • 一、関連package.json紹介戻りディレクトリ
    {
      "name": "xxx", //    
      "version": "0.1.0", //  
      "main": "index.js", //     
      "description": "npm demo", //    
      "license": "GPL-3.0", //    
        "author": { //    
        "name": "wwwmewww" //  
      },
      "keywords": [ //   ,    npm     
        "js",
      ],
      "repository": { //    ,        
        "type": "git",
        "url": "git+https://github.com/wwwmewww/xxx.git"
      },
      "bugs": { //bug    
        "url": "https://github.com/wwwmewww/xxx/issues"
      },
      "homepage": "https://github.com/wwwmewww/xxx#readme", //  
    }
    
    ファイルで参照されるパケット戻りディレクトリを記述する
  • パケットのエントリファイル
    //index.js
    module.exports = function(){
      console.log('hello');
    }
    
  • packageを構成する.json
    //package.json
    {
    	"main": "index.js", //        
    }
    
  • パケット
    const mypack = require('mypack');
    mypack(); //   ,  :hello
    
  • を参照して実行する.
    コマンドラインで実行できるパッケージリターンディレクトリの作成
  • パケットのエントリファイルindex.js
    #!/usr/bin/env node
    console.log('hello world')
    
  • packageを構成する.json
    {
    	"bin": {
    	  "my-cli": "./index.js"
    	}
    }
    
  • npm linkテスト
    $ npm link #          my-cli   
    $ my-cli #        hello world   
    
    npm linkエラーを実行すると、npm_globalディレクトリの下の関連ファイルはすべて削除して
  • 試します
    3.推奨パッケージ返却ディレクトリ
    パッケージ名
    説明
    commander
    コマンドラインパラメータの操作
    inquirer
    コマンドラインインタラクションの処理
    chalk
    コマンドライン出力色の変更
    cross-spawn
    Node.jsのサブプロセス(child_process)モジュールの下にspawn関数のプラットフォーム間書き方がある
    envinfo
    出力環境情報
    fs-extra
    fsの拡張ライブラリ
    hyperquest
    httpリクエストをストリーム出力に変換
    semver
    バージョンのフォーマットと計算のライブラリ
    tar-pack
    圧縮と解凍
    tmp
    ユーザ一時ファイルリソースの管理は、tmp-promiseで代替できます.
    validate-npm-package-name
    パッケージのnameが合法かどうかをチェック
    リファレンスリンク