create-young-proj 1.0.0 → 1.1.0

package/src/index.ts

@@ -0,0 +1,366 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-03 15:14:08
+ * @LastEditTime: 2023-11-08 11:27:47
+ * @Description:
+ */
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import spawn from 'cross-spawn'
+import minimist from 'minimist'
+import prompts from 'prompts'
+import { blue, green, red, reset } from 'kolorist'
+
+// Avoids autoconversion to number of the project name by defining that the args
+// non associated with an option ( _ ) needs to be parsed as a string. See #4606
+const argv = minimist<{
+  t?: string
+  template?: string
+}>(process.argv.slice(2), { string: ['_'] })
+const cwd = process.cwd()
+
+type ColorFunc = (str: string | number) => string
+interface Framework {
+  name: string
+  display: string
+  color: ColorFunc
+  variants: FrameworkVariant[]
+}
+interface FrameworkVariant {
+  name: string
+  display: string
+  color: ColorFunc
+  customCommand?: string
+  /**
+   * 待实现，暂时禁用选项
+   */
+  wip?: boolean
+  /**
+   * 已淘汰
+   */
+  deprecated?: boolean
+}
+
+const FRAMEWORKS: Framework[] = [
+  {
+    name: 'vue',
+    display: 'Young Designed Vue Template',
+    color: green,
+    variants: [
+      {
+        name: 'nuxt-admin',
+        display: 'Nuxt3 Admin',
+        color: blue,
+      },
+      {
+        name: 'nuxt-website',
+        display: 'Nuxt3 Website',
+        color: blue,
+      },
+      {
+        name: 'vue-mobile',
+        display: 'Vue3 Mobile',
+        color: blue,
+      },
+      {
+        name: 'uni-app',
+        display: 'Vue3 uni-app',
+        color: blue,
+      },
+      {
+        name: 'vue-thin',
+        display: 'Vue3 mini demo',
+        color: green,
+      },
+      {
+        name: 'admin-server',
+        display: 'Node Server Based on Midwayjs',
+        color: green,
+      },
+    ],
+  },
+  {
+    name: 'vite',
+    display: 'Vite Formal',
+    color: reset,
+    variants: [
+      {
+        name: 'create-vite',
+        display: 'create-vite',
+        color: reset,
+        customCommand: 'npm create vite@latest TARGET_DIR',
+      },
+    ],
+  },
+  {
+    name: 'others',
+    display: 'Others',
+    color: reset,
+    variants: [
+      {
+        name: 'create-vite-extra',
+        display: 'create-vite-extra ↗',
+        color: reset,
+        customCommand: 'npm create vite-extra@latest TARGET_DIR',
+      },
+    ],
+  },
+]
+
+const TEMPLATES = FRAMEWORKS.map(
+  f => (f.variants && f.variants.map(v => v.name)) || [f.name],
+).reduce((a, b) => a.concat(b), [])
+
+const renameFiles: Record<string, string | undefined> = {
+  _gitignore: '.gitignore',
+  _npmrc: '.npmrc',
+  _nvmrc: '.nvmrc',
+}
+
+const renameEnvBatch = /_env.*/
+
+const defaultTargetDir = 'vite-project'
+
+async function init() {
+  const argTargetDir = formatTargetDir(argv._[0])
+  const argTemplate = argv.template || argv.t
+
+  let targetDir = argTargetDir || defaultTargetDir
+  const getProjectName = () => (targetDir === '.' ? path.basename(path.resolve()) : targetDir)
+
+  let result: prompts.Answers<
+    'projectName' | 'overwrite' | 'packageName' | 'framework' | 'variant'
+  >
+
+  try {
+    result = await prompts(
+      [
+        {
+          type: argTargetDir ? null : 'text',
+          name: 'projectName',
+          message: reset('Project name:'),
+          initial: defaultTargetDir,
+          onState: (state) => {
+            targetDir = formatTargetDir(state.value) || defaultTargetDir
+          },
+        },
+        {
+          type: () => (!fs.existsSync(targetDir) || isEmpty(targetDir) ? null : 'confirm'),
+          name: 'overwrite',
+          message: () =>
+            `${targetDir === '.' ? 'Current directory' : `Target directory "${targetDir}"`
+            } is not empty. Remove existing files and continue?`,
+        },
+        {
+          type: (_, { overwrite }: { overwrite?: boolean }) => {
+            if (overwrite === false)
+              throw new Error(`${red('✖')} Operation cancelled`)
+
+            return null
+          },
+          name: 'overwriteChecker',
+        },
+        {
+          type: () => (isValidPackageName(getProjectName()) ? null : 'text'),
+          name: 'packageName',
+          message: reset('Package name:'),
+          initial: () => toValidPackageName(getProjectName()),
+          validate: dir => isValidPackageName(dir) || 'Invalid package.json name',
+        },
+        {
+          type: argTemplate && TEMPLATES.includes(argTemplate) ? null : 'select',
+          name: 'framework',
+          message:
+            typeof argTemplate === 'string' && !TEMPLATES.includes(argTemplate)
+              ? reset(`"${argTemplate}" isn't a valid template. Please choose from below: `)
+              : reset('Select a framework:'),
+          initial: 0,
+          choices: FRAMEWORKS.map((framework) => {
+            const frameworkColor = framework.color
+            return {
+              title: frameworkColor(framework.display || framework.name),
+              value: framework,
+            }
+          }),
+        },
+        {
+          type: (framework: Framework) => (framework && framework.variants ? 'select' : null),
+          name: 'variant',
+          message: reset('Select a variant:'),
+          choices: (framework: Framework) =>
+            framework.variants.map((variant) => {
+              const variantColor = variant.color
+              return {
+                title: variantColor(variant.display || variant.name),
+                value: variant.name,
+                disabled: variant.wip || variant.deprecated,
+              }
+            }),
+        },
+      ],
+      {
+        onCancel: () => {
+          throw new Error(`${red('✖')} Operation cancelled`)
+        },
+      },
+    )
+  }
+  catch (cancelled: any) {
+    console.log(cancelled.message)
+    return
+  }
+
+  // user choice associated with prompts
+  const { framework, overwrite, packageName, variant } = result
+
+  const root = path.join(cwd, targetDir)
+
+  if (overwrite)
+    emptyDir(root)
+  else if (!fs.existsSync(root))
+    fs.mkdirSync(root, { recursive: true })
+
+  // determine template
+  const template: string = variant || framework?.name || argTemplate
+
+  const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent)
+  const pkgManager = pkgInfo ? pkgInfo.name : 'npm'
+  const isYarn1 = pkgManager === 'yarn' && pkgInfo?.version.startsWith('1.')
+
+  const { customCommand }
+    = FRAMEWORKS.flatMap(f => f.variants).find(v => v.name === template) ?? {}
+
+  if (customCommand) {
+    const fullCustomCommand = customCommand
+      .replace('TARGET_DIR', targetDir)
+      .replace(/^npm create/, `${pkgManager} create`)
+      // Only Yarn 1.x doesn't support `@version` in the `create` command
+      .replace('@latest', () => (isYarn1 ? '' : '@latest'))
+      .replace(/^npm exec/, () => {
+        // Prefer `pnpm dlx` or `yarn dlx`
+        if (pkgManager === 'pnpm')
+          return 'pnpm dlx'
+
+        if (pkgManager === 'yarn' && !isYarn1)
+          return 'yarn dlx'
+
+        // Use `npm exec` in all other cases,
+        // including Yarn 1.x and other custom npm clients.
+        return 'npm exec'
+      })
+
+    const [command, ...args] = fullCustomCommand.split(' ')
+    const { status } = spawn.sync(command, args, {
+      stdio: 'inherit',
+    })
+    process.exit(status ?? 0)
+  }
+
+  console.log(`\nScaffolding project in ${root}...`)
+
+  const templateDir = path.resolve(fileURLToPath(import.meta.url), '../..', `template-${template}`)
+
+  const write = (file: string, content?: string) => {
+    const targetPath = path.join(
+      root,
+      renameFiles[file] ?? renameEnvBatch.test(file) ? file.replace('_', '.') : file,
+    )
+    if (content)
+      fs.writeFileSync(targetPath, content)
+    else
+      copy(path.join(templateDir, file), targetPath)
+  }
+
+  const files = fs.readdirSync(templateDir)
+  for (const file of files.filter(f => f !== 'package.json'))
+    write(file)
+
+  const pkg = JSON.parse(fs.readFileSync(path.join(templateDir, 'package.json'), 'utf-8'))
+
+  pkg.name = packageName || getProjectName()
+
+  write('package.json', JSON.stringify(pkg, null, 2))
+
+  console.log('\nDone. Now run:\n')
+  if (root !== cwd)
+    console.log(`  cd ${path.relative(cwd, root)}`)
+
+  switch (pkgManager) {
+    case 'yarn':
+      console.log('  yarn')
+      console.log('  yarn dev')
+      break
+    default:
+      console.log(`  ${pkgManager} install`)
+      console.log(`  ${pkgManager} run dev`)
+      break
+  }
+  console.log()
+}
+
+function formatTargetDir(targetDir: string | undefined) {
+  return targetDir?.trim().replace(/\/+$/g, '')
+}
+
+function copy(src: string, dest: string) {
+  const stat = fs.statSync(src)
+  if (stat.isDirectory())
+    copyDir(src, dest)
+  else
+    fs.copyFileSync(src, dest)
+}
+
+function isValidPackageName(projectName: string) {
+  return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(projectName)
+}
+
+function toValidPackageName(projectName: string) {
+  return projectName
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/^[._]/, '')
+    .replace(/[^a-z\d\-~]+/g, '-')
+}
+
+function copyDir(srcDir: string, destDir: string) {
+  fs.mkdirSync(destDir, { recursive: true })
+  for (const file of fs.readdirSync(srcDir)) {
+    const srcFile = path.resolve(srcDir, file)
+    const destFile = path.resolve(destDir, file)
+    copy(srcFile, destFile)
+  }
+}
+
+function isEmpty(path: string) {
+  const files = fs.readdirSync(path)
+  return files.length === 0 || (files.length === 1 && files[0] === '.git')
+}
+
+function emptyDir(dir: string) {
+  if (!fs.existsSync(dir))
+    return
+
+  for (const file of fs.readdirSync(dir)) {
+    if (file === '.git')
+      continue
+
+    fs.rmSync(path.resolve(dir, file), { recursive: true, force: true })
+  }
+}
+
+function pkgFromUserAgent(userAgent: string | undefined) {
+  if (!userAgent)
+    return undefined
+  const pkgSpec = userAgent.split(' ')[0]
+  const pkgSpecArr = pkgSpec.split('/')
+  return {
+    name: pkgSpecArr[0],
+    version: pkgSpecArr[1],
+  }
+}
+
+init().catch((e) => {
+  console.error(e)
+})

