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

package/template-design-pro/tests/test.spec.ts

@@ -0,0 +1,16 @@
+// import { mount } from '@vue/test-utils';
+// import { Button } from '@/components/Button';
+
+test('if jest is normal.', async () => {
+  expect('jest').toEqual('jest');
+});
+
+// TODO Vue component testing is not supported temporarily
+// test('is a Vue instance.', async () => {
+//   const wrapper = mount(Button, {
+//     slots: {
+//       default: 'Button text',
+//     },
+//   });
+//   expect(wrapper.html()).toContain('Button text');
+// });

package/template-design-pro/tsconfig.json

@@ -0,0 +1,47 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "forceConsistentCasingInFileNames": true,
+    "allowSyntheticDefaultImports": true,
+    "strictFunctionTypes": false,
+    "jsx": "preserve",
+    "baseUrl": "./",
+    "allowJs": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "experimentalDecorators": true,
+    "lib": ["dom", "esnext"],
+    "types": ["vite/client"],
+    "typeRoots": ["./node_modules/@types/", "./types"],
+    "noImplicitAny": false,
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["src/*"],
+      "/types/*": ["types/*"],
+      "/config/*": ["config/*"],
+      "@gx-vuex": ["src/store/index.ts"],
+      "@gx-admin/hooks/*": ["src/hooks/*"],
+      "@gx-design/*": ["src/components/GDesign/*"]
+    }
+  },
+  "include": [
+    "tests/**/*.ts",
+    "src/**/*.ts",
+    "src/**/*.less",
+    "src/**/*.d.ts",
+    "src/**/*.tsx",
+    "src/**/*.vue",
+    "types/**/*.d.ts",
+    "types/**/*.ts",
+    "build/**/*.ts",
+    "build/**/*.d.ts",
+    "mock/**/*.ts",
+    "vite.config.ts"
+  ],
+  "exclude": ["node_modules", "tests/server/**/*.ts", "dist", "**/*.js", ".history"]
+}

package/template-design-pro/types/config.d.ts

@@ -0,0 +1,100 @@
+import { MenuTheme } from '@gx-pro/pro-layout'
+
+export interface configSeting {
+  theme: themeConfig;
+  proxy: any;
+  network: networkConfig;
+  animate: animateConfig;
+  defaultSettings: settingConfig;
+}
+
+export interface settingConfig {
+  publicPath: string;
+  outputDir: string;
+  assetsDir: string;
+  title: string;
+  shortName: string;
+  titleSeparator: string;
+  titleReverse: boolean;
+  waterMark: boolean;
+  waterMarkTitle: string;
+  viewScrollRoot: string;
+  useCdn: boolean;
+  useProxy: boolean;
+  proxyTarget: string;
+  requestPrefix?: string | object;
+  devPort: number;
+  copyright: string;
+  keepAliveMaxNum: number;
+  routerMode: string;
+  routerLoadTime: number;
+  routesWhiteList: Array<string>;
+  loadingText: string;
+  tokenName: string;
+  tokenTableName: string;
+  storage: string;
+  recordRoute: boolean;
+  logo: string;
+  loginInterception: boolean;
+  loginRSA: boolean;
+  authentication: string;
+  rolesControl: boolean;
+  uniqueOpened: boolean;
+  defaultOpeneds: Array<string>;
+  debounce: Array<string>;
+}
+
+export interface networkConfig {
+  contentType: string;
+  messageDuration: number;
+  requestTimeout: number;
+  successCode: (string | number)[];
+}
+
+export type Theme = 'dark' | 'light';
+
+export type MenuTheme = Theme;
+
+export interface themeConfig {
+  theme: MenuTheme | undefined;
+  primaryColor: string;
+  layout: 'side' | 'mix' | 'simple' | 'wide';
+  splitMenus: boolean;
+  fixedMultiTab: boolean;
+  fixedHeader: boolean;
+  fixSiderbar: boolean;
+  showProgressBar: boolean;
+  showTabsBar: boolean;
+  showFullScreen?: boolean;
+  headerHeight?: number;
+  wideWidth?: number;
+  autoHideHeader: boolean;
+  title: string;
+  iconfontUrl?: string;
+  animate?: {
+    disabled?: boolean;
+    name: string;
+    direction: string;
+  };
+}
+
+export interface customizeConfig {
+  donation: boolean;
+  templateFolder: string;
+}
+
+export interface animateConfig {
+  preset: Array<animatePreset>;
+}
+
+export interface animatePreset {
+  name: string;
+  alias: string;
+  directions: Array<any>;
+}
+
+export interface themeAnimateSeting {
+  name: string;
+  direction: string;
+  disabled?: boolean;
+}

