@cgzair/cgz-fabric 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 cgzjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# cgz-fabric
+
+fabric 是《信息技术部前端编码手册》的配套 CLI 工具，一键接入符合前端研发部门的编码规范，提高项目研发效率。
+
+## 使用
+
+安装
+
+```bash
+yarn add @cgzair/cgz-fabric -D
+```
+
+### 自动配置
+
+1.通过 `shell` 命令
+
+```bash
+npx fabric install
+```
+
+2.通过 `npm scripts`
+
+```json
+// package.json
+{
+  "scripts": {
+    "prepare": "fabric install"
+  }
+}
+```
+
+## IDE 插件配套集成
+
+推荐使用 `vscode` 作为开发工具，然后安装以下插件：
+
+1. ESLint，安装地址：<https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>
+
+2. Markdownlint，安装地址：<https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint>
+
+3. Prettier，安装地址：<https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode>
+
+4. Stylelint，安装地址：<https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint>
+
+## 可用选项
+
+帮助
+
+``` bash
+fabric -h
+```

package/lib/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+"use strict";var __awaiter=this&&this.__awaiter||function(e,a,c,s){return new(c=c||Promise)(function(r,t){function n(e){try{o(s.next(e))}catch(e){t(e)}}function i(e){try{o(s.throw(e))}catch(e){t(e)}}function o(e){var t;e.done?r(e.value):((t=e.value)instanceof c?t:new c(function(e){e(t)})).then(n,i)}o((s=s.apply(e,a||[])).next())})},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const path_1=__importDefault(require("path")),commander_1=require("commander"),cgz_core_1=require("cgz-core"),install_1=__importDefault(require("./scripts/install")),extension_1=__importDefault(require("./utils/extension")),cwd=process.cwd(),currentPkg=(0,cgz_core_1.getCurrentPkg)(path_1.default.resolve(__dirname,"../"));commander_1.program.version(currentPkg.version,"-v").description(currentPkg.name+" 是《信息技术部前端编码手册》的配套 CLI 工具，一键接入符合前端研发部门的编码规范，提高项目研发效率。"),commander_1.program.command("install").alias("i").description("交互式生成适用于当前项目的编码规范").option("--vsc","写入 .vscode 推荐配置").option("--ext","安装 vscode 推荐扩展").action(e=>__awaiter(void 0,void 0,void 0,function*(){e.ext?(0,extension_1.default)():yield(0,install_1.default)({cwd:cwd},e.vsc)})),commander_1.program.parse(process.argv);

package/lib/config/_commitlintrc.js.ejs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["cgz"],
+};

package/lib/config/_editorconfig.ejs

@@ -0,0 +1,23 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+tab_width = 2
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.json]
+indent_style = space
+indent_size = 2
+tab_width = 2
+
+[Makefile]
+indent_style = tab

package/lib/config/_eslintignore.ejs

@@ -0,0 +1,3 @@
+statics
+dist
+build

package/lib/config/_eslintrc.js.ejs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["<%= eslint === 'javascript' ? 'eslint-config-cgz' : `eslint-config-cgz/${eslint}` %>"<%_ if (prettier) { _%>, "prettier"<%_ } _%>],
+};

package/lib/config/_markdownlint.json.ejs

@@ -0,0 +1,5 @@
+<%_ if (markdownlint) { _%>
+{
+  "extends": "markdownlint-config-cgz"
+}
+<%_ } _%>

package/lib/config/_markdownlintignore.ejs

@@ -0,0 +1,5 @@
+<%_ if (markdownlint) {  _%>
+<%_ markdownLintIgnores.forEach((txt) => { _%>
+<%= txt %>
+<% }) %>
+<%_ } -%>

package/lib/config/_prettierrc.js.ejs

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require("prettier-config-cgz"),
+};

package/lib/config/_stylelintignore.ejs

@@ -0,0 +1,5 @@
+<%_ if (stylelint) { _%>
+<%_ stylelintIgnores.forEach((txt)=> { _%>
+<%= txt %>
+<% }) %>
+<%_ } -%>

package/lib/config/_stylelintrc.js.ejs

@@ -0,0 +1,5 @@
+<%_ if (stylelint) { _%>
+module.exports = {
+  extends: "stylelint-config-cgz",
+};
+<%_ } _%>

