最新文章專(zhuān)題視頻專(zhuān)題問(wèn)答1問(wèn)答10問(wèn)答100問(wèn)答1000問(wèn)答2000關(guān)鍵字專(zhuān)題1關(guān)鍵字專(zhuān)題50關(guān)鍵字專(zhuān)題500關(guān)鍵字專(zhuān)題1500TAG最新視頻文章推薦1 推薦3 推薦5 推薦7 推薦9 推薦11 推薦13 推薦15 推薦17 推薦19 推薦21 推薦23 推薦25 推薦27 推薦29 推薦31 推薦33 推薦35 推薦37視頻文章20視頻文章30視頻文章40視頻文章50視頻文章60 視頻文章70視頻文章80視頻文章90視頻文章100視頻文章120視頻文章140 視頻2關(guān)鍵字專(zhuān)題關(guān)鍵字專(zhuān)題tag2tag3文章專(zhuān)題文章專(zhuān)題2文章索引1文章索引2文章索引3文章索引4文章索引5123456789101112131415文章專(zhuān)題3
問(wèn)答文章1 問(wèn)答文章501 問(wèn)答文章1001 問(wèn)答文章1501 問(wèn)答文章2001 問(wèn)答文章2501 問(wèn)答文章3001 問(wèn)答文章3501 問(wèn)答文章4001 問(wèn)答文章4501 問(wèn)答文章5001 問(wèn)答文章5501 問(wèn)答文章6001 問(wèn)答文章6501 問(wèn)答文章7001 問(wèn)答文章7501 問(wèn)答文章8001 問(wèn)答文章8501 問(wèn)答文章9001 問(wèn)答文章9501
當(dāng)前位置: 首頁(yè) - 科技 - 知識(shí)百科 - 正文

vue todo-list組件發(fā)布到npm上的方法

來(lái)源:懂視網(wǎng) 責(zé)編:小采 時(shí)間:2020-11-27 22:17:03
文檔

vue todo-list組件發(fā)布到npm上的方法

vue todo-list組件發(fā)布到npm上的方法:前言 最近幾個(gè)人合作完成了一個(gè)項(xiàng)目,發(fā)現(xiàn)有一些公用的基礎(chǔ)業(yè)務(wù)組件,可以提取出來(lái),不僅方便大家在各自模塊直接引用,也可以在以后的項(xiàng)目中使用。想到了可不可以自己動(dòng)手把組件打包發(fā)布到內(nèi)部的npm上,避免以后小伙伴們的重復(fù)工作呢?于是乎,說(shuō)干就干,在這
推薦度:
導(dǎo)讀vue todo-list組件發(fā)布到npm上的方法:前言 最近幾個(gè)人合作完成了一個(gè)項(xiàng)目,發(fā)現(xiàn)有一些公用的基礎(chǔ)業(yè)務(wù)組件,可以提取出來(lái),不僅方便大家在各自模塊直接引用,也可以在以后的項(xiàng)目中使用。想到了可不可以自己動(dòng)手把組件打包發(fā)布到內(nèi)部的npm上,避免以后小伙伴們的重復(fù)工作呢?于是乎,說(shuō)干就干,在這

前言

最近幾個(gè)人合作完成了一個(gè)項(xiàng)目,發(fā)現(xiàn)有一些公用的基礎(chǔ)業(yè)務(wù)組件,可以提取出來(lái),不僅方便大家在各自模塊直接引用,也可以在以后的項(xiàng)目中使用。想到了可不可以自己動(dòng)手把組件打包發(fā)布到內(nèi)部的npm上,避免以后小伙伴們的重復(fù)工作呢?于是乎,說(shuō)干就干,在這里操練一下,寫(xiě)個(gè)todo-list的vue組件案例。案例源碼:https://github.com/wuwhs/todoList

建立npm項(xiàng)目

1. 初始化npm項(xiàng)目

建一個(gè)文件夾(todoList),在這個(gè)文件夾路徑下打開(kāi)cmd窗口,輸入指令npm init,前提是已經(jīng)裝好了node(自帶npm)。

$ npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
package name: (todolist)