package/template-design-pro/types/global.d.ts

@@ -0,0 +1,103 @@
+import type {
+  Slot,
+  VNode,
+  VNodeChild,
+  ComponentPublicInstance,
+  FunctionalComponent,
+  PropType as VuePropType
+} from 'vue'
+import type { ProColumnType as GProColumnType } from '@gx-design-vue/pro-table'
+
+declare global {
+  const __APP_INFO__: {
+    pkg: {
+      name: string;
+      version: string;
+      dependencies: Recordable<string>;
+      devDependencies: Recordable<string>;
+    };
+    lastBuildTime: string;
+  }
+
+  declare type LocalResult = {
+    value: any;
+    time: string;
+    expired: number;
+  }
+
+  declare type ProColumnType = GProColumnType
+
+  // vue
+  declare type Key = string | number;
+  declare type PropType<T> = VuePropType<T>;
+  declare type VueNode = VNodeChild | JSX.Element;
+
+  declare type WithFalse<T> = T | false;
+
+  declare type RecordType = Record<string, any>;
+
+  declare type CustomRender =
+    | Slot
+    | VNodeChild
+    | VNode
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | ((...props: any[]) => Slot)
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | ((...props: any[]) => VNode)
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | ((...args: any[]) => VNode)
+    | VNode[]
+    | JSX.Element
+    | string
+    | null
+    | undefined
+
+  declare type Nullable<T> = T | null;
+  declare type Recordable<T = any> = Record<string, T>;
+  declare type ReadonlyRecordable<T = any> = {
+    readonly [key: string]: T;
+  };
+  declare type TimeoutHandle = ReturnType<typeof setTimeout>;
+  declare interface ViteEnv {
+    VITE_PORT: number;
+    VITE_USE_MODE: string;
+    VITE_USE_THEME: boolean;
+    VITE_USE_MOCK: boolean;
+    VITE_NODE_ENV: string;
+    VITE_USE_PWA: boolean;
+    VITE_BASE_URL: string;
+    VITE_APP_ENV: string;
+    VUE_APP_VERSION: string;
+    VUE_APP_AUTHOR: any;
+    VITE_OSS_BUCKET: string;
+    VITE_OSS_ORIGIN: string;
+    VITE_PROXY: [ string, string ][];
+    VITE_USE_CDN: boolean;
+    VITE_DROP_CONSOLE: boolean;
+    VITE_BUILD_COMPRESS: 'gzip' | 'brotli' | 'none';
+    VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE: boolean;
+    VITE_LEGACY: boolean;
+    VITE_GENERATE_UI: string;
+  }
+
+  declare type ViteEnvKey = keyof ViteEnv
+
+  declare function parseInt(s: string | number, radix?: number): number;
+
+  declare function parseFloat(string: string | number): number;
+
+  namespace JSX {
+    type Element = VNode;
+
+    interface IntrinsicAttributes {
+      [elem: string]: any;
+    }
+  }
+}
+
+declare module 'vue' {
+  export type JSXComponent<Props = any> =
+    | { new(): ComponentPublicInstance<Props> }
+    | FunctionalComponent<Props>;
+}
+

package/template-design-pro/types/gx-components.d.ts

@@ -0,0 +1,24 @@
+// generated by unplugin-vue-components
+// We suggest you to commit this file into source control
+// Read more: https://github.com/vuejs/vue-next/pull/3399
+import '@vue/runtime-core'
+
+export {}
+
+declare module '@vue/runtime-core' {
+  export interface GlobalComponents {
+    GBars: typeof import('./../src/components/GDesign/Scrollbars')['default']
+    GProModal: typeof import('./../src/components/GDesign/ProModal')['default']
+    GUpload: typeof import('./../src/components/GDesign/Upload')['default']
+    GProPageContainer: typeof import('./../src/components/GDesign/ProLayout/components/PageContainer')['default']
+  }
+}
+
+declare global {
+  const GProCard: typeof import('@gx-design-vue/pro-card')['GProCard']
+  const GProForm: typeof import('@gx-design-vue/pro-form')['GProForm']
+  const GProTable: typeof import('@gx-design-vue/pro-table')['GProTable']
+  const GPorWaterMark: typeof import('@gx-design-vue/pro-watermark')['GPorWaterMark']
+}
+
+export { }

package/template-design-pro/types/index.d.ts

@@ -0,0 +1,13 @@
+declare interface Fn<T = any, R = T> {
+  (...arg: T[]): R;
+}
+
+declare interface ComponentElRef<T extends HTMLElement = HTMLDivElement> {
+  $el: T;
+}
+
+declare type EmitType = (event: string, ...args: any[]) => void;
+
+declare type ElRef<T extends HTMLElement = HTMLDivElement> = Nullable<T>;
+
+declare type ComponentRef<T extends HTMLElement = HTMLDivElement> = ComponentElRef<T> | null;

