如何釋出一個npm包(基於vue)
前言：工作的時候總是使用別人的npm包，然而我有時心底會好奇自己如何釋出一個npm包呢，什麼時候自己的包能夠被很多人喜歡並使用呢...今天我終於邁出了第一步。
前提：會使用 npm，有 vue 基礎，瞭解一點 webpack
Are you ready? Go!
1. 新建一個空資料夾
2. 進入資料夾，終端(cmd)執行npm init
完成後會在目錄下生成一個 package.json 檔案
我們可以根據自己的需要補充檔案內容
這是我的：
1 {
2 "name": "bing-test-publish-npm",
3 "version": "1.0.0",
4 "description": "佈一個npm包",
5 "main": "index.js",
6 "scripts": {
7 "test": "echo \"Error: no test specified\" && exit 1",
8 "start": "webpack-dev-server --hot --inline",
9 "build": "webpack --display-error-details --config webpack.config.js"
10 },
11 "author": "bing",
12 "license": "ISC",
13 "devDependencies": {
14 "babel-core": "^6.26.0",
15 "babel-loader": "^7.1.2",
16 "babel-plugin-transform-object-rest-spread": "^6.26.0",
17 "babel-plugin-transform-runtime": "^6.23.0",
18 "babel-polyfill": "^6.26.0",
19 "babel-preset-es2015": "^6.24.1",
20 "css-loader": "^0.28.7",
21 "es6-promise": "^4.1.1",
22 "less": "^2.7.3",
23 "less-loader": "^4.0.5",
24 "style-loader": "^0.19.0",
25 "url-loader": "^0.6.2",
26 "vue": "^2.5.9",
27 "vue-hot-reload-api": "^2.2.4",
28 "vue-html-loader": "^1.2.4",
29 "vue-loader": "^13.5.0",
30 "vue-router": "^3.0.1",
31 "vue-style-loader": "^3.0.3",
32 "vue-template-compiler": "^2.5.9",
33 "vuex": "^3.0.1",
34 "webpack": "^3.9.1",
35 "webpack-dev-server": "^2.9.5"
36 }
37 }3. 配置完後，命令列執行npm install安裝依賴包，安裝完會生成一個node_modules目錄
4. 接下來新建兩個資料夾 src(開發目錄)，dist(釋出目錄)
5. 然後我們就可以在 src 目錄下編寫自己的元件吧
我的檔案目錄
app.vue
1 <template>
2 <div class="helloName">
3 <input type="text" placeholder="請輸入姓名" v-model="yourName"></input>
4 <div v-if="name">hello<span class="name">{{name}}!</span></div>
5 </div>
6 </template>
7 <script>
8 export default {
9 name:'helloName',
10 data () {
11 return {
12 yourName: ''
13 }
14 },
15 methods: {
16
17 },
18 created(){
19 }
20 }
21 </script>
22 <style>
23 </style>index.js
1 import helloName from './app.vue' 2 export default helloName
webpack.dev.conf.js
1 const path = require("path");
2 const webpack = require("webpack");
3 const uglify = require("uglifyjs-webpack-plugin");
4
5 module.exports = {
6 devtool: 'source-map',
7 entry: "./src/index.js",//入口檔案，src目錄下的index.js檔案，
8 output: {
9 path: path.resolve(__dirname, './dist'),//輸出路徑，就是新建的dist目錄，
10 publicPath: '/dist/',
11 filename: 'helloName.min.js',
12 libraryTarget: 'umd',
13 umdNamedDefine: true
14 },
15 module: {
16 rules: [{
17 test: /\.vue$/,
18 loader: 'vue-loader'
19 },
20 {
21 test: /\.less$/,
22 use: [
23 { loader: "style-loader" },
24 { loader: "css-loader" },
25 { loader: "less-loader" }
26 ]
27 },
28 {
29 test: /\.js$/,
30 exclude: /node_modules|vue\/dist|vue-router\/|vue-loader\/|vue-hot-reload-api\//,
31 loader: 'babel-loader'
32 },
33 {
34 test: /\.(png|jpg|gif|ttf|svg|woff|eot)$/,
35 loader: 'url-loader',
36 query: {
37 limit: 30000,
38 name: '[name].[ext]?[hash]'
39 }
40 }
41 ]
42 },
43 plugins: [
44 new webpack.DefinePlugin({
45 "process.env": {
46 NODE_ENV: JSON.stringify("production")
47 }
48 })
49 ]
50 }檔案寫好後，我們執行npm run build，結果是會在 dist 目錄下生成一個helloName.min.js，就是我們在 webpack.dev.conf.js 中filename的值
6. 將 package.json 中的main欄位指向新生成的 helloName.min.js
7. 新建一個.npmignore檔案（npm忽略檔案），可以把不需要釋出的檔案忽略，如果只有 .gitignore，沒有 .npmignore，則會使用 .gitignore
如：
.* *.md *.yml build/ node_modules/ src/ test/ gulpfile.js
1. 到 https://www.npmjs.com 註冊一個賬號
2. 進入你的專案根目錄，執行npm login
會輸入你的使用者名稱、密碼和郵箱
3. 登入成功後，執行npm publish，就釋出成功啦，我們可以在官網看到
接下來我們在其他專案中使用自己剛釋出的npm包
1. 我們進入我們的專案目錄執行npm(或cnpm)installbing-test-publish-npm(我們剛釋出的包)
2. 在需要使用此包的頁面引入，並使用
1 <template>
2 <div>
3 我的npm包
4 <helloName></helloName>
5 </div>
6 </template>
7 <script>
8 import helloName from 'bing-test-publish-npm'
9 export default {
10 name: 'npm',
11 data () {
12 return {
13 }
14 },
15 components: {
16 helloName
17 }
18 }
19 </script>
這時我發現我的控制檯報錯了，原來是編碼錯誤，因此，我們需要修改更新程式碼
<template>
<div class="helloName">
<input type="text" placeholder="請輸入姓名" v-model="yourName"></input>
<div v-if="yourName">hello<span class="name">{{yourName}}!</span></div>
</div>
</template>
<script>
export default {
name:'helloName',
data () {
return {
yourName: ''
}
},
methods: {
},
created(){
}
}
</script>
<style>
</style>
1. 修改完程式碼後，我們需要修改 package.json 的version版本
規則：對於"version":"x.y.z" 1.修復bug,小改動，增加z 2.增加了新特性，但仍能向後相容，增加y 3.有很大的改動，無法向後相容,增加x
2. 修改後 執行npm run build,npm publish就成功更新了包的版本
3. 使用時需要
解除安裝之前安裝的包 npmuninstallbing-test-publish-npm
重新安裝 npminstallbing-test-publish-npm
可通過 npmlistbing-test-publish-npm 檢視到版本已是最新的版本
主要參考文章
1. 如何製作併發佈一個vue的元件npm包？ https://blog.csdn.net/hamupp/article/details/79337643
2. package.json http://javascript.ruanyifeng.com/nodejs/packagejson.html
~~~~~~~~~~~~~~~~~~~~~~~我是簡樸又廉價的分割線~~~~~~~~~~~~~~
餅餅有話說：
寫的好辛苦呀說實話這個編輯器不咋好用。。
花了好半天寫文章，又花了一會修改文章格式，這次給自己認真程度打80分吧，想要寫一篇優秀的博文好不容易呀，我會繼續加油噠~~
如果覺得受用的話，可不可以給我點個贊呀，激勵這個拖延症患者~~