提示輸入項(xiàng)目包名稱(chēng),這里的名稱(chēng)將作為發(fā)布到npm上這個(gè)包的名稱(chēng),以后別人使用就可以直接importrequire到項(xiàng)目中使用。

package name: (todolist) todolist
version: (1.0.0)

接下來(lái)提示輸入版本,這里的版本將作為發(fā)布到npm上這個(gè)包版本控制號(hào),每次發(fā)布必須要改一下版本號(hào),才允許發(fā)布,在這里作為第一個(gè)版本可以直接回車(chē),默認(rèn)是1.0.0。

version: (1.0.0)
description:

然后提示輸入描述信息,描述一下這個(gè)包的功能作用。于是輸入:

description: a vue component of todolist
entry point:(webpack.config.js)

再者,提示整個(gè)項(xiàng)目的入口文件,這里是我們打包后的文件,打包后文件都放到dist目錄下,先設(shè)定生成的文件是todoList.min.js,于是:

entry point:(webpack.config.js) ./dist/todoList.min.js
test command:
git repository:

接下來(lái)提示輸入測(cè)試命令、git倉(cāng)庫(kù),先不管,后面再詳細(xì)寫(xiě),回車(chē)默認(rèn)空。

再提示輸入關(guān)鍵字,便于其他人在npm上搜索得到你寫(xiě)的包,最后就是作者和認(rèn)證,根據(jù)自己實(shí)際情況填。

keywords: todolist vue
author: wuwhs
license: (ISC)
About to write to D:\WampServer\wamp\www\todoList\package.json:

{
 "name": "vue-todolist",
 "version": "1.0.0",
 "description": "a vue component of todolist",
 "main": "dist/todolist.min.js",
 "scripts": {
 "test": "echo \"Error: no test specified\" && exit 1"
 },
 "keywords": [
 "todolist",
 "vue"
 ],
 "author": "wuwhs",
 "license": "ISC"
}

Is this ok? (yes) yes

這樣,一個(gè)npm項(xiàng)目就初始化完了。接下來(lái),來(lái)發(fā)布一個(gè)已經(jīng)打包好了的組件包(先為空的)到npm上。

發(fā)布包到npm上

首先需要有npm官網(wǎng)的一個(gè)注冊(cè)賬號(hào),然后輸入npm adduser,依次輸入npm登錄賬號(hào)、密碼和注冊(cè)激活郵箱。這樣就輕松的登錄上了。(PS:在window的CMD窗口,輸入密碼時(shí)不顯示輸入密碼,盲輸入,確定后回車(chē)即可,這里被坑了一下)

$ npm adduser
Username: wuwhs
Password: balabala...
Email: (this IS public) balabala...
Logged in as wuwhs on https://registry.npmjs.org/.

最后,直接輸入指令publish即可大功告成。

$ npm publish
+ vue-todolist@1.0.0

不過(guò),好事多磨,可能事情沒(méi)有那么順利。

一個(gè)可能取的包名稱(chēng)跟別人的重名了,這樣是不能上傳上去的,會(huì)提示你沒(méi)有權(quán)限發(fā)布這個(gè)包。

$ npm publish
npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! You do not have permission to publish "vue-router". Are you logged in as the correct user? : vue-router

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Administrator\AppData\Roaming\npm-cache\_logs\2018-04-02T15_41_56_696Z-debug.log

解決方法:需要到package.json里改一下包名稱(chēng)name,或者去npm官網(wǎng)搜一下你要取的名稱(chēng),有沒(méi)有同名,再回頭來(lái)改。

還有就是每次發(fā)布,沒(méi)改版本號(hào)。

$ npm publish
npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! You cannot publish over the previously published versions: 1.0.1. : vue-todolist

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Administrator\AppData\Roaming\npm-cache\_logs\2018-04-02T15_40_28_571Z-debug.log

解決方法:需要到package.json里改一下版本號(hào)后發(fā)布。

把npm線(xiàn)路打通了,接下來(lái)就是打包輸出,上傳資源了。

webpack打包

組件寫(xiě)好后,一般要借助自動(dòng)化工具,將資源整合打包壓縮,提供一個(gè)入口文件,供別人直接引用。在這里,選用webpack來(lái)打包。

