如何发布自己的npm包(vue组件)

简介: 如何发布自己的npm包(vue组件)

请添加图片描述

如何在NPM上发布自己的第一个vue组件库,是每一名vue前端开发人员必经的进阶之路,本文将结合作者的实践项目,为各位读者详细讲解所有的操作步骤,相信你在阅读本文后,就能立马动手。

由于本文的主要目的是讲解如何创建组件库并发布到NPM,因此对于组件的创建会一笔带过。

1.创建项目

打开cmd在项目中输入一下命令初始化一个vue的项目,名称自定义

vue create app

在src的同级目录下新建一个名称为myComponents的组件库,如图所示
请添加图片描述

2.配置自己的项目

myComponents是新增的一个目录,默认不被webpack处理,所以需要在vue.config.js里面配置组件库,以便webpack编译,没有vue.config.js的话,就在目录下新建一个。并在vue.config.js填入一下内容

module.exports = defineConfig({
  transpileDependencies: true,
  configureWebpack: {
    devtool: 'source-map'
},
// 强制内联CSS
css: {
    extract: false
},
// 扩展 webpack 配置,使 components 加入编译
chainWebpack: config => {
    config.module
        .rule('js')
        .include
        .add('/myComponents')//这里根据你文件夹名称自定义,每个人不一样
        .end()
        .use('babel')
        .loader('babel-loader')
        .tap(options => {
            // 修改它的选项...
            return options
        })
}

})

3.编辑自定义组件库

请添加图片描述

  1. myComponents文件加下新建一个tinyMce文件夹(此文件夹即是你对组件的命名),同时,在此文件夹下新建一个src目录,src下创建的.vue文件最好保证与文件夹tinyMce命名一致。
  2. 分别在myComponents文件夹和tinyMce文件夹下新建index.js文件,这是他们的入口文件,注意路径如上图所示,不要弄错了。
  3. 要将所有的静态资源文件等等放入myComponents文件夹下,比如我就放在了assets目录下,因为外部的其他文件是不会被打包上传的。

tinyMce/src/tinymce.vue为例子,你们可以依照自己的组件名称进行对应的修改,代码如下:

import tinymce from './src/tinymce'

// 为组件提供 install 安装方法,供按需引入
tinymce.install = Vue => {
    Vue.component(tinymce.name, tinymce)
}

// 默认导出组件
export default tinymce

编写myComponents/index.js文件,对组件库进行导出。

import tinymce from './tinyMce/index'
const components = [
    tinymce
]
// 定义 install 方法,接收 Vue 作为参数。如果使用 use 注册插件,则所有的组件都将被注册
const install = Vue => {
    // 判断是否可以安装
    if (install.installed) return
        // 遍历注册全局组件
    components.map(component => Vue.component(component.name, component))
}
// 判断是否是直接引入文件
if (typeof window !== 'undefined' && window.Vue) {
    install(window.Vue)
}
export default {
    // 导出的对象必须具有 install,才能被 Vue.use() 方法安装
    install,
    // 以下是具体的组件列表
    tinymce
}

4.进行本地测试能否正常使用

请添加图片描述

如图在本地的src(注意不是tinyMce下的)下的main.js导入组件并使用,并在APP.vue里面直接使用自己的组件。请添加图片描述

并使用npm run serve运行查看能否运行成功

请添加图片描述

我成功了,接下来就可以来发布自己的npm包了

5.配置发布

在package.json的sript命令中新增一条编译组件库的命令

"lib": "vue-cli-service build --target lib --name landscape-components --dest lib myComponents/index.js"

执行编译命令 --- npm run lib

在这里插入图片描述

编译成功后,会得到一个lib文件夹如图所示

请添加图片描述

5.1配置package.json文件

参考如下

  "name": "chdemo_tinymce",//组件名称
  "version": "0.1.1",//版本号
  "private": false,//原来为true,要改成false,否则发布不出去
  "description": "tinymce富文本编辑器的插入文本图片等接口集成", //包的描述
  "main": "lib/landscape-components.umd.min.js", //入口文件
  "keywords": ["tinymce"],//关键词
  "author": { "name": "ymktchic" }, //作者

5.2添加.npmignore文件

这一步比较重要,旨在发布npm包的时候忽略不必要的文件上传,需要编译上传的只有lib文件夹,package.json,README.md这三个,其他的都可以忽略。

可以按照我的配置,配置如下

# 忽略目录
src
myComponents
node_modules
public
utils
# 忽略指定文件
vue.config.js
babel.config.js
*.map
jsconfig.json

6.发布自己的npm包

