@gx-design-vue/create-gx-cli 0.0.4 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gx-design-vue/create-gx-cli",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "description": "a cli to bootstrap gx project",
   "main": "src/index.js",

package/src/main.js

@@ -92,6 +92,7 @@ export async function createProject(options) {
     // 下载git代码
     download(`direct:${downloadGit.git}`, root, { clone: true }, async function(err) {
       if (err) {
+        console.log(err)
         spinner.error({ text: '下载失败' })
       } else {
         await editPackageJson(root, options.projectName || getProjectName())

package/template-design-pro/.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+charset=utf-8
+end_of_line=lf
+insert_final_newline=true
+indent_style=space
+indent_size=2
+max_line_length = 100
+
+[*.{yml,yaml,json}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

package/template-design-pro/.env

@@ -0,0 +1,2 @@
+# 是否使用动态主题（确定好主题后，请将此变量设置为false，否则css会引入全量）
+VITE_USE_THEME = true

package/template-design-pro/.env.development

@@ -0,0 +1,18 @@
+# 实际执行环境 development
+VITE_NODE_ENV= development
+
+# environment 代码环境
+VITE_USE_MODE = development
+
+# 是否开启mock
+VITE_USE_MOCK = true
+
+# 是否删除console
+VITE_DROP_CONSOLE = false
+
+# api前缀
+VITE_BASE_URL=/api
+
+# oss信息
+VITE_OSS_BUCKET = oss-*
+VITE_OSS_ORIGIN = oss-cn-*

package/template-design-pro/.env.pro

@@ -0,0 +1,32 @@
+# 实际执行环境 production
+VITE_NODE_ENV= production
+
+# environment 代码环境
+VITE_USE_MODE = production
+
+# 是否开启mock
+VITE_USE_MOCK = true
+
+# 是否删除console
+VITE_DROP_CONSOLE = false
+
+# Whether to enable gzip or brotli compression
+# Optional: gzip | brotli | none
+# If you need multiple forms, you can use `,` to separate
+VITE_BUILD_COMPRESS = 'none'
+
+# 使用压缩时是否删除源文件，默认为false
+VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE = false
+
+# 是否使用pwa
+VITE_USE_PWA = false
+
+# 是否为打包后的文件提供传统浏览器兼容性支持
+VITE_LEGACY = false
+
+# api前缀
+VITE_BASE_URL=/mock-server
+
+# oss信息
+VITE_OSS_BUCKET = oss-*
+VITE_OSS_ORIGIN = oss-cn-*

package/template-design-pro/.env.production

@@ -0,0 +1,32 @@
+# 实际执行环境 test
+VITE_NODE_ENV= test
+
+# environment 代码环境
+VITE_USE_MODE = test
+
+# 是否开启mock
+VITE_USE_MOCK = true
+
+# 是否删除console
+VITE_DROP_CONSOLE = false
+
+# Whether to enable gzip or brotli compression
+# Optional: gzip | brotli | none
+# If you need multiple forms, you can use `,` to separate
+VITE_BUILD_COMPRESS = 'none'
+
+# 使用压缩时是否删除源文件，默认为false
+VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE = false
+
+# 是否使用pwa
+VITE_USE_PWA = false
+
+# 是否为打包后的文件提供传统浏览器兼容性支持
+VITE_LEGACY = false
+
+# api前缀
+VITE_BASE_URL=/mock-server
+
+# oss信息
+VITE_OSS_BUCKET = oss-*
+VITE_OSS_ORIGIN = oss-cn-*

package/template-design-pro/.env.test

@@ -0,0 +1,20 @@
+VITE_NODE_ENV=production
+# Whether to open mock
+VITE_USE_MOCK = true
+
+# Delete console
+VITE_DROP_CONSOLE = true
+
+# Whether to enable gzip or brotli compression
+# Optional: gzip | brotli | none
+# If you need multiple forms, you can use `,` to separate
+VITE_BUILD_COMPRESS = 'none'
+
+# Whether to delete origin files when using compress, default false
+VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE = false
+
+# use pwa
+VITE_USE_PWA = false
+
+# Is it compatible with older browsers
+VITE_LEGACY = false

package/template-design-pro/.eslintignore

@@ -0,0 +1,16 @@
+
+*.sh
+node_modules
+*.md
+*.woff
+*.ttf
+.vscode
+.idea
+dist
+/public
+/docs
+.husky
+.local
+.history
+/bin
+Dockerfile

package/template-design-pro/.eslintrc.js

@@ -0,0 +1,64 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    node: true,
+    es6: true,
+  },
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    jsxPragma: 'React',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  extends: [
+    'plugin:vue/vue3-recommended',
+    'plugin:@typescript-eslint/recommended'
+  ],
+  rules: {
+    'vue/script-setup-uses-vars': 'error',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    'vue/custom-event-name-casing': 'off',
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      },
+    ],
+    'no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      },
+    ],
+    'space-before-function-paren': 'off',
+
+    'vue/attributes-order': 'off',
+    'vue/one-component-per-file': 'off',
+    'vue/html-closing-bracket-newline': 'off',
+    'vue/max-attributes-per-line': 'off',
+    'vue/multiline-html-element-content-newline': 'off',
+    'vue/singleline-html-element-content-newline': 'off',
+    'vue/attribute-hyphenation': 'off',
+    'vue/require-default-prop': 'off',
+    'vue/require-explicit-emits': 'off',
+    'vue/html-self-closing': 0,
+    'vue/multi-word-component-names': 'off',
+  },
+};