為了方便演示,寫(xiě)一個(gè)vue官網(wǎng)上todo-list的例子,作為組件打包發(fā)布。

整個(gè)目錄結(jié)構(gòu)

--todoList
 --src
 --components
 --todoItem.vue
 --todoList.vue
 --App.vue
 --index.js
 --main.js
 --index.html
 --webpack.config.js
 --package.json
 --.babelrc
 --.npmignore

下面來(lái)分別說(shuō)明文件內(nèi)容:

1. package.json文件

{
 "name": "vue-todolist",
 "description": "a vue component of todolist",
 "version": "1.0.0",
 "author": "wuwhs",
 "license": "MIT",
 "private": false,
 "main": "./dist/todoList.min.js",
 "scripts": {
 "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
 "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
 },
 "dependencies": {
 "vue": "^2.5.11"
 },
 "browserslist": [
 "> 1%",
 "last 2 versions",
 "not ie <= 8"
 ],
 "devDependencies": {
 "babel-core": "^6.26.0",
 "babel-loader": "^7.1.2",
 "babel-preset-env": "^1.6.0",
 "babel-preset-stage-3": "^6.24.1",
 "cross-env": "^5.0.5",
 "css-loader": "^0.28.7",
 "file-loader": "^1.1.4",
 "vue-loader": "^13.0.5",
 "vue-template-compiler": "^2.4.4",
 "webpack": "^3.6.0",
 "webpack-dev-server": "^2.9.1"
 }
}

主要安裝一些必要的依賴(lài)插件,如vue、babel和webpack

2. webpack.config.js文件

var path = require('path')
var webpack = require('webpack')

module.exports = {
 entry: './src/main.js',
 output: {
 path: path.resolve(__dirname, './dist'),
 publicPath: '/dist/',
 filename: 'build.js'
 },
 module: {
 rules: [
 {
 test: /\.css$/,
 use: [
 'vue-style-loader',
 'css-loader'
 ],
 }, 
 {
 test: /\.vue$/,
 loader: 'vue-loader',
 options: {
 loaders: {
 }
 // other vue-loader options go here
 }
 },
 {
 test: /\.js$/,
 loader: 'babel-loader',
 exclude: /node_modules/
 },
 {
 test: /\.(png|jpg|gif|svg)$/,
 loader: 'file-loader',
 options: {
 name: '[name].[ext]?[hash]'
 }
 }
 ]
 },
 resolve: {
 alias: {
 'vue$': 'vue/dist/vue.esm.js'
 },
 extensions: ['*', '.js', '.vue', '.json']
 },
 devServer: {
 historyApiFallback: true,
 noInfo: true,
 overlay: true
 },
 performance: {
 hints: false
 },
 devtool: '#eval-source-map'
}

if (process.env.NODE_ENV === 'production') {
 module.exports.devtool = '#source-map'
 module.exports.plugins = (module.exports.plugins || []).concat([
 new webpack.DefinePlugin({
 'process.env': {
 NODE_ENV: '"production"'
 }
 }),
 new webpack.optimize.UglifyJsPlugin({
 sourceMap: true,
 compress: {
 warnings: false
 }
 }),
 new webpack.LoaderOptionsPlugin({
 minimize: true
 })
 ])
}

webpack的基本熱更新以及打包配置,可以參考webpack中文官網(wǎng)

3. .babelrc文件

{
 "presets": [
 ["env", { "modules": false }],
 "stage-3"
 ]
}

ES6轉(zhuǎn)化工具babel配置

4. main.js項(xiàng)目入口文件

import Vue from 'vue'
import App from './App.vue'

new Vue({
 el: '#app',
 render: h => h(App)
})

5. App.vue vue根組件

<template>
 <div id="app">
 Hello, todo-list!
 </div>
</template>

<script>
export default {
 name: 'app'
}
</script>

6. index.html 頁(yè)面

<!DOCTYPE html>
<html lang="en">
 <head>
 <meta charset="utf-8">
 <title>todolist</title>
 </head>
 <body>
 <div id="app"></div>
 <script src="./dist/build.js"></script>
 </body>
</html>

輸入命令npm install,所有依賴(lài)包安裝完成后,npm run dev,啟動(dòng)成功。