先在 npm 官网(https://www.npmjs.com/)上注册一个账号,注册过程略。此处注意注册完需要2FA六位动态码绑定,动态码每隔半分钟更新一次,此动态码用于发布,可以在个人Account里面去根据流程操作进行绑定。
请添加图片描述

登录

注册成功后,在输入npm login,一下要依次输入你的用户名,密码,邮箱和六位动态码

npm login

请添加图片描述

如果提示上图信息,便表示登录成功,接下来使用如下命令发布

如果没发布成功,可以尝试把原来使用淘宝镜像源的更换成官方源,因为淘宝是只读源

npm config set registry https://registry.npmjs.org
npm publish

如果提示输入--ocp的话,就再一次输入自己的六位动态码即可。

如果收到了npm发来的邮箱,便表示你发布成功啦。

请添加图片描述

下载使用

  1. 使用vue create app

新建一个项目 ,然后在项目下输入以下命令

npm install chdemo_tinymce//我的包是chdemo_tinymce,你们的是什么就填什么即可

如果安装不成功,依然是要换成官方镜像源,使用如下命令

npm config set registry https://registry.npmjs.org

如图,同样是在main.js中引入自己的文件
请添加图片描述
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hyeIPyLn-1656645076866)

然后在APP.vue里面自己使用,无需注册。

请添加图片描述
请添加图片描述

这样就大功告成啦!

感谢阅读,记录自己的踩坑经验,总结,希望帮到各位。
腾讯云服务器,65
在这里插入图片描述

目录
相关文章
|
2月前
|
JavaScript
在 Vue 中处理组件选项与 Mixin 选项冲突的详细解决方案
【10月更文挑战第18天】通过以上的分析和探讨,相信你对在 Vue 中使用 Mixin 时遇到组件选项与 Mixin 选项冲突的解决方法有了更深入的理解。在实际开发中,要根据具体情况灵活选择合适的解决方案,以确保代码的质量和可维护性。
110 7
|
25天前
|
缓存 JavaScript UED
Vue3中v-model在处理自定义组件双向数据绑定时有哪些注意事项?
在使用`v-model`处理自定义组件双向数据绑定时,要仔细考虑各种因素,确保数据的准确传递和更新,同时提供良好的用户体验和代码可维护性。通过合理的设计和注意事项的遵循,能够更好地发挥`v-model`的优势,实现高效的双向数据绑定效果。
126 64
|
25天前
|
前端开发 JavaScript 测试技术
Vue3中v-model在处理自定义组件双向数据绑定时,如何避免循环引用?
Web 组件化是一种有效的开发方法,可以提高项目的质量、效率和可维护性。在实际项目中,要结合项目的具体情况,合理应用 Web 组件化的理念和技术,实现项目的成功实施和交付。通过不断地探索和实践,将 Web 组件化的优势充分发挥出来,为前端开发领域的发展做出贡献。
29 8
|
25天前
|
JavaScript
在 Vue 3 中,如何使用 v-model 来处理自定义组件的双向数据绑定?
需要注意的是,在实际开发中,根据具体的业务需求和组件设计,可能需要对上述步骤进行适当的调整和优化,以确保双向数据绑定的正确性和稳定性。同时,深入理解 Vue 3 的响应式机制和组件通信原理,将有助于更好地运用 `v-model` 实现自定义组件的双向数据绑定。
|
1月前
|
存储 JavaScript 开发者
Vue 组件间通信的最佳实践
本文总结了 Vue.js 中组件间通信的多种方法,包括 props、事件、Vuex 状态管理等,帮助开发者选择最适合项目需求的通信方式,提高开发效率和代码可维护性。
|
1月前
|
存储 JavaScript
Vue 组件间如何通信
Vue组件间通信是指在Vue应用中,不同组件之间传递数据和事件的方法。常用的方式有:props、自定义事件、$emit、$attrs、$refs、provide/inject、Vuex等。掌握这些方法可以实现父子组件、兄弟组件及跨级组件间的高效通信。
|
2月前
|
缓存 JavaScript UED
Vue 的动态组件与 keep-alive
【10月更文挑战第19天】总的来说,动态组件和 `keep-alive` 是 Vue.js 中非常实用的特性,它们为我们提供了更灵活和高效的组件管理方式,使我们能够更好地构建复杂的应用界面。深入理解和掌握它们,以便在实际开发中能够充分发挥它们的优势,提升我们的开发效率和应用性能。
49 18
|
1月前
|
缓存 JavaScript UED
Vue 中实现组件的懒加载
【10月更文挑战第23天】组件的懒加载是 Vue 应用中提高性能的重要手段之一。通过合理运用动态导入、路由配置等方式,可以实现组件的按需加载,减少资源浪费,提高应用的响应速度和用户体验。在实际应用中,需要根据具体情况选择合适的懒加载方式,并结合性能优化的其他措施,以打造更高效、更优质的 Vue 应用。
|
2月前
|
JavaScript 安全 测试技术
vue封装组件发布到Npm
【10月更文挑战第17天】
|
2月前
|
前端开发 UED
vue3知识点:Suspense组件
vue3知识点:Suspense组件
39 4

推荐镜像

更多