如何將自己寫的代碼同步到github併發布到npm

1. 很明顯，先註冊NPM和github賬號

過程省略，進入各自的官網，創建賬號

 

2. 寫代碼

默認你已經安裝了node環境，node環境也包括了npm環境

新建工程文件夾，然後執行下面的命令，初始化一個package.json文件

npm init -y

{
  "name": "a-string-is-null-empty-undefined",
  "version": "1.0.0",
  "description": "A package for judging a string is null or empty or undefined",
  "main": "index.js",
  "repository": "https://github.com/yorcent/string-is-null-empty-undefined.git",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "yorcent",
    "string",
    "isNullOrEmpty",
    "undefined"
  ],
  "author": "yorcentluo",
  "license": "ISC"
}

"main"這一項 是默認的js入口文件， 可以修改。

"repository"這一項暫時不填，一會你創建了對應的github倉庫再填進去對應的倉庫地址

新建index.js文件，編寫代碼，如：

const stringJudgement = {
    isNull (string) {
        return string === null
    },
    isEmpty (string) {
        return string === ''
    },
    isUndefined (string) {
        return string === undefined
    },
    isNullOrEmptyOrUndefined (string) {
        return string === null || string === '' || string === undefined
    }
}

module.exports = stringJudgement

新建test.js文件，如：

const stringJudgement = require('./index')

console.log(stringJudgement.isNullOrEmptyOrUndefined(''))

控制檯執行

node test

檢查執行結果，初步測試通過

注意： 一般如果你的npm包有比較方便的測試代碼或者用例，更能吸引開發者使用你發佈的npm包。所以，一個優秀的npm包還需要更完善的測試環境。這裏暫時不深入展示。

新建README.md文件

# stringJudgement
判斷一個字符串是否爲null, 或空字符串，或undefined

# install
npm install -g string-is-null-empty-undefined

#github

#usage
const stringJudgement = require('./index')
console.log(stringJudgement.isNullOrEmptyOrUndefined(''))

README.md文件 是方便開發者快速的瞭解和學習如何使用你這個npm包，非常重要。

3. 將代碼上傳至github倉庫

這個方法有三種，這裏使用其中一種。

1.1 新建git倉庫

1.2 將新建好的git倉庫地址克隆到本地

1.3 將之前創建的npm包的代碼文件夾丟到git倉庫克隆後的文件夾內，和.git文件在同一級目錄

1.4 執行以下命令

git add .

git commit -m "init commit"

git push

git push -u origin master

4.將github倉庫地址複製到npm包的package.json裏的“repository”中

"repository": "https://github.com/yorcent/string-is-null-empty-undefined.git",

5. 執行以下命令將完整和正確的代碼發佈到npm

npm login
// 輸入npm賬號名

// 輸入npm密碼

// 輸入npm郵箱

npm publish

6. 驗證發佈是否成功

首先npm publish 之後 會返回給你發佈包的名稱和版本

如果沒有返回則發佈失敗，需要重新發布；或者如果你又修改了代碼，重新發布的話你需要包的名字重新發布

然後你試着npm install -s packageName 檢查是否安裝到了node-modules目錄。然後你可以開始調用你的寫的方法

7. 踩坑

如果你將你的npm鏡像改成了淘寶鏡像，那麼需要將鏡像改回城 npm官方鏡像，然後再重新npm login, 否則會發布失敗。