點擊下載
本文文檔

當前位置：首頁 - 科技 - 知識百科 - 正文

vue的todo-list組件怎么發布到npm

來源：懂視網責編：小采時間：2020-11-27 19:56:21

vue的todo-list組件怎么發布到npm

vue的todo-list組件怎么發布到npm:這次給大家帶來vue的todo-list組件怎么發布到npm，vue的todo-list組件發布到npm的注意事項有哪些，下面就是實戰案例，一起來看一下。前言最近幾個人合作完成了一個項目，發現有一些公用的基礎業務組件，可以提取出來，不僅方便大家在各自模塊直接引用，也可以

推薦度：

點擊下載本文 文檔為doc格式

導讀vue的todo-list組件怎么發布到npm:這次給大家帶來vue的todo-list組件怎么發布到npm，vue的todo-list組件發布到npm的注意事項有哪些，下面就是實戰案例，一起來看一下。前言最近幾個人合作完成了一個項目，發現有一些公用的基礎業務組件，可以提取出來，不僅方便大家在各自模塊直接引用，也可以

這次給大家帶來vue的todo-list組件怎么發布到npm，vue的todo-list組件發布到npm的注意事項有哪些，下面就是實戰案例，一起來看一下。

前言

最近幾個人合作完成了一個項目，發現有一些公用的基礎業務組件，可以提取出來，不僅方便大家在各自模塊直接引用，也可以在以后的項目中使用。想到了可不可以自己動手把組件打包發布到內部的npm上，避免以后小伙伴們的重復工作呢？于是乎，說干就干，在這里操練一下，寫個todo-list的vue組件案例。案例源碼：https://github.com/wuwhs/todoList

建立npm項目

1. 初始化npm項目

建一個文件夾（todoList），在這個文件夾路徑下打開cmd窗口，輸入指令npm init，前提是已經裝好了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)

提示輸入項目包名稱，這里的名稱將作為發布到npm上這個包的名稱，以后別人使用就可以直接import或require到項目中使用。

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

接下來提示輸入版本，這里的版本將作為發布到npm上這個包版本控制號，每次發布必須要改一下版本號，才允許發布，在這里作為第一個版本可以直接回車，默認是1.0.0。

version: (1.0.0)
description:

然后提示輸入描述信息，描述一下這個包的功能作用。于是輸入：

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

再者，提示整個項目的入口文件，這里是我們打包后的文件，打包后文件都放到dist目錄下，先設定生成的文件是todoList.min.js，于是：

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

接下來提示輸入測試命令、git倉庫，先不管，后面再詳細寫，回車默認空。

再提示輸入關鍵字，便于其他人在npm上搜索得到你寫的包，最后就是作者和認證，根據自己實際情況填。

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

這樣，一個npm項目就初始化完了。接下來，來發布一個已經打包好了的組件包（先為空的）到npm上。

發布包到npm上

首先需要有npm官網的一個注冊賬號，然后輸入npm adduser，依次輸入npm登錄賬號、密碼和注冊激活郵箱。這樣就輕松的登錄上了。（PS：在window的CMD窗口，輸入密碼時不顯示輸入密碼，盲輸入，確定后回車即可，這里被坑了一下）

$ 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

不過，好事多磨，可能事情沒有那么順利。

一個可能取的包名稱跟別人的重名了，這樣是不能上傳上去的，會提示你沒有權限發布這個包。

$ 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里改一下包名稱name，或者去npm官網搜一下你要取的名稱，有沒有同名，再回頭來改。

還有就是每次發布，沒改版本號。

$ 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里改一下版本號后發布。

把npm線路打通了，接下來就是打包輸出，上傳資源了。

webpack打包

組件寫好后，一般要借助自動化工具，將資源整合打包壓縮，提供一個入口文件，供別人直接引用。在這里，選用webpack來打包。

為了方便演示，寫一個vue官網上todo-list的例子，作為組件打包發布。

整個目錄結構

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

