npm釋出屬於自己的開源模組
阿新 • • 發佈:2019-02-14
作為一個nodejs從業者,如果說不了解npm,那還真的說不過去。說來慚愧,我一直以為釋出npm模組是一件很高深的事情,於是在2014年初剛接觸的時候直接避開了。現在突然有了興趣,然後發現,比想象中的還要容易。截至目前,已經有201865 個package了。
今作此文,記錄之。
1. 註冊
首先,你得有個賬號 點選這裡 進行註冊。可以選擇釋出公有或者私有專案,但是私有專案是收費的,本著開源的精神,我還是選擇了公有。
2. 新增使用者
$ npm adduser
Username:
Password:
Email: (this IS public)
3. 初始化package
相信大家對package.json也不會陌生,裡面包含了整個專案的基本資訊。鍵入npm init,填寫相關資料即可。在這個過程中,可以配置git的相關資訊。我的package如下:
{ "name": "vinxent", "version": "1.0.3", "description": "test here", "main": "index.js", "scripts": { "test": "node ./test" }, "keywords": [ "test" ], "author": "vinxent", "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/vincentgor/npm-vinxent.git" }, "bugs": { "url": "https://github.com/vincentgor/npm-vinxent/issues" }, "homepage": "https://github.com/vincentgor/npm-vinxent#readme" }
4. 編寫屬於自己的模組
怎麼寫,隨便你。我只是在index.js隨便寫了個方法。
var vinxent = {};
// vinxent 測試
vinxent.test = function (argument) {
console.log('welcome to vinxent');
console.log(argument);
};
module.exports = vinxent;
5. 釋出
終於要到激動人心的釋出了。只要在這個專案根目錄下鍵入npm publish即可,npm會自動幫你釋出到npmjs.org上面。是不是簡單?沒錯,非常簡單。
6. 如何使用
在你的個人專案裡安裝這個模組。
npm install --save vinxent
然後
var vinxent = require('vinxent');
vinxent.test('hi');
然後,就沒有然後了。
7. 注意事項
釋出模組確實是非常簡單,但有些東西還是得說一下。首先,每更新發布一次,版本(version)必須比原有的要大,不然會發布新失敗。然後,想要更新package的相關資訊,只要再npm init一次即可。
8. 沒有了,洗洗睡。