package/template-design-pro/.gitpod.yml

@@ -0,0 +1,6 @@
+tasks:
+  - init: npm i -g pnpm && pnpm install && pnpm run build
+    command: pnpm run dev
+ports:
+  - port: 3000
+    onOpen: open-preview

package/template-design-pro/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+git add .

package/template-design-pro/.prettierignore

@@ -0,0 +1,9 @@
+/dist/*
+.local
+.output.js
+/node_modules/**
+
+**/*.svg
+**/*.sh
+
+/public/*

package/template-design-pro/.stylelintignore

@@ -0,0 +1,3 @@
+/dist/*
+/public/*
+public/*

package/template-design-pro/.yarnclean

@@ -0,0 +1,48 @@
+# test directories
+__tests__
+test
+tests
+powered-test
+
+# asset directories
+docs
+doc
+website
+images
+assets
+
+# examples
+example
+examples
+
+# code coverage directories
+coverage
+.nyc_output
+
+# build scripts
+Makefile
+Gulpfile.js
+Gruntfile.js
+
+# configs
+appveyor.yml
+circle.yml
+codeship-services.yml
+codeship-steps.yml
+wercker.yml
+.tern-project
+.gitattributes
+.editorconfig
+.*ignore
+.eslintrc
+.jshintrc
+.flowconfig
+.documentup.json
+.yarn-metadata.json
+.travis.yml
+
+# misc
+*.md
+
+!istanbul-reports/lib/html/assets
+!istanbul-api/node_modules/istanbul-reports/lib/html/assets

package/template-design-pro/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 gx12358
+
+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/template-design-pro/README.md

@@ -0,0 +1,111 @@
+<div align="center"> <a href="https://gitee.com/gx12358/vite-admin-pro"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://zbbf9-hw.ahtv.cn/ahtv-obs/20210811/d5b6f8d7-b759-243d-b8f3-906a6b8570bf.png"> </a> <br> <br>
+
+<h1>GX Pro Admin（Ant Design Vue）</h1>
+</div>
+
+## 简介
+
+GX Pro Admin 是一个免费开源的中后台模版。使用了最新的`vue3.0+`,`vite2`,`TypeScript`, `Ant Design Vue3.0+`等主流技术开发，开箱即用的中后台前端解决方案，也可用于学习参考。
+
+## 特性
+
+- **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发
+- **TypeScript**: 应用程序级 JavaScript 的语言
+- **主题**：可配置的主题
+- **Mock 数据** 内置 Mock 数据方案
+- **权限** 内置完善的动态路由权限生成方案
+- **组件** 二次封装了多个常用的组件
+
+## 预览
+
+- [🚀 pro 版演示地址](http://121.36.16.172:9000/gx.pro.admin)
+
+测试账号: admin/123456
+
+## 准备
+
+- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
+- [Vite](https://vitejs.dev/) - 熟悉 vite 特性
+- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
+- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
+- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
+- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
+- [Ant-Design-Vue](https://next.antdv.com/components/overview-cn/) - ui 基本使用
+- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
+
+## 安装使用
+
+- 获取项目代码
+
+```bash
+git clone https://gitee.com/gx12358/vite-admin-pro
+```
+
+- 安装依赖
+
+```bash
+cd gx-admin-pro
+
+yarn install
+
+```
+
+- 运行
+
+```bash
+yarn serve
+```
+
+- 打包
+
+```bash
+yarn build
+```
+
+## Git 贡献提交规范
+
+- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
+
+  - `feat` 增加新功能
+  - `fix` 修复问题/BUG
+  - `style` 代码风格相关无影响运行结果的
+  - `perf` 优化/性能提升
+  - `refactor` 重构
+  - `revert` 撤销修改
+  - `test` 测试相关
+  - `docs` 文档/注释
+  - `chore` 依赖更新/脚手架配置修改等
+  - `workflow` 工作流改进
+  - `ci` 持续集成
+  - `types` 类型定义文件更改
+  - `wip` 开发中
+
+## 浏览器支持
+
+本地开发推荐使用`Chrome 80+` 浏览器
+
+支持现代浏览器, 不支持 IE
+
+## 相关仓库
+
+如果这些插件对你有帮助，可以给一个 star 支持下
+
+- [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - 用于 html 模版转换及压缩
+- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) - 用于组件库样式按需引入
+- [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - 用于打包压缩图片资源
+- [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - 用于打包输出.gz|.brotil 文件
+- [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - 用于快速生成 svg 雪碧图
+
+## 维护者
+
+[@gx12358](https://gitee.com/gx12358)
+
+## 交流
+
+`GX-ADMIN-PRO` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。
+
+- QQ 群 `871430530`
+
+## License
+
+[MIT © gx12358-2021](./LICENSE)

package/template-design-pro/build/constant.ts

@@ -0,0 +1,6 @@
+/**
+ * The name of the configuration file entered in the production environment
+ */
+export const GLOB_CONFIG_FILE_NAME = '_app.config.js'
+
+export const OUTPUT_DIR = 'dist'

