create-react-admin-template 0.0.0-stage → 0.1.0

package/template/tools/scaffold/workspace-transaction.mjs

@@ -0,0 +1,111 @@
+import { mkdir, rename, rm, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+
+const fnCleanupPaths = async (arrPaths) => {
+  await Promise.all(
+    arrPaths.map((strFilePath) => rm(strFilePath, { force: true }))
+  )
+}
+
+/**
+ * 原子替换一组已存在文件；任意一步失败时恢复全部旧文件并清理临时产物。
+ */
+export async function fnCommitFileReplacementTransaction({
+  arrPlans,
+  fnCreateError,
+  strTransactionName,
+}) {
+  const arrPreparedPlans = arrPlans.map((objPlan, nIndex) => ({
+    ...objPlan,
+    strBackupPath: `${objPlan.strTargetPath}.${strTransactionName}-${process.pid}-${nIndex}.bak`,
+    strTemporaryPath: `${objPlan.strTargetPath}.${strTransactionName}-${process.pid}-${nIndex}.tmp`,
+  }))
+  const arrReplacedPlans = []
+
+  try {
+    await Promise.all(
+      arrPreparedPlans.map((objPlan) =>
+        writeFile(objPlan.strTemporaryPath, objPlan.strContent, {
+          flag: 'wx',
+          mode: objPlan.nMode,
+        })
+      )
+    )
+    for (const objPlan of arrPreparedPlans) {
+      await rename(objPlan.strTargetPath, objPlan.strBackupPath)
+      try {
+        await rename(objPlan.strTemporaryPath, objPlan.strTargetPath)
+      } catch (objError) {
+        await rename(objPlan.strBackupPath, objPlan.strTargetPath)
+        throw objError
+      }
+      arrReplacedPlans.push(objPlan)
+    }
+    await fnCleanupPaths(
+      arrPreparedPlans.map((objPlan) => objPlan.strBackupPath)
+    )
+  } catch (objError) {
+    for (const objPlan of arrReplacedPlans.reverse()) {
+      await rm(objPlan.strTargetPath, { force: true })
+      await rename(objPlan.strBackupPath, objPlan.strTargetPath)
+    }
+    throw fnCreateError(objError)
+  } finally {
+    await fnCleanupPaths(
+      arrPreparedPlans.flatMap((objPlan) => [
+        objPlan.strTemporaryPath,
+        objPlan.strBackupPath,
+      ])
+    )
+  }
+}
+
+function fnIsPathOwnedByDirectories(strFilePath, arrDirectoryPaths) {
+  return arrDirectoryPaths.some((strDirectoryPath) => {
+    const strRelativePath = path.relative(strDirectoryPath, strFilePath)
+    return (
+      strRelativePath &&
+      !strRelativePath.startsWith('..') &&
+      !path.isAbsolute(strRelativePath)
+    )
+  })
+}
+
+/**
+ * 创建一组新目录和文件；拒绝目录外目标，失败时只清理本次创建的目录。
+ */
+export async function fnCommitCreatedDirectoriesTransaction({
+  arrDirectoryPaths,
+  arrFiles,
+  fnCreateError,
+}) {
+  const objUnsafeFile = arrFiles.find(
+    (objFile) =>
+      !fnIsPathOwnedByDirectories(objFile.strTargetPath, arrDirectoryPaths)
+  )
+  if (objUnsafeFile) {
+    throw fnCreateError(
+      new TypeError(`写入目标不属于事务目录：${objUnsafeFile.strTargetPath}`)
+    )
+  }
+
+  const arrCreatedDirectories = []
+  try {
+    for (const strDirectoryPath of arrDirectoryPaths) {
+      await mkdir(strDirectoryPath)
+      arrCreatedDirectories.push(strDirectoryPath)
+    }
+    await Promise.all(
+      arrFiles.map((objFile) =>
+        writeFile(objFile.strTargetPath, objFile.strContent, { flag: 'wx' })
+      )
+    )
+  } catch (objError) {
+    await Promise.all(
+      arrCreatedDirectories.map((strDirectoryPath) =>
+        rm(strDirectoryPath, { force: true, recursive: true })
+      )
+    )
+    throw fnCreateError(objError)
+  }
+}

package/template/tsconfig.app.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "Bundler",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Alias */
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["src", "tests", "tools/scaffold/templates/feature"]
+}