package/template-design-pro/types/mock.d.ts

@@ -0,0 +1,23 @@
+import type { IncomingMessage, ServerResponse } from 'http'
+
+declare type MethodType = 'get' | 'post' | 'put' | 'delete' | 'patch'
+
+declare interface RespThisType {
+  req: IncomingMessage
+  res: ServerResponse
+  parseJson: () => any
+}
+
+declare interface MockMethod {
+  url: string
+  method?: MethodType
+  timeout?: number
+  statusCode?: number
+  response?:
+    | ((
+    this: RespThisType,
+    opt: { url: Recordable; body: Recordable; query: Recordable; headers: Recordable },
+  ) => any)
+    | any
+  rawResponse?: (this: RespThisType, req: IncomingMessage, res: ServerResponse) => void
+}

package/template-design-pro/types/module.d.ts

@@ -0,0 +1,16 @@
+declare module '*.vue' {
+  import { DefineComponent } from 'vue';
+  const Component: DefineComponent<{}, {}, any>;
+  export default Component;
+}
+
+declare module 'ant-design-vue/es/locale/*' {
+  import { Locale } from 'ant-design-vue/types/locale-provider';
+  const locale: Locale & ReadonlyRecordable;
+  export default locale as Locale & ReadonlyRecordable;
+}
+
+declare module 'virtual:*' {
+  const result: any;
+  export default result;
+}

package/template-design-pro/types/response.d.ts

@@ -0,0 +1,15 @@
+declare interface ResponseResult<T = any> extends TableResult<T> {
+  code: number;
+  msg?: string;
+  message?: string;
+  data?: T;
+  roles?: any;
+  user?: any;
+  permissions?: any;
+}
+
+declare interface TableResult<T = any> {
+  total?: number;
+  pageNum?: number;
+  rows?: T;
+}

package/template-design-pro/types/route.d.ts

@@ -0,0 +1,89 @@
+import { defineComponent } from 'vue'
+import { RouteRecordRaw } from 'vue-router'
+
+export type Component<T extends any = any> =
+  | ReturnType<typeof defineComponent>
+  | (() => Promise<typeof import('*.vue')>)
+  | (() => Promise<T>);
+
+declare global {
+  type AppRouteModule = {
+    meta?: Meta;
+    linkPath?: string;
+    children?: AppRouteModule[];
+    hidden?: boolean;
+    component?: Component;
+  } & Omit<RouteRecordRaw, 'meta' | 'children'>
+
+  interface MenuDataItem extends MenuMeta {
+    id?: number;
+    menuId?: number;
+    parentId?: number;
+    createTime?: string;
+    menuType?: 'M' | 'C' | null;
+    orderNum?: string;
+    name?: string;
+    path?: string;
+    target?: string;
+    linkPath?: string;
+    key?: string;
+    redirect?: string;
+    component?: string;
+    hidden?: boolean;
+    meta?: MenuMeta;
+    children?: MenuDataItem[];
+  }
+
+  interface MenuMeta {
+    // 名称
+    title?: string;
+    // 是否外链 0:是 1:否
+    isFrame?: '0' | '1';
+    // 菜单类型 M:目录 C:菜单
+    menuType?: 'M' | 'C' | null;
+    // 主页
+    homePageFlag?: 1 | 0;
+    // 菜单图标
+    icon?: string;
+    // 菜单图标类型
+    iconType?: 0 | 1 | 2;
+    // //外链类型（选择是系统内则以iframe形式在系统内部展示，否则跳转新页面打开） 0:系统内 1:系统外
+    outLinkType?: 0 | 1;
+    // 标签栏显示状态（隐藏的路由是否显示在标签栏中（只有标签栏为显示转态才生效））0:显示 1:隐藏
+    tagHidden?: '0' | '1';
+    // 标签栏固定状态（标签栏路由地址是否固定（只有标签栏为显示转态才生效））0:是 1:否
+    tagFixed?: '0' | '1';
+    // 是否缓存
+    keepAlive?: boolean;
+  }
+
+  interface Meta {
+    // 名称
+    title?: string;
+    // 主页
+    homePage?: 1 | 0;
+    // 菜单图标
+    icon?: string;
+    // 菜单图标类型
+    iconType?: number;
+    //隐藏
+    hidden?: boolean;
+    // 菜单隐藏
+    hideInMenu?: boolean;
+    // 菜单以及children隐藏
+    hideChildrenInMenu?: boolean;
+    //外链类型（选择是系统内则以iframe形式在系统内部展示，否则跳转新页面打开） 0:系统内 1:系统外
+    targetStatus?: number;
+    // 外链地址
+    target?: string;
+    // 标签栏显示状态（隐藏的路由是否显示在标签栏中（只有标签栏为显示转态才生效））
+    tagHidden?: boolean;
+    // 标签栏固定状态（标签栏路由地址是否固定（只有标签栏为显示转态才生效））
+    tagFixed?: boolean;
+    type?: string;
+    disabled?: boolean;
+    danger?: boolean;
+    // 是否缓存
+    keepAlive?: boolean;
+  }
+}