package/template-design-pro/build/generate/generateModifyVars.ts

@@ -0,0 +1,18 @@
+import { getThemeVariables } from 'ant-design-vue/dist/theme'
+import { resolve } from 'path'
+import config from '../../config/config'
+
+export function generateModifyVars(viteEnv: ViteEnv) {
+  const { VITE_USE_THEME } = viteEnv
+
+  const modifyVars = getThemeVariables()
+
+  const modifyVarsParams = {
+    ...modifyVars,
+    hack: `${modifyVars.hack} @import (reference) "${resolve('src/design/config.less')}";`
+  }
+
+  if (!VITE_USE_THEME) modifyVarsParams['primary-color'] = config.theme.primaryColor
+
+  return modifyVarsParams
+}

package/template-design-pro/build/getConfigFileName.ts

@@ -0,0 +1,13 @@
+/**
+ * Get the configuration file variable name
+ * @param env
+ */
+import config from '../config/config'
+
+const { shortName } = config.defaultSettings
+
+export const getConfigFileName = (_: RecordType) => {
+  return `__PRODUCTION__${shortName || '__APP'}__CONF__`
+    .toUpperCase()
+    .replace(/\s/g, '')
+}

package/template-design-pro/build/script/buildConf.ts

@@ -0,0 +1,44 @@
+/**
+ * Generate additional configuration files when used for packaging. The file can be configured with some global variables, so that it can be changed directly externally without repackaging
+ */
+import { GLOB_CONFIG_FILE_NAME, OUTPUT_DIR } from '../constant'
+import fs, { writeFileSync } from 'fs-extra'
+import chalk from 'chalk'
+
+import { getRootPath, getEnvConfig } from '../utils'
+import { getConfigFileName } from '../getConfigFileName'
+
+import pkg from '../../package.json'
+
+function createConfig(
+  {
+    configName,
+    config,
+    configFileName = GLOB_CONFIG_FILE_NAME
+  }: { configName: string; config: any; configFileName?: string } = { configName: '', config: {} }
+) {
+  try {
+    const windowConf = `window.${configName}`
+    // Ensure that the variable will not be modified
+    const configStr = `${windowConf}=${JSON.stringify(config)};
+      Object.freeze(${windowConf});
+      Object.defineProperty(window, "${configName}", {
+        configurable: false,
+        writable: false,
+      });
+    `.replace(/\s/g, '')
+    fs.mkdirp(getRootPath(OUTPUT_DIR))
+    writeFileSync(getRootPath(`${OUTPUT_DIR}/${configFileName}`), configStr)
+
+    console.log(chalk.cyan(`✨ [${pkg.name}]`) + ` - configuration file is build successfully:`)
+    console.log(chalk.gray(OUTPUT_DIR + '/' + chalk.green(configFileName)) + '\n')
+  } catch (error) {
+    console.log(chalk.red('configuration file configuration file failed to package:\n' + error))
+  }
+}
+
+export function runBuildConfig() {
+  const config = getEnvConfig()
+  const configFileName = getConfigFileName(config)
+  createConfig({ config, configName: configFileName })
+}

package/template-design-pro/build/script/postBuild.ts