package/template/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ],
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/template/tsconfig.node.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2022",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "Bundler",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts", "knip.config.ts", "build/**/*.ts"]
+}

package/template/vite.config.ts

@@ -0,0 +1,121 @@
+/// <reference types="vitest/config" />
+import path from 'path'
+import { defineConfig, loadEnv } from 'vite'
+import react from '@vitejs/plugin-react'
+import tailwindcss from '@tailwindcss/vite'
+import { playwright } from '@vitest/browser-playwright'
+import { execFileSync } from 'node:child_process'
+import { readFileSync } from 'node:fs'
+import removeConsole from 'vite-plugin-remove-console'
+import {
+  fnCreateAppTableBuildGuard,
+  fnResolveAdvancedTableManualChunk,
+} from './build/advancedTable.ts'
+import { fnResolveBuildEnvironment } from './build/environment.ts'
+
+const strProjectRoot = import.meta.dirname
+const strPackageSource = readFileSync(
+  new URL('./package.json', import.meta.url),
+  'utf8'
+)
+const strAppVersion =
+  /"version"\s*:\s*"([^"]+)"/.exec(strPackageSource)?.[1] ?? '0.0.0'
+
+function fnResolveBuildCommit() {
+  const strCiCommit =
+    process.env.CI_COMMIT_SHA?.trim() ?? process.env.GIT_COMMIT_SHA?.trim()
+  if (strCiCommit) return strCiCommit
+
+  try {
+    return execFileSync('git', ['rev-parse', 'HEAD'], {
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'ignore'],
+    }).trim()
+  } catch {
+    return 'unknown'
+  }
+}
+
+// https://vite.dev/config/
+export default defineConfig(({ command: strCommand, mode: strMode }) => {
+  const objEnv = loadEnv(strMode, strProjectRoot)
+  const {
+    bApiInsecureTls,
+    nPort,
+    strApiBaseUrl,
+    strApiProxy,
+    strHandsontableLicenseKey,
+    strHttpsCertPath,
+    strHttpsKeyPath,
+    strPublicPath,
+  } = fnResolveBuildEnvironment({ objEnv, strCommand, strProjectRoot })
+  const strBuildTime = new Date().toISOString()
+
+  return {
+    base: strPublicPath,
+    define: {
+      strBuildAppVersion: JSON.stringify(strAppVersion),
+      strBuildCommit: JSON.stringify(fnResolveBuildCommit()),
+      strBuildTime: JSON.stringify(strBuildTime),
+    },
+    plugins: [
+      react(),
+      tailwindcss(),
+      removeConsole({ includes: ['log'] }),
+      fnCreateAppTableBuildGuard({ strLicenseKey: strHandsontableLicenseKey }),
+    ],
+    build: {
+      manifest: true,
+      rollupOptions: {
+        output: {
+          manualChunks: fnResolveAdvancedTableManualChunk,
+        },
+      },
+    },
+    optimizeDeps: {
+      include: ['qs', 'react-dom/client', 'sonner'],
+    },
+    resolve: {
+      dedupe: ['react', 'react-dom'],
+      alias: {
+        '@': path.resolve(import.meta.dirname, './src'),
+      },
+    },
+    server: {
+      host: true,
+      strictPort: true,
+      https:
+        strHttpsCertPath && strHttpsKeyPath
+          ? {
+              cert: readFileSync(
+                path.resolve(strProjectRoot, strHttpsCertPath)
+              ),
+              key: readFileSync(path.resolve(strProjectRoot, strHttpsKeyPath)),
+            }
+          : undefined,
+      port: nPort,
+      proxy:
+        strApiProxy && strApiBaseUrl
+          ? {
+              [strApiProxy]: {
+                target: strApiBaseUrl,
+                changeOrigin: true,
+                secure: !bApiInsecureTls,
+              },
+            }
+          : undefined,
+    },
+    test: {
+      attachmentsDir: 'node_modules/.cache/vitest/attachments',
+      include: ['tests/**/*.{test,spec}.{ts,tsx}'],
+      setupFiles: ['./tests/setup/runtimeConfig.ts'],
+      silent: 'passed-only',
+      unstubEnvs: true,
+      browser: {
+        enabled: true,
+        provider: playwright(),
+        instances: [{ browser: 'chromium' }],
+      },
+    },
+  }
+})