vite-plugin-husky-helper

简化 git 规范配置。

安装

pnpm i vite-plugin-husky-helper -D

使用

建议在项目仓库 git 初始化后使用该插件进行初始化配置。

import {fileURLToPath, URL} from 'node:url'

import {defineConfig} from 'vite'
import vue from '@vitejs/plugin-vue'
import vueJsx from '@vitejs/plugin-vue-jsx'
import vueDevTools from 'vite-plugin-vue-devtools'
import {huskyHelper} from 'vite-plugin-husky-helper'


export default defineConfig({
    plugins: [
        vue(),
        vueJsx(),
        vueDevTools(),
        huskyHelper()
        /** 默认值如下
         * 本插件支持 npm 或 pnpm 进行安装，默认为 pnpm）
         */
        // huskyHelper({
        //     pm: 'pnpm'
        // })
    ]
})

说明

该插件用于简化 husky 的配置，而 husky 只有在 git 仓库中才能正确初始化，所以调用 husky 或 本插件 前请保证项目已经是一个 git 仓库了。插件工作流程是在 vite 启动过程中读取当前最新版本的 husky 等相关依赖，然后写入对应配置文件，避免总是去官网查相关依赖和配置文件，属于开发时依赖。项目下如果已存在 .husky 文件，则插件不会修改本地内容。

基本结构

├── .husky/                
│ ├── commit-msg             # git hook 脚本
│ └── pre-commit
├── .oxfmtrc.json            # oxfmt 配置文件
├── eslint.config.ts         # eslint 配置文件
├── czvinyl.config.ts        # commitizen 配置文件
├── commitlint.config.js     # commitlint 配置文件
├── vite.config.ts         
└── package.json