@@ -0,0 +1,25 @@
+// #!/usr/bin/env node
+import chalk from 'chalk'
+import reSetRootHtml from './reSetRootHtml'
+import { runBuildConfig } from './buildConf'
+import { wrapperEnv, getEnvConfig } from '../utils'
+
+import pkg from '../../package.json'
+
+export const runBuild = async () => {
+  try {
+    const argvList = process.argv.splice(2)
+
+    // Generate configuration file
+    if (!argvList.includes('disabled-config')) {
+      await runBuildConfig()
+    }
+
+    !wrapperEnv(getEnvConfig()).VITE_USE_THEME && reSetRootHtml('ant-design-vue')
+    console.log(`✨ ${chalk.cyan(`[${pkg.name}]`)}` + ' - build successfully!')
+  } catch (error) {
+    console.log(chalk.red('vite build error:\n' + error))
+    process.exit(1)
+  }
+}
+runBuild()

package/template-design-pro/build/script/reSetRootHtml.ts

@@ -0,0 +1,20 @@
+import chalk from 'chalk'
+import fs, { readFileSync } from 'fs-extra'
+import { getRootPath } from '../utils'
+import { OUTPUT_DIR } from '../constant'
+
+import pkg from '../../package.json'
+
+export default function reSetRootHtml(libName: string) {
+  const targetPath = getRootPath(`${OUTPUT_DIR}/index.html`)
+  let htmlStr = readFileSync(targetPath).toString('utf-8')
+  const startLen = htmlStr.lastIndexOf(`<link rel="stylesheet" href="./assets/${libName}.`)
+  if (startLen > 0) {
+    const cssLen = '<link rel="stylesheet" href="./assets/ant-design-vue.'.length + '********.css">'.length
+
+    const end = startLen + cssLen
+    htmlStr = htmlStr.slice(0, startLen) + htmlStr.slice(end)
+    fs.writeFileSync(targetPath, htmlStr)
+    console.log(`✨ ${chalk.cyan(`[${pkg.name}]`)}` + ' - resetHtml successfully!')
+  }
+}

package/template-design-pro/build/utils.ts

@@ -0,0 +1,85 @@
+import fs from 'fs'
+import path from 'path'
+import dotenv from 'dotenv'
+
+export function isDevFn(mode: string): boolean {
+  return mode === 'development'
+}
+
+export function isProdFn(mode: string): boolean {
+  return mode === 'production'
+}
+
+/**
+ * Whether to generate package preview
+ */
+export function isReportMode(): boolean {
+  return process.env.REPORT === 'true'
+}
+
+// Read all environment variable configuration files to process.env
+export function wrapperEnv(envConf: Recordable): ViteEnv {
+  const ret: any = {}
+
+  for (const envName of Object.keys(envConf)) {
+    let realName = envConf[envName].replace(/\\n/g, '\n')
+    realName = realName === 'true' ? true : realName === 'false' ? false : realName
+
+    ret[envName] = realName
+    process.env[envName] = realName
+  }
+  return ret
+}
+
+/**
+ * 获取当前环境下生效的配置文件名
+ */
+function getConfFiles() {
+  const script = process.env.npm_lifecycle_script
+  const reg = new RegExp('--mode ([a-z]+)')
+  const result = reg.exec(script as string) as any
+  if (result) {
+    const mode = result[1] as string
+    return [ '.env', `.env.${mode}` ]
+  }
+  return [ '.env', '.env.production' ]
+}
+
+/**
+ * Get the environment variables starting with the specified prefix
+ * @param match prefix
+ * @param confFiles ext
+ */
+export function getEnvConfig(confFiles = getConfFiles()): Partial<ViteEnv> {
+  let envConfig: Partial<ViteEnv> = {}
+  confFiles.forEach((item) => {
+    try {
+      const env = dotenv.parse(fs.readFileSync(path.resolve(process.cwd(), item)))
+      envConfig = { ...envConfig, ...env }
+    } catch (e) {
+      console.error(`Error in parsing ${item}`, e)
+    }
+  })
+  return envConfig
+}
+
+/**
+ * Get user root directory
+ * @param dir file path
+ */
+export function getRootPath(...dir: string[]) {
+  return path.resolve(process.cwd(), ...dir)
+}
+
+export function getDefaultPath(supportTs = true) {
+  return path.resolve(process.cwd(), `src/main.${supportTs ? 'ts' : 'js'}`)
+}
+
+export function fileExists(f: string) {
+  try {
+    fs.accessSync(f, fs.constants.W_OK)
+    return true
+  } catch (error) {
+    return false
+  }
+}

package/template-design-pro/build/vite/cdn.ts

@@ -0,0 +1,7 @@
+const css = []
+
+const js = [
+  'https://cdn.staticfile.org/echarts/5.2.1/echarts.min.js',
+]
+
+export const cdnConf = { css, js }