package/template-admin-server/.editorconfig

@@ -0,0 +1,11 @@
+# 🎨 editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true

package/template-admin-server/.nvmrc

@@ -0,0 +1 @@
+16

package/template-admin-server/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "rome.rome",
+    "obkoro1.korofileheader",
+  ]
+}

package/template-admin-server/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "rome.rome"
+}

package/template-admin-server/_gitignore

@@ -0,0 +1,15 @@
+logs/
+npm-debug.log
+yarn-error.log
+node_modules/
+package-lock.json
+yarn.lock
+coverage/
+dist/
+.idea/
+run/
+.DS_Store
+*.sw*
+*.un~
+.tsbuildinfo
+.tsbuildinfo.*

package/template-admin-server/_nvmrc

@@ -0,0 +1 @@
+16

package/template-admin-server/boot.mjs

@@ -0,0 +1,11 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-27 10:51:48
+ * @LastEditTime: 2022-12-27 10:51:49
+ * @Description:
+ */
+import { Bootstrap } from '@midwayjs/bootstrap';
+
+Bootstrap.run().then(() => {
+  console.log('midway server is running!');
+});

package/template-admin-server/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "midway_music_server",
+  "version": "1.0.0",
+  "description": "",
+  "type": "commonjs",
+  "private": true,
+  "dependencies": {
+    "@koa/cors": "^4.0.0",
+    "@midwayjs/bootstrap": "^3.0.0",
+    "@midwayjs/cache": "3",
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/info": "^3.0.0",
+    "@midwayjs/jwt": "^3.9.0",
+    "@midwayjs/koa": "^3.0.0",
+    "@midwayjs/logger": "^2.14.0",
+    "@midwayjs/passport": "3",
+    "@midwayjs/typeorm": "3",
+    "@midwayjs/validate": "^3.0.0",
+    "cache-manager": "^5.1.4",
+    "dayjs": "^1.11.7",
+    "defu": "^6.1.1",
+    "md5": "^2.3.0",
+    "mysql2": "^2.3.3",
+    "passport-jwt": "^4.0.1",
+    "reflect-metadata": "^0.1.13",
+    "typeorm": "^0.3.11"
+  },
+  "devDependencies": {
+    "@midwayjs/cli": "^2.0.0",
+    "@midwayjs/mock": "^3.9.0",
+    "@types/cache-manager": "^4.0.2",
+    "@types/koa": "^2.13.4",
+    "@types/koa__cors": "^3.3.0",
+    "@types/md5": "^2.3.2",
+    "@types/node": "16",
+    "cross-env": "^6.0.0",
+    "rome": "^11.0.0",
+    "typescript": "~4.8.0"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "scripts": {
+    "start": "cross-env NODE_ENV=production node ./boot.mjs",
+    "dev": "cross-env NODE_ENV=local midway-bin dev --ts",
+    "build": "midway-bin build -c",
+    "format": "rome format * --write"
+  },
+  "midway-bin-clean": [
+    ".vscode/.tsbuildinfo",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/BluesYoung-web/midway_music_server.git"
+  },
+  "author": "BluesYoung-web",
+  "license": "MIT"
+}