下面來分別說明文件內容：

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"
 }
}

主要安裝一些必要的依賴插件，如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中文官網

3. .babelrc文件

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

ES6轉化工具babel配置

4. main.js項目入口文件

import Vue from 'vue'
import App from './App.vue'
new Vue({
 el: '#app',
 render: h => h(App)
})

5. App.vue vue根組件

<template>
 <p id="app">
 Hello, todo-list!
 </p>
</template>
<script>
export default {
 name: 'app'
}
</script>

6. index.html 頁面

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

輸入命令npm install，所有依賴包安裝完成后，npm run dev，啟動成功。

PS：遇到一個坑，先用npm install感覺太慢了，于是斷掉了，用cnpm install，安裝完成后，啟動總是缺少這個依賴包，那個依賴包，沒完沒了，于是，把node_modules全刪了，重新cnpm install一氣呵成正常了。cnpm安裝會引入一些版本文件，前面npm已裝好的包沒有，于是就出現了報錯，找不到某某依賴包。

至此，打包工具webpack的基本配置就完成了，接下來就是寫vue組件了。

寫todo-list的vue組件

todo-list組件在很多地方都會作為一個案例使用，在這就直接模范vue官網的案例來寫了。

1. todoList.vue組件——列表

<template>
<p">
 <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>
</p>
</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組件——列表項

減小耦合度，把列表項單獨拿出來做一個組件。

<template>
<li>
 {{ title }}
 <button v-on:click="$emit('remove')">X</button>
</li>
</template>
<script>
export default {
 props: ['title']
}
</script>

3. App.vue根組件

將todo-list組件引入并掛載到根節點。

<template>
 <p id="app">
 <todo-list></todo-list>
 </p>
</template>
<script>
import TodoList from './components/todoList'
export default {
 name: 'app',
 components: {
 TodoList
 }
}
</script>

刷新瀏覽器，查看效果

OK，組件基本完成。

組件打包

前面已經驗證了，我們寫的todo-list組件沒問題了，要將這個組件獨立打包成一個文件。這時就需要更換一下入口文件了，把測試案例用的main.js換成index.js文件。

獨立組件入口文件 index.js

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

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

更改webpack配置 webpack.config.js

將入口文件更換成./src/index.js，文件出口路徑和名稱更換成package.json的main的路徑和名稱，這樣方便不調整npm的發布目錄。

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

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

測試打包好的文件

剛打包好的文件能不能直接使用，在發布到npm上之前先在本地測試一下。要測試方法很簡單，就是把跟組件引入的vue組件改成引入剛打包的文件。于是App.vue這樣改：

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

再改回測試案例入口，刷新瀏覽器，報錯！

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>

有點小奔潰，沒有渲染函數？難道自己打包出來的組件竟然不能用！后來查資料才知道，打包需要指定一種模塊輸出類型，可以是commonjs,AMD,script,UMD模式。在這里是寫插件，要采用UMD模式，即libraryTarget: 'umd'。于是webpack.config.js出口文件配置修改為：

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

再打包獨立組件，更新todoList.min.js文件，改回測試文件（entry: './src/main.js',）入口，npm run dev，刷新瀏覽器，成功！

發布和使用npm組件包

發布npm組件包

已經驗證了我們已經打包生成的todoList.min.js可以正常使用，接下來就可以發布到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.json的version，執行npm publish即可

$ npm publish
+ vue-todolist@1.0.3

使用npm組件包

發布成功后，這就是一個平常使用的插件了，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)

然后直接在頁面中引入使用。

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

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

相信看了本文案例你已經掌握了方法，更多精彩請關注Gxl網其它相關文章！

vue的todo-list組件怎么發布到npm

推薦度：

點擊下載本文 文檔為doc格式

標簽：如何 VUE 發布

熱門焦點

vue的todo-list組件怎么發布到npm

vue的todo-list組件怎么發布到npm

vue的todo-list組件怎么發布到npm

最新推薦

猜你喜歡

熱門推薦