PS:遇到一個(gè)坑,先用npm install感覺(jué)太慢了,于是斷掉了,用cnpm install,安裝完成后,啟動(dòng)總是缺少這個(gè)依賴(lài)包,那個(gè)依賴(lài)包,沒(méi)完沒(méi)了,于是,把node_modules全刪了,重新cnpm install一氣呵成正常了。cnpm安裝會(huì)引入一些版本文件,前面npm已裝好的包沒(méi)有,于是就出現(xiàn)了報(bào)錯(cuò),找不到某某依賴(lài)包。

至此,打包工具webpack的基本配置就完成了,接下來(lái)就是寫(xiě)vue組件了。

寫(xiě)todo-list的vue組件

todo-list組件在很多地方都會(huì)作為一個(gè)案例使用,在這就直接模范vue官網(wǎng)的案例來(lái)寫(xiě)了。

1. todoList.vue組件——列表

<template>
<div">
 <input
 v-model="newTodoText"
 v-on:keyup.enter="addNewTodo"
 placeholder="Add a todo"
 >
 <ul>
 <li
 is="todo-item"
 v-for="(todo, index) in todos"
 v-bind:key="todo.id"
 v-bind:title="todo.title"
 v-on:remove="todos.splice(index, 1)"
 ></li>
 </ul>
</div>
</template>

<script>
import TodoItem from './TodoItem'
export default {
 components: {
 TodoItem
 },
 data () {
 return {
 newTodoText: '',
 todos: [
 {
 id: 1,
 title: 'Do the dishes',
 }
 ],
 nextTodoId: 2
 }
 },
 methods: {
 addNewTodo: function () {
 this.todos.push({
 id: this.nextTodoId++,
 title: this.newTodoText
 })
 this.newTodoText = ''
 }
 }
}
</script>

2. todoList.vue組件——列表項(xiàng)

減小耦合度,把列表項(xiàng)單獨(dú)拿出來(lái)做一個(gè)組件。

<template>
<li>
 {{ title }}
 <button v-on:click="$emit('remove')">X</button>
</li>
</template>

<script>
export default {
 props: ['title']
}
</script>

3. App.vue根組件

將todo-list組件引入并掛載到根節(jié)點(diǎn)。

<template>
 <div id="app">
 <todo-list></todo-list>
 </div>
</template>

<script>
import TodoList from './components/todoList'
export default {
 name: 'app',
 components: {
 TodoList
 }
}
</script>

刷新瀏覽器,查看效果

OK,組件基本完成。

組件打包

前面已經(jīng)驗(yàn)證了,我們寫(xiě)的todo-list組件沒(méi)問(wèn)題了,要將這個(gè)組件獨(dú)立打包成一個(gè)文件。這時(shí)就需要更換一下入口文件了,把測(cè)試案例用的main.js換成index.js文件。

獨(dú)立組件入口文件 index.js

目的只是將要打包的組件引入。

import TodoList from './components/todoList.vue'

export default TodoList

更改webpack配置 webpack.config.js

將入口文件更換成./src/index.js,文件出口路徑和名稱(chēng)更換成package.jsonmain的路徑和名稱(chēng),這樣方便不調(diào)整npm的發(fā)布目錄。

module.exports = {
 entry: './src/index.js',
 output: {
 path: path.resolve(__dirname, './dist'),
 publicPath: '/dist/',
 filename: 'todoList.min.js'
 },
 ...
}

改好后,npm run build,打包組件,結(jié)果就在dist目錄下有了todoList.min.js文件。這就是打包組件后的文件。也是將要發(fā)布到npm上別人真正使用的入口文件。

測(cè)試打包好的文件

剛打包好的文件能不能直接使用,在發(fā)布到npm上之前先在本地測(cè)試一下。要測(cè)試方法很簡(jiǎn)單,就是把跟組件引入的vue組件改成引入剛打包的文件。于是App.vue這樣改:

<script>
import TodoList from '../dist/todoList.min.js'
export default {
 name: 'app',
 components: {
 TodoList
 }
}
</script>

再改回測(cè)試案例入口,刷新瀏覽器,報(bào)錯(cuò)!

vue.esm.js?3153:591 [Vue warn]: Failed to mount component: template or render function not defined.