package/lib/config/_vscode/extensions.json.ejs

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "stylelint.vscode-stylelint",
+    "esbenp.prettier-vscode",
+    "mrmlnc.vscode-scss",
+    "DavidAnson.vscode-markdownlint"
+  ]
+}

package/lib/config/_vscode/settings.json.ejs

@@ -0,0 +1,52 @@
+{
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "vue"],
+  <%_ if (stylelint) { _%>
+  "stylelint.validate": [<%- stylelintExt.map((ext) => `"${ext.replace(/^\./, '')}"`).join(', ') %>],
+  <%_ } _%>
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true<%= stylelint || markdownlint ? ',' : '' %>
+    <%_ if (stylelint) { _%>
+    "source.fixAll.stylelint": true<%= markdownlint ? ',' : '' %>
+    <%_ } _%>
+    <%_ if (markdownlint) { _%>
+    "source.fixAll.markdownlint": true
+    <%_ } _%>
+  },
+  <%_ if (prettier) { _%>
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[less]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  <%_ } _%>
+  "editor.formatOnSave": <%= prettier ? 'true' : 'false' %>
+}

package/lib/constants/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MARKDOWN_LINT_IGNORE_PATTERN=exports.STYLELINT_IGNORE_PATTERN=exports.STYLELINT_FILE_EXT=exports.PROJECT_CATEGORYS=void 0,exports.PROJECT_CATEGORYS=[{name:"非 React、Vue、Node.js 的项目（JavaScript）",value:"javascript"},{name:"非 React、Vue、Node.js 的项目（TypeScript）",value:"typescript"},{name:"React 项目（JavaScript）",value:"react"},{name:"React 项目（TypeScript）",value:"typescript/react"},{name:"Vue 项目（JavaScript）",value:"vue"},{name:"Vue 项目（TypeScript）",value:"typescript/vue"},{name:"Node.js 项目（JavaScript）",value:"node"},{name:"Node.js 项目（TypeScript）",value:"typescript/node"},{name:"使用 ES5 及之前版本 JavaScript 的老项目",value:"es5"},{name:"uni-app 项目（JavaScript）",value:"uni-app"},{name:"uni-app 项目（TypeScript）",value:"typescript/uni-app"}],exports.STYLELINT_FILE_EXT=[".css",".scss",".less"],exports.STYLELINT_IGNORE_PATTERN=["build","statics","dist"],exports.MARKDOWN_LINT_IGNORE_PATTERN=["node_modules/","build","dist","statics"];

package/lib/index.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,a,u,s){return new(u=u||Promise)(function(e,i){function n(t){try{o(s.next(t))}catch(t){i(t)}}function r(t){try{o(s.throw(t))}catch(t){i(t)}}function o(t){var i;t.done?e(t.value):((i=t.value)instanceof u?i:new u(function(t){t(i)})).then(n,r)}o((s=s.apply(t,a||[])).next())})},__importDefault=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.init=void 0;const install_1=__importDefault(require("./scripts/install")),init=(t,i)=>__awaiter(void 0,void 0,void 0,function*(){return yield(0,install_1.default)(t,i)});exports.init=init;