package/template-admin-server/rome.json

@@ -0,0 +1,22 @@
+{
+  "formatter": {
+    "ignore": [
+      "dist/*",
+      "*.html",
+      "yarn.lock",
+      "*.json",
+      "*.md"
+    ],
+    "indentStyle": "space",
+    "indentSize": 2,
+    "lineWidth": 100
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  },
+  "linter": {
+    "enabled": false
+  }
+}

package/template-admin-server/src/config/config.default.ts

@@ -0,0 +1,56 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-27 10:56:45
+ * @LastEditTime: 2023-01-09 15:14:11
+ * @Description:
+ */
+import { MidwayAppInfo, MidwayConfig } from '@midwayjs/core';
+import * as Entities from '../entities';
+
+export default (appInfo: MidwayAppInfo): MidwayConfig => {
+  const SERCRET_KEY = 'bluesyoung_web';
+  return {
+    // 用于对 cookie 进行签名
+    keys: SERCRET_KEY,
+    koa: {
+      port: +process.env.LISTEN_PORT || 7001,
+      globalPrefix: '/api',
+    },
+    typeorm: {
+      dataSource: {
+        default: {
+          type: 'mysql',
+          // 以下为 MySQL 配置
+          username: 'root',
+          password: 'root',
+          port: 3306,
+          database: 'dev_music',
+          charset: 'utf8mb4',
+          // 生产环境，不同步数据库表结构
+          synchronize: process.env.NODE_ENV !== 'production',
+          logging: false,
+          entities: Object.values(Entities),
+        },
+      },
+    },
+    jwt: {
+      secret: SERCRET_KEY,
+      /**
+       * 过期时间，秒
+       */
+      expiresIn: 60 * 60 * 24,
+    },
+    passport: {
+      /**
+       * 不序列化到 session
+       */
+      session: false,
+    },
+    validate: {
+      validationOptions: {
+        // 允许传递未定义的参数
+        allowUnknown: true,
+      },
+    },
+  };
+};