package/template-design-pro/vite.config.ts

@@ -0,0 +1,136 @@
+import type { UserConfig, ConfigEnv } from 'vite'
+import { loadEnv } from 'vite'
+import { resolve } from 'path'
+import dayjs from 'dayjs'
+import externalGlobals from 'rollup-plugin-external-globals'
+import { generateModifyVars } from './build/generate/generateModifyVars'
+import { wrapperEnv } from './build/utils'
+import { createVitePlugins } from './build/vite/plugin'
+import { configManualChunk } from './build/vite/optimizer'
+import config, { createProxy } from './config/config'
+
+import pkg from './package.json'
+
+function pathResolve(dir: string) {
+  return resolve(process.cwd(), '.', dir)
+}
+
+const { publicPath, outputDir, assetsDir, devPort, useCdn, useProxy } = config.defaultSettings
+
+const { dependencies, devDependencies, name, version } = pkg
+
+const __APP_INFO__ = {
+  pkg: { dependencies, devDependencies, name, version },
+  lastBuildTime: dayjs().format('YYYY-MM-DD HH:mm:ss')
+}
+
+process.env.VUE_APP_VERSION = version
+
+export default ({ command, mode }: ConfigEnv): UserConfig => {
+
+  const root = process.cwd()
+
+  const env = loadEnv(mode, root)
+
+  // The boolean type read by loadEnv is a string. This function can be converted to boolean type
+  const viteEnv = wrapperEnv(env)
+
+  const { VITE_DROP_CONSOLE, VITE_APP_ENV, VITE_BASE_URL } = viteEnv
+
+  const isBuild = command === 'build'
+
+  return {
+    base: publicPath,
+    root,
+    resolve: {
+      alias: [
+        {
+          find: '@',
+          replacement: pathResolve('src') + '/'
+        },
+        {
+          find: /\/types\//,
+          replacement: pathResolve('types') + '/'
+        },
+        {
+          find: /\/config\//,
+          replacement: pathResolve('config') + '/'
+        },
+        {
+          find: '@gx-vuex',
+          replacement: pathResolve('src/store') + '/index.ts'
+        },
+        {
+          find: '@gx-design',
+          replacement: pathResolve('src/components/GDesign') + '/'
+        },
+        {
+          find: '@gx-admin/hooks',
+          replacement: pathResolve('src/hooks') + '/'
+        }
+      ]
+    },
+    server: {
+      open: true,
+      host: true,
+      port: devPort,
+      proxy: useProxy ? createProxy(VITE_BASE_URL)[VITE_APP_ENV] : {}
+    },
+    esbuild: {
+      drop: VITE_DROP_CONSOLE ? ['console', 'debugger'] : [],
+    },
+    build: {
+      outDir: outputDir,
+      assetsDir,
+      target: 'es2015',
+      cssTarget: 'chrome80',
+      reportCompressedSize: false,
+      chunkSizeWarningLimit: 2500,
+      commonjsOptions: {
+        ignoreTryCatch: false
+      },
+      rollupOptions: useCdn
+        ? {
+          output: {
+            manualChunks: configManualChunk
+          },
+          external: [ 'echarts' ],
+          plugins: [
+            externalGlobals({
+              echarts: 'echarts'
+            })
+          ]
+        } : {
+          output: {
+            manualChunks: configManualChunk
+          }
+        }
+    },
+    define: {
+      __INTLIFY_PROD_DEVTOOLS__: false,
+      __APP_INFO__: JSON.stringify(__APP_INFO__)
+    },
+    css: {
+      modules: {
+        generateScopedName: 'gx-pro-[local]-[hash:base64:5]'
+      },
+      preprocessorOptions: {
+        less: {
+          modifyVars: generateModifyVars(viteEnv),
+          javascriptEnabled: true
+        }
+      }
+    },
+
+    plugins: createVitePlugins(viteEnv, isBuild),
+
+    optimizeDeps: {
+      include: [
+        '@vue/runtime-core',
+        '@vue/shared',
+        'ant-design-vue/es/locale/zh_CN',
+        'ant-design-vue/es/locale/en_US'
+      ]
+    }
+  }
+}