package/lib/scripts/install.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(e,s,l,a){return new(l=l||Promise)(function(i,t){function n(e){try{o(a.next(e))}catch(e){t(e)}}function r(e){try{o(a.throw(e))}catch(e){t(e)}}function o(e){var t;e.done?i(e.value):((t=e.value)instanceof l?t:new l(function(e){e(t)})).then(n,r)}o((a=a.apply(e,s||[])).next())})},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const path_1=__importDefault(require("path")),execa_1=__importDefault(require("execa")),inquirer_1=__importDefault(require("inquirer")),cgz_core_1=require("cgz-core"),extension_1=__importDefault(require("../utils/extension")),generate_template_1=__importDefault(require("../utils/generate-template")),constants_1=require("../constants");let step=0;const handleEslint=()=>__awaiter(void 0,void 0,void 0,function*(){var e=(yield inquirer_1.default.prompt({type:"list",name:"type",message:`第 ${++step} 步，请选择项目类型：`,choices:constants_1.PROJECT_CATEGORYS}))["type"];return e}),handleStylelint=t=>__awaiter(void 0,void 0,void 0,function*(){var e=(yield inquirer_1.default.prompt({type:"confirm",name:"enable",message:`第 ${++step} 步，是否启用 stylelint（若没有样式文件则不需要）：`,default:t}))["enable"];return e}),handleMarkdownLint=()=>__awaiter(void 0,void 0,void 0,function*(){var e=(yield inquirer_1.default.prompt({type:"confirm",name:"enable",message:`第 ${++step} 步，是否启用 markdownlint：`,default:!0}))["enable"];return e}),handlePrettier=()=>__awaiter(void 0,void 0,void 0,function*(){var e=(yield inquirer_1.default.prompt({type:"confirm",name:"enable",message:`第 ${++step} 步，是否启用 Prettier 格式化代码（推荐始终开启）：`,default:!0}))["enable"];return e});exports.default=(i,n)=>__awaiter(void 0,void 0,void 0,function*(){var e=i.cwd||process.cwd(),t={};process.chdir(e),i.eslint&&constants_1.PROJECT_CATEGORYS.some(e=>e.value===i.eslint)?t.eslint=i.eslint:t.eslint=yield handleEslint(),"boolean"==typeof i.stylelint?t.stylelint=i.stylelint:t.stylelint=yield handleStylelint(!/node/.test(t.eslint)),"boolean"==typeof i.markdownlint?t.markdownlint=i.markdownlint:t.markdownlint=yield handleMarkdownLint(),"boolean"==typeof i.prettier?t.prettier=i.prettier:t.prettier=yield handlePrettier(),cgz_core_1.log.info(`第 ${++step} 步，配置 git commit 卡点`);try{execa_1.default.sync("npx",["husky","install"],{cwd:e}),execa_1.default.sync("npx",["husky","set",".husky/commit-msg",'npx --no-install commitlint --edit "$1"'],{cwd:e}),execa_1.default.sync("npx",["husky","set",".husky/pre-commit","npx --no-install lint-staged"],{cwd:e}),(0,cgz_core_1.setScripts)("commit","git-cz",e),(0,cgz_core_1.setScripts)("postinstall","husky install",e),(0,cgz_core_1.setConfig)("config",{commitizen:{path:"@commitlint/cz-commitlint"}},e),(0,cgz_core_1.setConfig)("lint-staged",{"*.{js,jsx,tsx,ts,vue}":"eslint --cache --fix","*.{scss,less,css}":"stylelint --fix --allow-empty-input","*.md":"markdownlint --fix","*.{js,jsx,tsx,ts,vue,scss,less,css,json,html}":"prettier --write"},e),cgz_core_1.log.success("配置 git commit 卡点成功")}catch(e){cgz_core_1.log.error(e),cgz_core_1.log.error("配置 git commit 卡点失败")}cgz_core_1.log.info(`第 ${++step} 步，写入编码规范配置文件`),(0,generate_template_1.default)(e,t,n),cgz_core_1.log.success("写入编码规范配置文件成功"),cgz_core_1.log.info(`第 ${++step} 步，安装vscode 扩展`),(0,extension_1.default)(e),cgz_core_1.log.result("初始化完成",path_1.default.resolve(__dirname,"../../"),!0)});

package/lib/utils/extension.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const fs_1=__importDefault(require("fs")),child_process_1=require("child_process"),path_1=__importDefault(require("path")),cgz_core_1=require("cgz-core");exports.default=(e=path_1.default.resolve(__dirname,"../../../"))=>{try{(0,child_process_1.execSync)("code -v")}catch(e){return cgz_core_1.log.info("当前系统暂未安装 vscode，扩展安装已跳过，更多请参考：https://code.visualstudio.com/")}JSON.parse(fs_1.default.readFileSync(path_1.default.resolve(__dirname,"../config/_vscode/extensions.json.ejs"),"utf-8")).recommendations.forEach(e=>{cgz_core_1.log.info(`安装 ${e} ...`),(0,child_process_1.execSync)("code --install-extension "+e),cgz_core_1.log.info(e+" 安装成功")}),(0,cgz_core_1.setScripts)("extension","fabric i --ext",e),cgz_core_1.log.info("写入 vscode 扩展 scripts 配置成功"),cgz_core_1.log.success("安装推荐 vscode 扩展成功")};