package/template-admin-server/src/configuration.ts

@@ -0,0 +1,47 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-27 11:02:18
+ * @LastEditTime: 2023-01-09 15:05:25
+ * @Description:
+ */
+import { Configuration, App } from '@midwayjs/decorator';
+import * as koa from '@midwayjs/koa';
+import * as validate from '@midwayjs/validate';
+import * as info from '@midwayjs/info';
+import * as orm from '@midwayjs/typeorm';
+import * as passport from '@midwayjs/passport';
+import * as jwt from '@midwayjs/jwt';
+import * as cache from '@midwayjs/cache';
+import { join } from 'path';
+// import { DefaultErrorFilter } from './filter/default.filter';
+// import { NotFoundFilter } from './filter/notfound.filter';
+import { ReportMiddleware, HelperMiddleware, JwtPassportMiddleware } from './middleware';
+
+@Configuration({
+  imports: [
+    koa,
+    orm,
+    jwt,
+    passport,
+    validate,
+    {
+      // 环境探测，类似于 php-info，仅 dev 模式启用
+      // 访问 /_info 可以查看
+      component: info,
+      enabledEnvironment: ['local'],
+    },
+    cache
+  ],
+  importConfigs: [join(__dirname, './config')],
+})
+export class ContainerLifeCycle {
+  @App()
+  app: koa.Application;
+
+  async onReady() {
+    // add middleware
+    this.app.useMiddleware([ReportMiddleware, HelperMiddleware, JwtPassportMiddleware]);
+    // add filter
+    // this.app.useFilter([NotFoundFilter, DefaultErrorFilter]);
+  }
+}