Skip to content

@mt-kit/vite-plugins

npm versionGitHub starsGitHub issuesLicenseDocumentation

Vite 插件集合,提供库构建、TypeScript 类型生成等常用插件。

安装

bash
npm install @mt-kit/vite-plugins -D

TypeScript 类型生成

注意:直接内嵌到插件,无法使用,待修复。请使用 vite-plugin-dts

安装:

bash
npm i vite-plugin-dts -D

配置:

ts
import { defineConfig } from "vite";
import dts from "vite-plugin-dts";

export default defineConfig(() => ({
  plugins: [
    dts({
      tsconfigPath: "./tsconfig.json",
      rollupTypes: false,
      strictOutput: true,
      outDir: "dist",
      entryRoot: "./src"
    })
  ]
}));

相关文档: vite-plugin-dts

API

libPlugin

Vite 库构建插件,用于构建可发布的库文件。

参数:

属性名说明类型是否必传默认值
name输出 CommonJS 的文件名称stringlib-plugin
fileName打包的文件名stringindex
entry入口文件路径stringsrc/index.ts
external外部依赖列表string[]["path"]

package.json 配置:

字段说明对应文件
mainCommonJS 规范,也可在浏览器使用全局变量引用dist/index.umd.js
moduleES 模块规范dist/index.es.js
types类型声明文件dist/index.d.ts
exports多入口条件导出按模块类型映射路径

package.json 示例:

json
{
  "name": "demo",
  "version": "1.0.0",
  "description": "Demo",
  "type": "module",
  "scripts": {
    "clear:build": "rm -fr dist",
    "clear": "rm -fr node_modules && pnpm run clear:build",
    "build": "pnpm run clear:build && vite build",
    "dev": "vite build --watch"
  },
  "main": "dist/index.umd.js",
  "module": "dist/index.es.js",
  "types": "dist/index.d.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.es.js",
      "require": "./dist/index.umd.js"
    }
  }
}

vite.config.ts 示例:

ts
import { defineConfig } from "vite";
import { libPlugin } from '@mt-kit/vite-plugins';

export default defineConfig({
  plugins: [
    libPlugin()
  ]
});

基于 MIT 许可发布