package/lib/utils/generate-template.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const path_1=__importDefault(require("path")),fs_1=__importDefault(require("fs")),cgz_core_1=require("cgz-core"),lodash_1=__importDefault(require("lodash")),glob_1=__importDefault(require("glob")),ejs_1=__importDefault(require("ejs")),constants_1=require("../constants"),mergeVSCodeConfig=(e,t)=>{if(!(0,cgz_core_1.isAccessSync)(e))return t;try{var r=JSON.parse(fs_1.default.readFileSync(e,"utf8")),s=JSON.parse(t);return JSON.stringify(lodash_1.default.mergeWith(r,s,(e,t)=>{if(Array.isArray(e)&&Array.isArray(t))return lodash_1.default.union(t.concat(e))}),null,2)}catch(e){return""}};exports.default=(t,r,e,s=path_1.default.resolve(__dirname,"../config"))=>{e=glob_1.default.sync(`${e?"_vscode":"**"}/*.ejs`,{cwd:s});(0,cgz_core_1.isAccessSync)(path_1.default.resolve(t,".vscode"))||fs_1.default.mkdirSync(path_1.default.resolve(t,".vscode"));for(const a of e){var _=path_1.default.resolve(t,a.replace(/\.ejs$/,"").replace(/^_/,"."));let e=ejs_1.default.render(fs_1.default.readFileSync(path_1.default.resolve(s,a),"utf8"),Object.assign({stylelintExt:constants_1.STYLELINT_FILE_EXT,stylelintIgnores:constants_1.STYLELINT_IGNORE_PATTERN,markdownLintIgnores:constants_1.MARKDOWN_LINT_IGNORE_PATTERN},r));(e=/^_vscode/.test(a)?mergeVSCodeConfig(_,e):e).trim()&&fs_1.default.writeFileSync(_,e,"utf8")}};

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@cgzair/cgz-fabric",
+  "version": "1.1.0",
+  "description": "A collection of configuration files containing prettier, eslint, stylelint, markdown",
+  "main": "lib/index.js",
+  "bin": {
+    "fabric": "./lib/cli.js"
+  },
+  "keywords": [
+    "cgz-fabric"
+  ],
+  "scripts": {
+    "build": "npm run copy && tsc",
+    "copy": "copyfiles -a -u 1 \"src/config/**\" lib",
+    "test": "jest",
+    "test-watch": "jest --watch",
+    "test:coverage": "nyc jest --coverage --forceExit"
+  },
+  "files": [
+    "lib",
+    "package.json",
+    "README.md",
+    "tsconfig.json"
+  ],
+  "author": "cgz",
+  "dependencies": {
+    "@babel/core": "^7.16.7",
+    "@babel/eslint-parser": "^7.16.5",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-decorators": "^7.16.7",
+    "@babel/preset-env": "^7.16.10",
+    "@babel/preset-react": "^7.16.7",
+    "@babel/preset-typescript": "^7.16.7",
+    "@cgzair/cgz-core": "^0.3.7",
+    "@cgzair/commitlint-config-cgz": "^1.1.0",
+    "@cgzair/eslint-config-cgz": "^1.1.0",
+    "@cgzair/markdownlint-config-cgz": "^1.1.0",
+    "@cgzair/prettier-config-cgz": "^1.1.0",
+    "@cgzair/stylelint-config-cgz": "^1.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "chalk": "4.1.2",
+    "commander": "^9.0.0",
+    "ejs": "^3.1.6",
+    "eslint-config-egg": "^11.0.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-react": "^7.28.0",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "eslint-plugin-vue": "^8.5.0",
+    "glob": "^7.2.0",
+    "inquirer": "^8.2.1",
+    "lint-staged": "^12.4.1",
+    "markdownlint-cli": "^0.31.1",
+    "vue-eslint-parser": "^8.3.0"
+  },
+  "devDependencies": {
+    "@types/ejs": "^3.1.0",
+    "@types/fs-extra": "^9.0.13",
+    "@types/glob": "^7.2.0",
+    "@types/inquirer": "^8.2.0",
+    "copyfiles": "^2.4.1",
+    "execa": "5.1.1",
+    "fs-extra": "^10.1.0",
+    "jest": "27.3.1",
+    "nyc": "^15.1.0",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.4.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "license": "MIT",
+  "gitHead": "ac4f859f68745c4250c8aab06047ce03b0de733e"
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "rootDir": "./src",
+    "baseUrl": "./src",
+    "outDir": "./lib",
+    "types": ["node", "jest"],
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "downlevelIteration": true,
+    "resolveJsonModule": true,
+    "declaration": false,
+    "strictNullChecks": true
+  },
+  "include": ["src"]
+}