npm 插件制作发布更新

最新推荐文章于 2025-02-12 19:49:41 发布

原创最新推荐文章于 2025-02-12 19:49:41 发布 · 2k 阅读

3 ·

CC 4.0 BY-SA版权

学习前端之javascript笔记同时被 3 个专栏收录

33 篇文章

订阅专栏

vue

29 篇文章

订阅专栏

node.js

21 篇文章

订阅专栏

本文介绍如何使用Vue.js创建一个自定义的Toast消息提示插件，包括从项目初始化到最终发布的全过程。涵盖Vue组件开发、Webpack配置、npm发布等关键技术点。

1，插件功能是一个消息弹窗效果如图

2，创建package

自己新建一个目录 view-toast-m-m

在 view-toast-m-m 目录下执行

npm init

会在目录下生成 package.json 文件

3，编写插件

新建目录 view-toast-m-m /src/lib

view-toast-m-m /src/lib 目录下创建 vue-toast.vue文件

<template>
    <section class="toast-container">
        <div class="toast" v-bind:class="[visible?'fade-in':'fade-out']">
            <span>{{message}}</span>
        </div>
    </section>
</template>
<style rel="stylesheet/scss" lang="scss">
    @keyframes fade-in{
        0%{
        opacity:0;
        transform:scale(0.7);
    }
    100%{
        opacity:1;
        transform:scale(1);
    }
    }
    @keyframes fade-out{
    0%{
        opacity:1;
        transform:scale(1);
    }
    100%{
        opacity:0;
        transform:scale(0.7);
    }
    }
    .toast-container {
        position: absolute;
        left: 0;
        top: 0;
        bottom: 0;
        right: 0;
        z-index: 2000;
        display: flex;
        justify-content: center;
        align-items: center;
    .toast {
        width: 180px;
        height: 60px;
        line-height: 60px;
        text-align: center;
        background-color: rgba(0, 0, 0, 0.62);
        border-radius: 10px;
        color: #fff;
    }
    .fade-in{
        animation-name: fade-in;
        animation-duration: 0.3s;
        animation-fill-mode: both;
    }
    .fade-out{
        animation-name: fade-out;
        animation-duration: 0.3s;
        animation-fill-mode: both;
    }
    }

</style>
<script>
    export default{
        data()
    {
        return {
            visible:false,
            message:''
        }
    }
    }
</script>

view-toast-m-m /src/lib 目录下创建 index.js 文件

import ToastComponent from './vue-toast.vue';

let Toast = {}
Toast.install = function (Vue,options) {//vue.use 的时候传入Vue

    var opt={//默认
        duration:3000
    }
    for(var key in options){//覆盖
        opt[key]=options[key];
    }

    Vue.prototype.$toast = function (message,option) {
        if(typeof  option=='object'){//覆盖
            for(var key in option){
                opt[key]=option[key];
            }
        }
        const ToastController = Vue.extend(ToastComponent);

        var instance=new ToastController().$mount(document.createElement("div"));

        instance.message=message;
        instance.visible=true;
        document.body.appendChild(instance.$el);//vue.$el
        setTimeout(()=>{
            instance.visible=false;
            document.body.removeChild(instance.$el);//vue.$el
        },opt.duration)
    }
    Vue.prototype.$toast['show'] = function (message,option) {//扩展
        Vue.prototype.$toast(message,option)
    }
}
if(window.Vue){
    Vue.use(Toast)
}
export default Toast;

4，配置 webpack 打包文件

在 view-toast-m-m 目录下创建 webpack.config.js

var path = require('path');
module.exports={
    entry:'./src/lib/app.js',
    output:{
        path: path.join(__dirname, 'dist/'),
        filename:'vue-toast-demo.js',
        libraryTarget:'umd',
        library:'VueToastDemo'
    },
    module:{
        rules:[
            {
                test:/\.vue$/,
                loader:'vue-loader',
                exclude:/node_modules/,
                options:{
                    loaders:{
                        'scss':'style-loader!css-loader!sass-loader'
                    }
                }
            },
            {
                test:/\.js$/,
                loader:'babel-loader',
                include:path.join(__dirname,'src'),
                exclude:/node_modules/
            }
        ]
    }
   
}

5，安装配置打包的依赖

解析 .vue 的依赖

npm i vue vue-loader vue-template-compiler --save

解析 .scss 的依赖

npm i node-sass sass-loader css-loader style-loader

解析 .js 的依赖

npm i babel-cli babel-core babel-loader babel-preset-env

安装 babel-preset-env 后在

view-toast-m-m 目录下创建 .babelrc 文件

{
    "presets":["env"]
}

然后就可以打包了

webpack

6，测试插件

目录 view-toast-m-m /src 下创建 index.html 文件

<!DOCTYPE html>
<html>
<head lang="en">
    <title>roast 实例</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script  type="text/javascript" src="../node_modules/vue/dist/vue.js"></script>
    <script  type="text/javascript" src="../dist/vue-toast-demo.js"></script>
</head>
<body>
<div id="app">
    <a href="javascript:;" @click="toast">点击弹出toast</a>
</div>
<script type="text/javascript">
    var app=new Vue({
        el: '#app',
        methods:{
            toast:function(){
                this.$toast.show("你好，yoyo")
            }
        }
    })
</script>
</body>
</html>

测试效果

7，准备发布

https://www.npmjs.com/signup

搜索一下你的包名有没有被占用

包名就是 package.json 里面的名字

被占用的话就去package.json 文件里面改

8，开始发布

npm adduser

按照提示输入 userName password Email

npm publish

就发布上去了

9，更新

找到 package.json 文件中的版本号小改动就将最后一位加1

{
  "name": "view-toast-m-m",
  "version": "1.0.1",
  "description": "a toast plugin for mobile",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "toast",
    "vue-toast"
  ],
  "author": "sukla",
  "license": "ISC",
  "dependencies": {
    "babel-cli": "^6.26.0",
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-preset-env": "^1.6.1",
    "css-loader": "^0.28.7",
    "node-sass": "^4.7.2",
    "sass-loader": "^6.0.6",
    "style-loader": "^0.19.1",
    "vue": "^2.5.13",
    "vue-loader": "^13.6.1",
    "vue-template-compiler": "^2.5.13",
    "webpack": "^3.1.0"
  }
}

然后重新发布

npm publish

就更新了

10，添加说明文件 README.md

目录 view-toast-m-m 下新建 README.md

#view-toast-m-m

a mobile toast plugin for vue.

## Usage

import VueToast from 'vue-toast-demo'

Vue.use(VueToast)

this.$toast.show("Hello,yoyo")

效果

玩的愉快！！！

npm 插件 制作 发布 更新

npm 插件制作发布更新