手把手教你写vue插件并发表到npm上

我查看了很多的教程都感觉不是很适合新手;今天我就来一步一步的教大家怎么把写好的插件发表到npm上;也记录一下免得自己那天忘了;文笔不是很好;如果表述不是很好的地方请谅解;废话不多说;现在开始

第一步;

创建这样结构的一个文件夹;
lib文件:中存放你想要写的逻辑
index.js 主要是引入文件并暴露出去
package.js主要是进行何种配置
README.json 文件主要是用来说明
在这里插入图片描述

第二步:

配置 index.js 文件
import vueTouch from ‘./lib/scrolls.vue’ // 这个就是你平时写的 SFC 组件

// 这里要导出一个包含 install 方法的对象
const plugin = { // 这里要导出一个 install 方法
  install (Vue, options) {
    // 这里写你的代码,你可以全局注册组件,也可以写全局指令,也可以扩展 Vue 的方法
    // 1. 全局组件
    Vue.component(vueTouch.name, vueTouch)
    // 2. 全局方法或属性
    Vue.myGlobalMethod = function () {
      // 逻辑...
    }
    // 3. 全局指令
    Vue.directive('my-directive', {
      bind (el, binding, vnode, oldVnode) {
        // 逻辑...
      }
    })
    // 4. 注入组件
    Vue.mixin({
      created: function () {
        // 逻辑...
      }
    })
    // 5. 添加实例方法
    Vue.prototype.$myMethod = function (methodOptions) {
      // 逻辑...
    }
  }
}
export default plugin

第三步:

配置package.json文件

{
  "name": "vue-zh-time", // npm包名
  "version": "1.0.1", // 版本
  "description": "vue plugins", 
  "main": "index.js",
  "directories": {
    "lib": "lib" // 源码文件
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "z", // 作者
  "license": "ISC"
}

第四步:发布

首先登陆;这儿主要输入你npm的账户和密码还有邮箱
npm login // 登陆
复制代码
登陆成功以后就可以发布了

npm publish // 发布

我自己写了一个公告栏滚动和定时器;都发布成功并且可以下载使用都没有问题;大家都可以去试试吧
滚动事件

npm i vue-zh-scroll

定时器

npm i vue-zh-time
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
好的,下面是一个简单的示例,展示如何编一个Vue3的npm插件: 1. 创建一个新的npm包并初始化 首先,创建一个新的目录,然后在该目录下运行以下命令来初始化npm包: ``` npm init -y ``` 这将创建一个package.json文件,其中包含有关您的npm包的信息。 2. 安装必要的依赖项 接下来,需要安装一些必要的依赖项,包括Vue3和rollup。运行以下命令: ``` npm install --save vue@next rollup rollup-plugin-commonjs rollup-plugin-node-resolve rollup-plugin-terser ``` Vue3是Vue.js的下一代版本,rollup是用于打包JavaScript的工具。 3. 创建插件代码 创建一个名为"index.js"的文件,该文件将包含您的插件代码。这里是一个简单的示例,它向Vue的全局对象添加了一个名为"myPlugin"的方法: ```js export function myPlugin() { console.log('Hello from myPlugin!'); } export default { install: (app) => { app.config.globalProperties.$myPlugin = myPlugin; }, }; ``` 4. 创建rollup配置文件 为了将您的插件打包到一个单独的JavaScript文件中,您需要创建一个名为"rollup.config.js"的文件。以下是一个示例配置文件: ```js import { terser } from 'rollup-plugin-terser'; import resolve from 'rollup-plugin-node-resolve'; import commonjs from 'rollup-plugin-commonjs'; export default { input: 'index.js', output: { file: 'dist/myPlugin.js', format: 'umd', name: 'myPlugin', }, plugins: [ resolve(), commonjs(), terser(), ], }; ``` 这将创建一个名为"dist/myPlugin.js"的文件,其中包含已打包的插件代码。 5. 编译和发布插件 最后,您需要使用rollup命令来编译插件代码,并使用npm命令将插件发布到npm仓库中: ``` npx rollup -c npm login npm publish ``` 现在,您的Vue3插件已经准备好使用了!在Vue应用程序中安装插件的方法如下: ```js import { createApp } from 'vue'; import myPlugin from 'my-plugin'; const app = createApp({}); app.use(myPlugin); app.mount('#app'); ``` 希望这个简单的示例可以帮助您开始编Vue3插件
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值