您好,登錄后才能下訂單哦!
前提:1.會(huì)vue基礎(chǔ),以及vue的組件(官網(wǎng):https://cn.vuejs.org/v2/guide/components.html)相關(guān)的基礎(chǔ)。
因?yàn)楸疚闹饕侵v如何把一個(gè)vue組件做成npm包并發(fā)布。
分為2大步驟:
一.按照相應(yīng)格式寫我們的vue代碼(就如同寫一個(gè)jquery插件時(shí)、有其固定的格式一樣)。
二.發(fā)布到npm上的流程
一、書寫一個(gè)vue組件
不用腳手架,我們自己從頭開始做起,因?yàn)槟_手架會(huì)附帶很多沒用的東西。
就做一個(gè)最簡(jiǎn)單的vue組件:就是傳入用戶名字,頁(yè)面打印出‘hello,用戶名'的組件。
比如,我的預(yù)期目標(biāo)是其他vue項(xiàng)目中,npm install本組件后,可以如此使用該組件:
<template> <div class="index"> <div class="demo1"> <Msg :data="myData"></Msg> </div> </div> </template> <script> import Msg from 'npm-study-hamupp'; export default { components: { Msg }, data(){ return { myData: { name: '天天', country: 'china' } } } } </script>
然后網(wǎng)頁(yè)上會(huì)顯示:
OJBK,現(xiàn)在開搞:
1.新建一個(gè)空文件夾,進(jìn)入到根目錄下。執(zhí)行
npm init
初始化項(xiàng)目。然后會(huì)讓你填一些項(xiàng)目相關(guān)的信息,跟著提示填就是了。沒啥說(shuō)的。注意name不要和現(xiàn)有的其他npm包重名了,不然一會(huì)兒發(fā)Npm包的時(shí)候會(huì)失敗,可以先去npmjs.com搜一下有沒有重名的。
這一步完成后,會(huì)生成package.json文件。
2.由于本例是一個(gè)vue的組件包,而且使用了es6和webpack,所以在devDependencies字段中,應(yīng)該至少加入以下依賴:
package.json
{ "name": "npm-study-hamupp", "version": "1.0.3", "description": "", "main": "dist/helloMsg.min.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "start": "webpack-dev-server --hot --inline", "build": "webpack --display-error-details --config webpack.config.js" }, "repository": { "type": "git", "url": "git+https://github.com/hamuPP/npmStudy.git" }, "author": "", "license": "ISC", "bugs": { "url": "https://github.com/hamuPP/npmStudy/issues" }, "homepage": "https://github.com/hamuPP/npmStudy#readme", "devDependencies": { "babel-core": "^6.26.0", "babel-loader": "^7.1.2", "babel-plugin-transform-object-rest-spread": "^6.26.0", "babel-plugin-transform-runtime": "^6.23.0", "babel-polyfill": "^6.26.0", "babel-preset-es2015": "^6.24.1", "css-loader": "^0.28.7", "es6-promise": "^4.1.1", "less": "^2.7.3", "less-loader": "^4.0.5", "style-loader": "^0.19.0", "url-loader": "^0.6.2", "vue": "^2.5.9", "vue-hot-reload-api": "^2.2.4", "vue-html-loader": "^1.2.4", "vue-loader": "^13.5.0", "vue-router": "^3.0.1", "vue-style-loader": "^3.0.3", "vue-template-compiler": "^2.5.9", "vuex": "^3.0.1", "webpack": "^3.9.1", "webpack-dev-server": "^2.9.5" } }
這些依賴的用處分別都是啥,自己查。
3.執(zhí)行npm install,下載這些依賴包。
4.新建2個(gè)文件夾:dist和src,名字按照個(gè)人習(xí)慣吧。我習(xí)慣dist代表發(fā)布時(shí)的目錄,src是開發(fā)目錄。dist里面的js是到時(shí)候通過(guò)webpack打包后的文件。待會(huì)只會(huì)提交dist目錄到npm官網(wǎng)上,src不提交。
src里:我們比較常規(guī)的寫一個(gè)vue組件
樣式就不說(shuō)了,照常寫。
app.vue(寫法上也很常規(guī)):
<style scoped lang="less"> @import 'styles/common.less'; </style> <template> <div class="msg-wrapper"> <span>hello!</span> <span class="account">{{data.name}}</span> </div> </template> <script> export default { name:'Msg', data () { return {} }, props:{ data:{ type:Object } }, methods: { }, created(){ let that = this; } } </script>
index.js(這里的寫法就與普通vue項(xiàng)目有所不同了,主要要把它export出去):
import Msg from './app.vue' export default Msg;
5.加入webpack打包配置,并把src中的內(nèi)容打包進(jìn)dist目錄內(nèi):
根目錄下新增weppack.config.js文件
const path = require("path"); const webpack = require("webpack"); const uglify = require("uglifyjs-webpack-plugin"); module.exports = { devtool: 'source-map', entry: "./src/index.js",//入口文件,就是上步驟的src目錄下的index.js文件, output: { path: path.resolve(__dirname, './dist'),//輸出路徑,就是上步驟中新建的dist目錄, publicPath: '/dist/', filename: 'helloMsg.min.js', libraryTarget: 'umd', umdNamedDefine: true }, module: { rules: [{ test: /\.vue$/, loader: 'vue-loader' }, { test: /\.less$/, use: [ { loader: "style-loader" }, { loader: "css-loader" }, { loader: "less-loader" } ] }, { test: /\.js$/, exclude: /node_modules|vue\/dist|vue-router\/|vue-loader\/|vue-hot-reload-api\//, loader: 'babel-loader' }, { test: /\.(png|jpg|gif|ttf|svg|woff|eot)$/, loader: 'url-loader', query: { limit: 30000, name: '[name].[ext]?[hash]' } } ] }, plugins: [ new webpack.DefinePlugin({ "process.env": { NODE_ENV: JSON.stringify("production") } }) ] };
然后執(zhí)行npm run build,就會(huì)在dist目錄下生成helloMsg.min.js。這即是我們這個(gè)npm包的主文件。
6.修改package.json中的main字段中指向的主文件信息
package.json
{ ... "main": "dist/helloMsg.min.js",
7.新建一個(gè)文件,名為.npmignore,是不需要發(fā)布到npm的文件和文件夾,規(guī)則和.gitignore一樣。如果你的項(xiàng)目底下有.gitignore但是沒有.npmignore,那么會(huì)使用.gitignore里面的配置。
例如我的:
.npmignore
.* *.md *.yml build/ node_modules/ src/ test/ gulpfile.js
至此,一個(gè)npm組件包就做完了,剩下的,只是提交到npm官網(wǎng)去。
(如果要嚴(yán)謹(jǐn)點(diǎn),當(dāng)然還需要加入單元測(cè)試通過(guò)后再發(fā)包。。。但是。。。)
二、發(fā)布到npm上的流程
1.前提,得有個(gè)npm賬號(hào),沒有就新注冊(cè)一個(gè)賬號(hào),
https://www.npmjs.com/signup?utm_source=house&utm_medium=package%20page&utm_campaign=free%20orgs&utm_term=Sign%20up%20for%20npm
2.進(jìn)入到項(xiàng)目的根目錄下,運(yùn)行 npm login
它會(huì)讓你輸入你的用戶名,密碼和郵箱,若登錄成功,會(huì)顯示:
Logged in as 你的名字 on https://registry.npmjs.org/.
3.然后執(zhí)行npm publish,即可將這個(gè)npm包發(fā)布到npm官網(wǎng)上拉。
4.更新、發(fā)新包。
需要發(fā)新包時(shí),需要自己手動(dòng)修改package.json中的version版本號(hào),慣例是+1啦,比如1.0.0-->1.0.1。然后npm login,npm publish。即可。
三、結(jié)語(yǔ):
1.發(fā)包時(shí)的常見錯(cuò)誤:
name名重名、name名還有大寫字母。。。
2.本項(xiàng)目的git地址:
https://github.com/hamuPP/npmStudy,如果你對(duì)本文說(shuō)的不太明白,可以下載這個(gè)項(xiàng)目,自己隨便改一下app.vue里面的東西,然后修改package.json中的name和version(一定要改哦),提交到npm上試試
3.我還按照該項(xiàng)目結(jié)構(gòu),做了一個(gè)基于vue 的同步樹的npm組件包。
https://github.com/hamuPP/t-vue-tree
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持億速云。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。