npm发布Vue组件

一、前言

        本文主要介绍如何把一个vue组件通过vite编译发布到NPM平台。

二、准备工作

        vue版本：^3.3.11

        node版本：v20.11.0

        npm版本：v10.2.4

        一个NPM平台账号

三、思路

        1、编写Vue组件

        2、把Vue组件提成一个插件

        3、编写编包脚本

        4、进行NPM发布

四、实现

        1、编写Vue组件

<template>
  <button class="btn">{
  {name}}</button>
</template>

<style scoped>
    .btn { color: 'blue' }
</style>
<script lang="ts">
export default {
  name: 'CunstomButton',
  props: ['text'],
  data() {
    return {}
  },
  mounted() {}
}
</script>

  注：此时的组件文件还在src文件里。

        2、把Vue组件提成一个插件

        把组件提到src平级的文件夹中packages中，并且创建一个index.ts文件（通过index.ts 统一管理发布的组件）

        编写index.ts把组件改写成插件的导入方式：

        方法一：

import CunstomButton from './components/CunstomButton.vue';

// 把需要导出的组件统一提到这个公共文件，在项目的main.ts中导入
const components = [CunstomButton];
export default (app: any) => {
    components.forEach(component => {
        app.component(component.name, component);
    });
}

        方法二：

// 通过index.ts 统一管理发布的组件
import CunstomButton from './components/CunstomButton.vue';
const myPlugin = {
    install: (app: any)=>{
        app.component('CunstomButton', CunstomButton);
    }
}

export default myPlugin;

        3、编写编包脚本

        与src平级创建一个build文件夹，增加一个lib.config.ts

import { defineConfig } from 'vite';
import {resolve} from 'path';
import vue from '@vitejs/plugin-vue'
 
export default defineConfig({
    build: {
        outDir: 'dist',
        lib: {
            entry: resolve(__dirname, '../packages/index.ts'),
            name: 'large-screen-dashboard', //对外暴露的组件名称
            fileName: (format)=> `large-screen-dashboard-${format}.js` //umd（require导入方式） es(import导入方式)
        },
        rollupOptions: {
            // 不进行打包的组件
            external: ['vue'],
            output: {
                //针对于umd模式下为外部化依赖提供一个全局的变量
                globals: {
                    vue: 'Vue' //对应exter里的vue， 对于UMD模式导入后，可以使用Vue.xxx
                }
            }
        },
    },
    // 插件:需要把哪些文件打包成一个库文件
    plugins: [vue({
        // 包括哪些文件
        include: [/\.vue$/]
    })]
})

五、进行NPM发布

        1、npm发布命令行

              2、遇见的问题记录