nsgm-cli 2.1.13 → 2.1.14

package/client/utils/sso.ts

@@ -5,16 +5,16 @@ import _ from 'lodash'
 
 const env = getLocalEnv()
 
-const LOGIN_COOKIE_ID = env + '_cas_nsgm'
-const LOGIN_COOKIE_USER = env + '_nsgm_user'
+const LOGIN_COOKIE_ID = `${env}_cas_nsgm`
+const LOGIN_COOKIE_USER = `${env}_nsgm_user`
 
 const getPrincipalUrl = () => {
-  const url = getLocalApiPrefix() + '/rest/sso/sessionCheck'
+  const url = `${getLocalApiPrefix()}/rest/sso/sessionCheck`
   return url
 }
 
 const getValidateUrl = () => {
-  const url = getLocalApiPrefix() + '/rest/sso/ticketCheck'
+  const url = `${getLocalApiPrefix()}/rest/sso/ticketCheck`
   return url
 }
 
@@ -33,18 +33,17 @@ const handleLocationHref = () => {
         if (paramStr.indexOf('&') !== -1) {
           const paramArr = paramStr.split('&')
 
-          _.each(paramArr, (item, index) => {
+          _.each(paramArr, (item) => {
             if (item.indexOf('=') !== -1) {
               const itemArr = item.split('=')
               const itemArrLen = itemArr.length
 
               const key = itemArr[0]
               let value = ''
-              if (itemArrLen > 1)
-                value = itemArr[1]
+              if (itemArrLen > 1) value = itemArr[1]
 
               if ('ticket' !== key) {
-                newParamStr += key + '=' + value + '&'
+                newParamStr += `${key}=${value}&`
               }
             }
           })
@@ -58,16 +57,12 @@ const handleLocationHref = () => {
       }
 
       const locationHrefArrFirst = locationHrefArr[0]
-      if (newParamStr !== '')
-        newHref = locationHrefArrFirst + '?' + newParamStr
-      else
-        newHref = locationHrefArrFirst
+      if (newParamStr !== '') newHref = `${locationHrefArrFirst}?${newParamStr}`
+      else newHref = locationHrefArrFirst
     } else {
       newHref = locationHref
     }
   }
-
-  // console.log('newHref', newHref)
   return encodeURIComponent(newHref)
 }
 
@@ -76,16 +71,7 @@ const jumpToLogin = () => {
   delCookie(LOGIN_COOKIE_USER)
 
   if (typeof window !== 'undefined') {
-    window.location.href = window.location.origin + '/login'
-  }
-}
-
-const jumpToLogout = () => {
-  delCookie(LOGIN_COOKIE_ID)
-  delCookie(LOGIN_COOKIE_USER)
-
-  if (typeof window !== 'undefined') {
-    window.location.href = window.location.origin
+    window.location.href = `${window.location.origin}/login`
   }
 }
 
@@ -93,44 +79,50 @@ const principalLogin = (cookie: string, callback: any) => {
   let url = getPrincipalUrl()
 
   if (typeof window !== 'undefined') {
-    url += '?cookieValue=' + cookie + '&redirectUrl=' + handleLocationHref()
+    url += `?cookieValue=${cookie}&redirectUrl=${handleLocationHref()}`
   }
 
-  // console.log('principalLogin_url', url)
-  axios.get(url, { params: { credentials: 'include' } }).then((res: any) => {
-    // console.log('principalLogin_res', res)
-    const { data } = res
-    if (data) {
-      const { returnCode, userAttr } = data
-      if (returnCode !== 0) {
-        jumpToLogin()
+  axios
+    .get(url, { params: { credentials: 'include' } })
+    .then((res: any) => {
+      const { data } = res
+      if (data) {
+        const { returnCode, userAttr } = data
+        if (returnCode !== 0) {
+          jumpToLogin()
+        } else {
+          storeLoginUser(userAttr, callback)
+        }
       } else {
-        storeLoginUser(userAttr, callback)
+        jumpToLogin()
       }
-    } else {
+    })
+    .catch((e) => {
+      console.error('principalLogin_exception', e)
       jumpToLogin()
-    }
-  }).catch((e) => {
-    console.log('principalLogin_exception', e)
-    jumpToLogin()
-  })
+    })
 }
 
 const storeLoginUser = (userAttr: any, callback: any) => {
-  // console.log('storeLoginUser', userAttr)
-
   if (userAttr) {
-    const user = JSON.stringify(userAttr, ['city', 'company', 'department', 'displayName', 'employee', 'mail', 'name', 'sn'])
+    const user = JSON.stringify(userAttr, [
+      'city',
+      'company',
+      'department',
+      'displayName',
+      'employee',
+      'mail',
+      'name',
+      'sn',
+    ])
     setCookie(LOGIN_COOKIE_USER, user, null)
-    callback && callback(JSON.parse(user))
+    callback?.(JSON.parse(user))
   } else {
-    callback && callback()
+    callback?.()
   }
 }
 
 const storeLogin = (cookie: any, cookieExpire: any, userAttr: any, callback: any) => {
-  // console.log('storeLogin_cookie', cookie)
-
   if (cookie) {
     setCookie(LOGIN_COOKIE_ID, cookie, cookieExpire)
   }
@@ -138,51 +130,50 @@ const storeLogin = (cookie: any, cookieExpire: any, userAttr: any, callback: any
   storeLoginUser(userAttr, callback)
 }
 
-const validateLogin = (ticket: string, name: string = '', callback: any) => {
+const validateLogin = (ticket: string, name = '', callback: any) => {
   let url = getValidateUrl()
 
   if (typeof window !== 'undefined') {
-    url += '?ticket=' + ticket
+    url += `?ticket=${ticket}`
 
     if (name !== '') {
-      url += '&name=' + name
+      url += `&name=${name}`
     }
   }
 
-  // console.log('validateLogin_url', url)
-  axios.get(url, { params: { credentials: 'include' } }).then((res: any) => {
-    // console.log('validateLogin_res', res)
-
-    if (res) {
-      const { data } = res
-      if (data) {
-        const { cookieValue, cookieExpire, returnCode, userAttr } = data
-        if (returnCode === 0) {
-          storeLogin(cookieValue, cookieExpire, userAttr, callback)
+  axios
+    .get(url, { params: { credentials: 'include' } })
+    .then((res: any) => {
+      if (res) {
+        const { data } = res
+        if (data) {
+          const { cookieValue, cookieExpire, returnCode, userAttr } = data
+          if (returnCode === 0) {
+            storeLogin(cookieValue, cookieExpire, userAttr, callback)
+          } else {
+            jumpToLogin()
+          }
         } else {
           jumpToLogin()
         }
       } else {
         jumpToLogin()
       }
-    } else {
-      jumpToLogin()
-    }
-  }).catch((e) => {
-    console.log('validateLogin_exception', e)
-  })
+    })
+    .catch((e) => {
+      console.error('validateLogin_exception', e)
+    })
 }
 
 export const login = (callback: any) => {
   const cookieLoginValue = getCookie(LOGIN_COOKIE_ID)
-  // console.log('cookieLoginValue', cookieLoginValue)
 
   if (typeof window !== 'undefined') {
     const locationHref = window.location.href
 
     // 如果已经在登录页面，不需要进行登录检查
     if (locationHref.indexOf('/login') !== -1) {
-      callback && callback()
+      callback?.()
       return
     }
 
@@ -204,42 +195,41 @@ export const login = (callback: any) => {
       principalLogin(cookieLoginValue, callback)
     }
   } else {
-    callback && callback()
+    callback?.()
   }
 }
 
 export const directLogin = (userName: string, userPassword: string, callback: any) => {
   if (userName === '') {
-    return { success: false, message: '请输入用户名' };
+    return { success: false, message: '请输入用户名' }
   }
   if (userPassword === '') {
-    return { success: false, message: '请输入密码' };
+    return { success: false, message: '请输入密码' }
   }
 
   // 使用 encodeURIComponent 处理可能的特殊字符，然后再进行 Base64 编码
-  const safeStr = handleXSS(userName + "," + userPassword);
-  const encodedName = btoa(encodeURIComponent(safeStr));
-  const url = `${getLocalApiPrefix()}/rest/sso/ticketCheck?ticket=XXX&name=${encodedName}`;
+  const safeStr = handleXSS(`${userName},${userPassword}`)
+  const encodedName = btoa(encodeURIComponent(safeStr))
+  const url = `${getLocalApiPrefix()}/rest/sso/ticketCheck?ticket=XXX&name=${encodedName}`
 
   return fetch(url)
-    .then(response => response.json())
-    .then(data => {
+    .then((response) => response.json())
+    .then((data) => {
       if (data && data.returnCode === 0) {
         // 登录成功，设置cookie
         if (typeof window !== 'undefined') {
-          storeLogin(data.cookieValue, data.cookieExpire, data.userAttr, callback);
-          return { success: true };
+          storeLogin(data.cookieValue, data.cookieExpire, data.userAttr, callback)
+          return { success: true }
         }
       }
-      return { success: false, message: '用户名或密码错误' };
+      return { success: false, message: '用户名或密码错误' }
+    })
+    .catch((error) => {
+      console.error('登录请求失败:', error)
+      return { success: false, message: '登录请求失败，请稍后重试' }
     })
-    .catch(error => {
-      console.error('登录请求失败:', error);
-      return { success: false, message: '登录请求失败，请稍后重试' };
-    });
 }
 
 export const logout = () => {
   jumpToLogin()
 }
-

package/eslint.config.js

@@ -6,7 +6,8 @@ const prettier = require('eslint-plugin-prettier');
 module.exports = [
   js.configs.recommended,
   {
-    files: ['src/**/*.{ts,tsx}'],
+    files: ['src/**/*.{ts,tsx}', 'client/**/*.{ts,tsx}', 'pages/**/*.{ts,tsx}'],
+    ignores: ['**/__tests__/**/*'],
     languageOptions: {
       parser: typescriptParser,
       parserOptions: {
@@ -55,6 +56,42 @@ module.exports = [
       'prettier/prettier': 'error'
     }
   },
+  {
+    files: ['**/__tests__/**/*.{ts,tsx}', '**/*.test.{ts,tsx}', '**/*.spec.{ts,tsx}'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module'
+      },
+      globals: {
+        describe: 'readonly',
+        test: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        beforeAll: 'readonly',
+        afterAll: 'readonly',
+        jest: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        console: 'readonly'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      'prettier': prettier
+    },
+    rules: {
+      'no-console': 'off',
+      'no-undef': 'off',
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      'prettier/prettier': 'error'
+    }
+  },
   {
     files: ['**/*.js'],
     languageOptions: {

package/generation/README.md

@@ -8,6 +8,7 @@
 - [Styled-components](https://github.com/styled-components/styled-components) - CSS-in-JS 解决方案
 - [GraphQL](https://graphql.org/) - API 查询语言
 - [MySQL](https://www.mysql.com/) - 关系型数据库
+- [Jest](https://jestjs.io/) - JavaScript 测试框架
 - 安全登录系统 - 基于 bcrypt 加密
 
 ## 快速入门
@@ -21,6 +22,14 @@
 | `npm run build`  | 编译项目     |
 | `npm run export` | 导出静态页面 |
 
+### 测试命令
+
+| 命令                    | 说明             |
+| ----------------------- | ---------------- |
+| `npm test`              | 运行所有测试     |
+| `npm run test:watch`    | 监视模式运行测试 |
+| `npm run test:coverage` | 生成覆盖率报告   |
+
 ### 代码生成命令
 
 | 命令             | 说明         |
@@ -30,10 +39,10 @@
 
 ### 项目维护命令
 
-| 命令                                | 说明             |
-| ----------------------------------- | ---------------- |
-| `npm run upgrade`                   | 升级项目基础文件 |
-| `npm run generate-password [密码]`  | 生成安全密码哈希 |
+| 命令                               | 说明             |
+| ---------------------------------- | ---------------- |
+| `npm run upgrade`                  | 升级项目基础文件 |
+| `npm run generate-password [密码]` | 生成安全密码哈希 |
 
 ## 参数说明
 
@@ -70,6 +79,7 @@
 ## 项目结构
 
 ```
+├── __tests__/        # 测试文件
 ├── components/       # 公共组件
 ├── pages/            # 页面文件
 │   ├── api/          # API 路由
@@ -80,6 +90,8 @@
 │   ├── modules/      # GraphQL 解析器和模式
 │   └── plugins/      # GraphQL 插件
 ├── styles/           # 全局样式
+├── coverage/         # 测试覆盖率报告
+├── jest.config.js    # Jest 测试配置
 ├── next.config.js    # Next.js 配置
 ├── mysql.config.js   # MySQL 配置
 └── project.config.js # 项目配置
@@ -180,8 +192,15 @@ module.exports = {
 
 1. **创建新页面**：使用 `npm run create [controller] [action]` 命令
 2. **启动开发服务器**：运行 `npm run dev`
-3. **构建生产版本**：运行 `npm run build` 然后 `npm run start`
-4. **导出静态网站**：运行 `npm run export`
+3. **运行测试**：使用 `npm test` 运行测试，`npm run test:watch` 进行开发时的实时测试
+4. **构建生产版本**：运行 `npm run build` 然后 `npm run start`
+5. **导出静态网站**：运行 `npm run export`
+
+### 测试开发
+
+- 测试文件放在 `__tests__/` 目录下
+- 测试文件以 `.test.js`、`.test.ts`、`.spec.js` 或 `.spec.ts` 结尾
+- 查看测试覆盖率报告：运行 `npm run test:coverage` 后打开 `coverage/index.html`
 
 ## 更多资源
 

package/generation/__tests__/example.test.js

@@ -0,0 +1,41 @@
+/**
+ * Example test file to demonstrate Jest configuration
+ * This file can be removed or modified according to your project needs
+ */
+
+describe('Jest Configuration Test', () => {
+  test('Jest is properly configured', () => {
+    expect(true).toBe(true)
+  })
+
+  test('Basic math operations', () => {
+    expect(2 + 2).toBe(4)
+    expect(5 * 3).toBe(15)
+    expect(10 / 2).toBe(5)
+  })
+
+  test('String operations', () => {
+    const testString = 'Hello, World!'
+    expect(testString).toContain('World')
+    expect(testString.length).toBe(13)
+  })
+
+  test('Array operations', () => {
+    const testArray = [1, 2, 3, 4, 5]
+    expect(testArray).toHaveLength(5)
+    expect(testArray).toContain(3)
+    expect(testArray[0]).toBe(1)
+  })
+
+  test('Object operations', () => {
+    const testObject = {
+      name: 'Test',
+      version: '1.0.0',
+      active: true
+    }
+
+    expect(testObject).toHaveProperty('name')
+    expect(testObject.name).toBe('Test')
+    expect(testObject.active).toBeTruthy()
+  })
+})

package/generation/client/utils/menu.tsx

@@ -5,7 +5,14 @@ let key = 1
 
 export default [
   {
-    key: key.toString(),
+    key: (++key).toString(),
+    text: '', // 空目录不显示，为了使用 SolutionOutlined 而不报错
+    url: '/',
+    icon: <SolutionOutlined rev={undefined} />,
+    subMenus: null
+  },
+  {
+    key: (++key).toString(),
     text: '介绍',
     url: '/',
     icon: <BookOutlined rev={undefined} />,
@@ -23,5 +30,5 @@ export default [
         url: '/template/manage'
       }
     ]
-  },*/
+  }*/
 ]

package/generation/env.example

@@ -0,0 +1,3 @@
+# Login Configuration  
+LOGIN_USERNAME=admin
+LOGIN_PASSWORD_HASH=$2b$10$example_bcrypt_hash_here

package/generation/eslint.config.js

@@ -0,0 +1,112 @@
+const js = require('@eslint/js');
+const typescript = require('@typescript-eslint/eslint-plugin');
+const typescriptParser = require('@typescript-eslint/parser');
+const prettier = require('eslint-plugin-prettier');
+
+module.exports = [
+  js.configs.recommended,
+  {
+    files: ['client/**/*.{ts,tsx}', 'pages/**/*.{ts,tsx}', 'src/**/*.{ts,tsx}'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+        project: './tsconfig.json'
+      },
+      globals: {
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        console: 'readonly'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      'prettier': prettier
+    },
+    rules: {
+      'no-console': 'off',
+      'no-undef': 'off',
+      'no-unused-vars': 'off',
+      'prefer-const': 'warn',
+      'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'warn',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': ['warn', { 
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_'
+      }],
+      'prettier/prettier': 'error',
+      'no-unreachable': 'error',
+      'no-duplicate-imports': 'error',
+      'prefer-template': 'warn',
+      '@typescript-eslint/prefer-optional-chain': 'warn'
+    }
+  },
+  {
+    files: ['**/__tests__/**/*.{ts,tsx,js}', '**/*.test.{ts,tsx,js}', '**/*.spec.{ts,tsx,js}'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module'
+      },
+      globals: {
+        describe: 'readonly',
+        test: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        beforeAll: 'readonly',
+        afterAll: 'readonly',
+        jest: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        console: 'readonly'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      'prettier': prettier
+    },
+    rules: {
+      'no-console': 'off',
+      'no-undef': 'off',
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      'prettier/prettier': 'error'
+    }
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'commonjs',
+      globals: {
+        require: 'readonly',
+        module: 'readonly',
+        exports: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        console: 'readonly'
+      }
+    },
+    rules: {
+      'no-console': 'off'
+    }
+  },
+  {
+    ignores: [
+      'node_modules/**',
+      '.next/**',
+      'coverage/**',
+      '*.config.js'
+    ]
+  }
+];

package/generation/gitignore

@@ -2,4 +2,9 @@ node_modules
 .next
 out
 build
-scripts/dump.*
+scripts/dump.*
+.env
+.env.local
+.env.production
+.env.development
+*.log

package/generation/jest.config.js

@@ -0,0 +1,40 @@
+module.exports = {
+  testEnvironment: 'jsdom',
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+  transform: {
+    '^.+\\.(js|jsx|ts|tsx)$': ['babel-jest', { presets: ['next/babel'] }]
+  },
+  transformIgnorePatterns: ['/node_modules/', '^.+\\.module\\.(css|sass|scss|less)$'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/$1',
+    '^~/(.*)$': '<rootDir>/$1'
+  },
+  setupFiles: ['<rootDir>/jest.setup-globals.js'],
+  testMatch: [
+    '**/__tests__/**/*.(ts|tsx|js)',
+    '**/*.(test|spec).(ts|tsx|js)'
+  ],
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'client/**/*.{js,jsx,ts,tsx}',
+    'pages/**/*.{js,jsx,ts,tsx}',
+    'server/**/*.{js,jsx,ts,tsx}',
+    '!**/*.d.ts',
+    '!**/node_modules/**',
+    '!**/.next/**',
+    '!**/coverage/**',
+    '!**/*.config.js'
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['json', 'lcov', 'text', 'clover', 'html'],
+  coverageThreshold: {
+    global: {
+      branches: 70,
+      functions: 70,
+      lines: 70,
+      statements: 70
+    }
+  },
+  testPathIgnorePatterns: ['<rootDir>/.next/', '<rootDir>/node_modules/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
+}

package/generation/package.json

@@ -2,7 +2,7 @@
   "name": "nsgm-cli-project",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "app.js",
   "scripts": {
     "dev": "nsgm dev",
     "build": "nsgm build",
@@ -15,8 +15,29 @@
     "deletedb": "nsgm deletedb",
     "generate-password": "node scripts/generate-password-hash.js",
     "postversion": "git push && git push --tags",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "dependencies": {
+    "nsgm-cli": "^2"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/lodash": "^4",
+    "typescript": "^5",
+    "jest": "^30",
+    "jest-environment-jsdom": "^30",
+    "@testing-library/jest-dom": "^6",
+    "@testing-library/react": "^14",
+    "@testing-library/user-event": "^14",
+    "@types/jest": "^30",
+    "eslint": "^9",
+    "eslint-config-prettier": "^10",
+    "eslint-plugin-prettier": "^5",
+    "prettier": "^3"
+  }
 }