found in

---> <TodoList>
 <App> at src\App.vue
 <Root>

有點(diǎn)小奔潰,沒(méi)有渲染函數(shù)?難道自己打包出來(lái)的組件竟然不能用!后來(lái)查資料才知道,打包需要指定一種模塊輸出類(lèi)型,可以是commonjs,AMD,script,UMD模式。在這里是寫(xiě)插件,要采用UMD模式,即libraryTarget: 'umd'。于是webpack.config.js出口文件配置修改為:

 output: {
 path: path.resolve(__dirname, './dist'),
 publicPath: '/dist/',
 filename: 'todoList.min.js',
 library: 'vueTodoList',
 libraryTarget: 'umd',
 umdNamedDefine: true
 }

再打包獨(dú)立組件,更新todoList.min.js文件,改回測(cè)試文件(entry: './src/main.js',)入口,npm run dev,刷新瀏覽器,成功!

發(fā)布和使用npm組件包

發(fā)布npm組件包

已經(jīng)驗(yàn)證了我們已經(jīng)打包生成的todoList.min.js可以正常使用,接下來(lái)就可以發(fā)布到npm上了,同樣npm跟git一樣,可以使用.npmignore忽略一些上傳文件,比如node_moudules就不要上傳上去了。

.DS_Store
node_modules/
npm-debug.log
yarn-error.log

# Editor directories and files
.idea
.editorconfig
*.suo
*.ntvs*
*.njsproj
*.sln

更改一下package.jsonversion,執(zhí)行npm publish即可

$ npm publish
+ vue-todolist@1.0.3

使用npm組件包

發(fā)布成功后,這就是一個(gè)平常使用的插件了,cnpm install vue-todolist --save即可安裝(使用npm或cnpm安裝均可)完成,

$ cnpm install vue-todolist --save
√ Installed 1 packages
√ Linked 1 latest versions
√ Run 0 scripts
Recently updated (since 2018-03-27): 1 packages (detail see file D:\appSoft\wampserver\wamp64\www\todoList\node_modules\.recently_updates.txt)
 Today:
 → vue-todolist@*(1.0.3) (11:15:22)
√ All packages installed (1 packages installed from npm registry, used 564ms, speed 528.68kB/s, json 2(281.56kB), tarball 16.62kB)

然后直接在頁(yè)面中引入使用。

在App.vue引入todolist組件,就不需要引入本地寫(xiě)的了,直接引入剛才安裝好的

<script>
import TodoList from 'vue-todolist'
export default {
 name: 'app',
 components: {
 TodoList
 }
}
</script>

再次運(yùn)行npm run dev,刷新瀏覽器,一切正常,good。

總結(jié)

至此,打包、發(fā)布和使用自己寫(xiě)的vue組件就完成了??偨Y(jié)一下這幾條需要關(guān)注:

  1. npm包配置(package.json)中,提供對(duì)外使用的入口文件最好跟打包后的文件一致,這樣打包完成后就可直接測(cè)試和發(fā)布;
  2. 每次發(fā)布要改版本號(hào);
  3. webpack配置文件出口要加庫(kù)輸出類(lèi)型libraryTarget: 'umd';
  4. 最好單獨(dú)用一個(gè)文件作為組件輸出打包,不要跟測(cè)試案例入口文件弄混;

聲明:本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com

文檔

vue todo-list組件發(fā)布到npm上的方法

vue todo-list組件發(fā)布到npm上的方法:前言 最近幾個(gè)人合作完成了一個(gè)項(xiàng)目,發(fā)現(xiàn)有一些公用的基礎(chǔ)業(yè)務(wù)組件,可以提取出來(lái),不僅方便大家在各自模塊直接引用,也可以在以后的項(xiàng)目中使用。想到了可不可以自己動(dòng)手把組件打包發(fā)布到內(nèi)部的npm上,避免以后小伙伴們的重復(fù)工作呢?于是乎,說(shuō)干就干,在這
推薦度:
標(biāo)簽: VUE 發(fā)布到 組件
  • 熱門(mén)焦點(diǎn)

最新推薦

猜你喜歡

熱門(mén)推薦

專(zhuān)題
Top