{"_id":"@codegenius/git-user-plugin","_rev":"3-22bc553f354598e453db85a43f8d222b","name":"@codegenius/git-user-plugin","dist-tags":{"latest":"0.0.4"},"versions":{"0.0.1":{"name":"@codegenius/git-user-plugin","version":"0.0.1","description":"基于 CodeGenius 的 git-user 插件","author":{"name":"OSpoon","email":"zxin088@gmail.com","url":"https://github.com/OSpoon"},"license":"MIT","homepage":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin#readme","repository":{"type":"git","url":"git+https://github.com/FE-CodeGenius/codegenius-git-user-plugin.git"},"bugs":{"url":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin/issues"},"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"dist/index.cjs","module":"dist/index.mjs","types":"dist/index.d.ts","engines":{"node":">=14.17"},"scripts":{"prepare":"esno scripts/prepare.ts","build":"rollup -c","release":"release-it"},"keywords":[],"devDependencies":{"@release-it/conventional-changelog":"^7.0.2","@rollup/plugin-terser":"^0.4.4","@rollup/plugin-typescript":"^11.1.5","@types/fs-extra":"^11.0.2","@typescript-eslint/eslint-plugin":"^6.7.4","code-genius":"^0.4.31","eslint-plugin-simple-import-sort":"^10.0.0","esno":"^0.17.0","release-it":"^16.2.1","rollup":"^4.0.2","rollup-plugin-clear":"^2.0.7","rollup-plugin-typescript2":"^0.36.0","simple-git-hooks":"^2.9.0"},"simple-git-hooks":{"pre-commit":"npx esno scripts/lint-script.ts","commit-msg":"codeg verify"},"gitHead":"f9059d38cea13ec7b7c421fb8b579836515745ca","_id":"@codegenius/git-user-plugin@0.0.1","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-y7UpEZZc94qqxEce+sAkHvv78hYvzMFHk/+e5HBuTsBzM03IH6+stGfpWcyYrTH1v+z4juAEGoypDf4NLHTh2g==","shasum":"c1911b8c27fb4c0e12aaff24d2b22055d0e4a862","tarball":"https://registry.npmjs.org/@codegenius/git-user-plugin/-/git-user-plugin-0.0.1.tgz","fileCount":6,"unpackedSize":7999,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC5LOr6MxSar5tbplf2zP26KCxk0cyER/BLcCCV0l79tQIgDa/6bmCbWL361U1fVW+pBIasDMcDNkDMLi3kU8VHuo8="}]},"_npmUser":{"name":"zhangxin_n22","email":"1825203636@qq.com"},"directories":{},"maintainers":[{"name":"zhangxin_n22","email":"1825203636@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/git-user-plugin_0.0.1_1696735783773_0.19202478286453184"},"_hasShrinkwrap":false},"0.0.2":{"name":"@codegenius/git-user-plugin","version":"0.0.2","description":"基于 CodeGenius 的 git-user 插件","author":{"name":"OSpoon","email":"zxin088@gmail.com","url":"https://github.com/OSpoon"},"license":"MIT","homepage":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin#readme","repository":{"type":"git","url":"git+https://github.com/FE-CodeGenius/codegenius-git-user-plugin.git"},"bugs":{"url":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin/issues"},"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"dist/index.cjs","module":"dist/index.mjs","types":"dist/index.d.ts","engines":{"node":">=14.17"},"scripts":{"prepare":"esno scripts/prepare.ts","build":"rollup -c","release":"release-it"},"keywords":[],"devDependencies":{"@release-it/conventional-changelog":"^7.0.2","@rollup/plugin-terser":"^0.4.4","@rollup/plugin-typescript":"^11.1.5","@types/fs-extra":"^11.0.2","@typescript-eslint/eslint-plugin":"^6.7.4","code-genius":"^0.4.31","eslint-plugin-simple-import-sort":"^10.0.0","esno":"^0.17.0","release-it":"^16.2.1","rollup":"^4.0.2","rollup-plugin-clear":"^2.0.7","rollup-plugin-typescript2":"^0.36.0","simple-git-hooks":"^2.9.0"},"simple-git-hooks":{"pre-commit":"npx esno scripts/lint-script.ts","commit-msg":"codeg verify"},"gitHead":"08474c313e264e7607707427bafb1f54c79e0f8f","_id":"@codegenius/git-user-plugin@0.0.2","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-Mg7SYVbtoXSk8l2jh/vsym4frXs9wB7ql9HvrUrPGuxz2xoonAWKyaji1TYsRGXItGAulyvHgw04jnhe6WHJ2Q==","shasum":"488bdeed36340b44d6a3c88d74abf8c437f4de81","tarball":"https://registry.npmjs.org/@codegenius/git-user-plugin/-/git-user-plugin-0.0.2.tgz","fileCount":7,"unpackedSize":9669,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG9DofibXWOVDaPjJNHwtu8RDiuRf/oMqxF7ZOAVw8HgAiEA6dO7WoYEkWUH9PTqU06Ra1fVIcmpes4aZHvUuVqRHu8="}]},"_npmUser":{"name":"zhangxin_n22","email":"1825203636@qq.com"},"directories":{},"maintainers":[{"name":"zhangxin_n22","email":"1825203636@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/git-user-plugin_0.0.2_1696757273586_0.841832296512359"},"_hasShrinkwrap":false},"0.0.3":{"name":"@codegenius/git-user-plugin","version":"0.0.3","description":"基于 CodeGenius 的 git-user 插件","author":{"name":"OSpoon","email":"zxin088@gmail.com","url":"https://github.com/OSpoon"},"license":"MIT","homepage":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin#readme","repository":{"type":"git","url":"git+https://github.com/FE-CodeGenius/codegenius-git-user-plugin.git"},"bugs":{"url":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin/issues"},"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"dist/index.cjs","module":"dist/index.mjs","types":"dist/index.d.ts","engines":{"node":">=14.17"},"scripts":{"prepare":"npx codeg hooks","build":"rollup -c","release":"dotenv release-it --ci"},"keywords":[],"devDependencies":{"@codegenius/format-plugin":"^0.0.3","@codegenius/git-user-plugin":"^0.0.2","@codegenius/hooks-plugin":"^0.1.0","@codegenius/impsort-plugin":"^0.0.2","@codegenius/verify-plugin":"^0.0.1","@release-it/conventional-changelog":"^7.0.2","@rollup/plugin-terser":"^0.4.4","@rollup/plugin-typescript":"^11.1.5","@types/fs-extra":"^11.0.2","@typescript-eslint/eslint-plugin":"^6.7.4","code-genius":"^0.4.32","dotenv-cli":"^7.3.0","eslint-plugin-simple-import-sort":"^10.0.0","esno":"^0.17.0","release-it":"^16.2.1","rollup":"^4.0.2","rollup-plugin-clear":"^2.0.7","rollup-plugin-typescript2":"^0.36.0","simple-git-hooks":"^2.9.0"},"simple-git-hooks":{"pre-commit":"npx esno scripts/lint-script.ts","commit-msg":"npx codeg verify"},"gitHead":"a45c323ebffc7f5cc826a0c3f5308081f406f537","_id":"@codegenius/git-user-plugin@0.0.3","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-NXc3oyFpIKycQWcBNvJr+bayQhmDJOU5kCcnaN5pc/X9ctfwBr6gVa9iXwNmZ66qa/2FvN+3ihBc//WV1hLJNw==","shasum":"e29626f360aa971934683976d9882a1b26945f80","tarball":"https://registry.npmjs.org/@codegenius/git-user-plugin/-/git-user-plugin-0.0.3.tgz","fileCount":7,"unpackedSize":10029,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEPadm+HoUTPLF/bCnBNndYgodYzfIeNpL5ExA9/2p36AiEA3x1n4uzzSLq0vXEa8ygPEJT2TVT1tU6pmtZMUGg0PBw="}]},"_npmUser":{"name":"zhangxin_n22","email":"1825203636@qq.com"},"directories":{},"maintainers":[{"name":"zhangxin_n22","email":"1825203636@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/git-user-plugin_0.0.3_1696834002281_0.7530444060962882"},"_hasShrinkwrap":false},"0.0.4":{"name":"@codegenius/git-user-plugin","version":"0.0.4","description":"基于 CodeGenius 的 git-user 插件","author":{"name":"OSpoon","email":"zxin088@gmail.com","url":"https://github.com/OSpoon"},"license":"MIT","homepage":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin#readme","repository":{"type":"git","url":"git+https://github.com/FE-CodeGenius/codegenius-git-user-plugin.git"},"bugs":{"url":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin/issues"},"publishConfig":{"registry":"https://registry.npmjs.org","access":"public"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"dist/index.cjs","module":"dist/index.mjs","types":"dist/index.d.ts","engines":{"node":">=14.17"},"scripts":{"prepare":"npx codeg hooks","build":"rollup -c","release":"dotenv release-it --ci"},"keywords":[],"devDependencies":{"@codegenius/format-plugin":"^0.0.3","@codegenius/git-user-plugin":"^0.0.2","@codegenius/hooks-plugin":"^0.1.0","@codegenius/impsort-plugin":"^0.0.2","@codegenius/verify-plugin":"^0.0.1","@release-it/conventional-changelog":"^7.0.2","@rollup/plugin-terser":"^0.4.4","@rollup/plugin-typescript":"^11.1.5","@types/fs-extra":"^11.0.2","@typescript-eslint/eslint-plugin":"^6.7.4","code-genius":"^0.4.36","dotenv-cli":"^7.3.0","eslint-plugin-simple-import-sort":"^10.0.0","esno":"^0.17.0","release-it":"^16.2.1","rollup":"^4.0.2","rollup-plugin-clear":"^2.0.7","rollup-plugin-typescript2":"^0.36.0","simple-git-hooks":"^2.9.0"},"simple-git-hooks":{"pre-commit":"npx esno scripts/lint-script.ts","commit-msg":"npx codeg verify"},"gitHead":"43051156a735c9f55ea422d7e6187de0ecd3671a","_id":"@codegenius/git-user-plugin@0.0.4","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-tGfAAwkol9vmQoFcB5Ushja7zAtt2vhhVIKwjcxvfBB5zfW1XdNPfioog1w51Jt3Sqdn6M/VlDgrOHNo32FdzQ==","shasum":"d658d4dc56747baf8f7c3a0d915baad48e87e5d8","tarball":"https://registry.npmjs.org/@codegenius/git-user-plugin/-/git-user-plugin-0.0.4.tgz","fileCount":7,"unpackedSize":10200,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA5+ulLfGnJhugrujXIu8b8rSjuR4X1IAengUAUCAW/GAiAj56EDOwnyYxYHGdwRLcqYMHR6LN5B0pROxH+5xCgt4g=="}]},"_npmUser":{"name":"zhangxin_n22","email":"1825203636@qq.com"},"directories":{},"maintainers":[{"name":"zhangxin_n22","email":"1825203636@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/git-user-plugin_0.0.4_1696928552112_0.7809484553741934"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-08T03:29:43.643Z","0.0.1":"2023-10-08T03:29:43.983Z","modified":"2023-10-10T09:02:32.501Z","0.0.2":"2023-10-08T09:27:53.783Z","0.0.3":"2023-10-09T06:46:42.463Z","0.0.4":"2023-10-10T09:02:32.276Z"},"maintainers":[{"name":"zhangxin_n22","email":"1825203636@qq.com"}],"description":"基于 CodeGenius 的 git-user 插件","homepage":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/FE-CodeGenius/codegenius-git-user-plugin.git"},"author":{"name":"OSpoon","email":"zxin088@gmail.com","url":"https://github.com/OSpoon"},"bugs":{"url":"https://github.com/FE-CodeGenius/codegenius-git-user-plugin/issues"},"license":"MIT","readme":"# @codegenius/git-user-plugin\n\n设置或校验 `git user` 信息是否规范, 支持命令模式和 **API** 模式;\n\n使用场景: 用于校验那些不应该出现的邮箱地址会名称出现在 `git` 提交记录中, 常见的使用公司内部邮箱提交 `github` 的开源项目, 这通常是不允许的.\n\n## 安装\n\n```bash\nnpm i @codegenius/git-user-plugin -D\n```\n\n```javascript\nimport { defineConfig } from \"code-genius\";\nimport { gitUserInstaller } from \"@codegenius/git-user-plugin\";\n\nexport default defineConfig({\n  plugins: [\n    gitUserInstaller({\n      ruleEmail: \"^[a-zA-Z0-9._%+-]+@(gmail)\\\\.(com)$\",\n    }),\n  ],\n});\n```\n\n## 使用\n\n### 命令模式\n\n```bash\n# 在默认规则下设置 email 信息\ncodeg gituser -e zxin088@gmail.com\n\n# 在指定规则下设置 email 信息\ncodeg gituser -e zxin088@qq.com --rule-email '^[a-zA-Z0-9._%+-]+@(qq)\\.(com)$'\n```\n\n```bash\n# 在默认规则下校验 user 和 email 信息\ncodeg gituser\n\n# 在指定规则下校验 user 和 email 信息\ncodeg gituser --rule-email '^[a-zA-Z0-9._%+-]+@(qq)\\.(com)$'\n```\n\n| 选项                    | 描述                                 |\n| ----------------------- | ------------------------------------ |\n| -n, --name \\<name\\>     | 设置 user.name                       |\n| -e, --email \\<email\\>   | 设置 user.email                      |\n| --rule-name \\<regexp\\>  | 设置 user.name 匹配规则(转义字符串)  |\n| --rule-email \\<regexp\\> | 设置 user.email 匹配规则(转义字符串) |\n\n- **--rule-name 默认 :** `[\\s\\S]*`\n- **--rule-email 默认 :** `^[a-zA-Z0-9._%+-]+@(163|qq|126|139|sina|sohu|yeah|gmail)\\.(com|net)$`\n\n### API 模式\n\n```typescript\nimport { setGitUserName, setGitUserEmail, checkGitUserInfo } from \"@codegenius/git-user-plugin\";\n\n(async () => {\n  await setGitUserName(\"OSpoon\", \"[\\\\s\\\\S]*\");\n  await setGitUserEmail(\n    \"zxin088@gmail.com\",\n    \"^[a-zA-Z0-9._%+-]+@(gmail)\\\\.(com)$\"\n  );\n  await checkGitUserInfo(\"[\\\\s\\\\S]*\", \"^[a-zA-Z0-9._%+-]+@(gmail)\\\\.(com)$\");\n})();\n```\n","readmeFilename":"README.md"}