Fork me on GitHub

npm 发布自己的组件库(一)

新建项目

使用vue-cli搭建项目脚手架。

1
2
3
npm install vue-cli -g
# cdcomponents 是本次项目名称
vue init webpack cdcomponents

规划pkg

由于要发布一个npm包,所以要修改 package.json 的 main 选项,表示当用户引入npm包的时候默认指向该文件。

1
"main": "dist/cdcomponents.min.js"

最终大概得到如下配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"name": "cdcomponents",
"version": "1.0.0",
"description": "A Vue.js project",
"author": "candyzheng <zp@suzper.com>",
// 由于是开源的npm包。所以需要设置private为false
"private": false,
"scripts": {
"dev": "node build/dev-server.js",
"start": "npm run dev",
"build": "node build/build.js",
"unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
"test": "npm run unit",
"lint": "eslint --ext .js,.vue src test/unit/specs"
},
// 表示发布包的时候需要携带的文件夹
"files": [
"dist",
"packages"
],
// 引入包的入口文件
"main": "dist/cdcomponents.min.js",
// 包描述页面来源
"homepage": "https://github.com/zp1112/cdcomponents#readme",
// 项目源码地址
"repository": {
"type": "git",
"url": "git@github.com:zp1112/cdcomponents.git"
},
// 提交issue的地址
"bugs": {
"url": "https://github.com/zp1112/cdcomponents/issues"
},
// 关键字
"keywords": [
"cdcomponents",
"vue"
],
"dependencies": {
...
},
"devDependencies": {
...
},
"engines": {
"node": ">= 4.0.0",
"npm": ">= 3.0.0"
},
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]
}

修改webpack

pkg规划好了,我们就要根据pkg来修改对应的webpack打包规则。主要配置入口文件和出口文件。

将webpack.base.conf.js中的入口文件改为./examples/main.js,用于展示文档使用

1
2
3
entry: {
app: './examples/main.js'
}

将webpack.prod.conf.js中的入口文件改为./packages/index.js,用于打包组件,修改output出口文件。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
entry: {
app: './packages/index.js'
},
output: {
path: config.build.assetsRoot,
publicPath: config.build.assetsPublicPath,
filename: 'cdcomponents.min.js',
library: 'CdComponents',
libraryTarget: 'umd'
},
plugins: [
...
// extract css into its own file
new ExtractTextPlugin({
filename: 'cdcomponents.min.css'
})
]

因此,后面需要新建两个文件夹的分别为examples和packages。

组件文件夹

项目根目录下新建组件文件夹packages,packages里面新建index.js入口文件

1
2
3
mkdir packages
cd packages
touch index.js

假设写好了一个count组件,那么index.js内容则为:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import Count from './count'
const components = [
Count
]
// 导出 install 函数
// Vue.use() 会调用这个函数
const install = function (Vue) {
// 如果安装过就忽略
if (install.installed) return
// 指定组件 name
components.map(component => Vue.component(component.name, component))
}
// 自动安装 方便打包成压缩文件, 用<script scr=''></script>的方式引用
if (typeof window !== 'undefined' && window.Vue) {
install(window.Vue)
}
// 把模块导出
export default {
install,
Count
}

组件count示例

新建文件夹count,在count里面新建index.js,同事新建src,src里面新建count.vue。

count.vue内容为

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<template>
<div class="cd__count">
<div>
<slot name="prefix"></slot>
<span ref="target" :style="countStyle"></span>
<slot name="suffix"></slot>
</div>
</div>
</template>
<script type="text/babel">
import CountUp from 'countup'
export default {
name: 'CdCount',
props: {
duration: {
type: Number,
default: 0
},
endVal: {
type: Number,
default: 0
},
startVal: {
type: Number,
default: 0
},
options: {
type: Object,
default: () => ({
useEasing: true,
useGrouping: true,
separator: ',',
decimal: '.',
prefix: '',
suffix: ''
})
},
countStyle: {
type: Object
}
},
data () {
return {
myStartVal: 0
}
},
watch: {
'endVal' (val) {
this.startCount()
this.myStartVal = val
}
},
mounted () {
this.myStartVal = this.startVal
this.startCount()
},
computed: {
},
methods: {
startCount () {
const { decimals } = this.options
const demo = new CountUp(this.$refs.target, this.myStartVal, this.endVal, decimals, this.duration, this.options)
if (!demo.error) {
demo.start()
} else {
this.$message({
message: demo.error,
type: 'error'
})
}
}
}
}
</script>

index.js文件是为了可以单独引用组件,内容为

1
2
3
4
5
6
7
8
import Count from './src/count.vue'
/* istanbul ignore next */
Count.install = function (Vue) {
Vue.component(Count.name, Count)
}
export default Count

这里就写好了一个简单的从组件count.vue到入口文件index.js的过程。下面我们在examples里面引用试试

theme-default文件夹

为了能更好的解决样式冲突,我们需要一套可以分离处理的样式,可以自行编译,可以相互不污染,使用bem语法是普遍的选择。

在packages文件夹下面新建theme-default文件夹,使用gulp和postcss来编译样式文件,学习elementui的做法。这里我就不多说了。。。。

examples示例demo

根目录下新建examples文件夹,examples里面新建main.js(此处的main.js对应了webpack.base.conf.js中的entry入口文件),这里的文件结构就可以像写一般的页面一样组织了。具体可以看源码https://github.com/zp1112/cdcomponents.

examples文件夹基本可以作为一个文档页面来组织组件的展示。下下一篇再讲。下一篇先讲如何发布。

-------------本文结束感谢您的阅读-------------
如果您觉得受益了,欢迎打赏鼓励。