修复openapi的react sdk无法构建的问题

buka-lnc · May 7, 2024 · 509e5a4 · 509e5a4
1 parent 77319c0
commit 509e5a4
Show file tree

Hide file tree

Showing 11 changed files with 64 additions and 18 deletions.
diff --git a/.changeset/spicy-dolls-kneel.md b/.changeset/spicy-dolls-kneel.md
@@ -0,0 +1,6 @@
+---
+"@opendoc/backend": patch
+"@opendoc/sdk": patch
+---
+
+修复 openapi 的 react sdk 无法构建的问题
diff --git a/app/backend/src/modules/sdk/compiler.service.ts b/app/backend/src/modules/sdk/compiler.service.ts
@@ -71,7 +71,7 @@ export class CompilerService {
     const compileDir = path.join(dir, 'compiling')
 
     try {
-      await exec('npm install --production=false && npm run build', { cwd: compileDir })
+      await exec('npm install --production=false --legacy-peer-deps && npm run build', { cwd: compileDir })
     } catch (e) {
       if (e instanceof Error) {
         if ('stdout' in e) {
@@ -160,7 +160,10 @@ export class CompilerService {
         name: sdk.fullName,
         version: sdk.version,
         dependencies: {
-          core: `@${sdk.scope}/${apiDocument.code}`,
+          core: {
+            name: `@${sdk.scope}/${apiDocument.code}`,
+            version: sdk.version,
+          },
         },
       },
     })
@@ -194,7 +197,10 @@ export class CompilerService {
         name: sdk.fullName,
         version: sdk.version,
         dependencies: {
-          core: `@${sdk.scope}/${apiDocument.code}`,
+          core: {
+            name: `@${sdk.scope}/${apiDocument.code}`,
+            version: sdk.version,
+          },
         },
       },
     })

diff --git a/app/sdk/src/compile-asyncapi-core.ts b/app/sdk/src/compile-asyncapi-core.ts
@@ -34,6 +34,8 @@ function compile(options: CompileAsyncapiOptions): CompileResult[] {
       name: options.project.name,
       outdir: options.outdir,
       version: options.project.version,
+      dependencies: options.project.dependencies,
+      registry: options.project.registry,
     }
   }
 

diff --git a/app/sdk/src/compile-openapi-core.ts b/app/sdk/src/compile-openapi-core.ts
@@ -43,6 +43,8 @@ function compile(options: CompileOpenapiOptions): CompileResult[] {
       name: options.project.name,
       outdir: options.outdir,
       version: options.project.version,
+      dependencies: options.project.dependencies,
+      registry: options.project.registry,
     }
   }
 

diff --git a/app/sdk/src/compile-openapi-react.ts b/app/sdk/src/compile-openapi-react.ts
@@ -42,6 +42,7 @@ function compile(options: CompileOpenapiOptions): CompileResult[] {
       outdir: options.outdir,
       version: options.project.version,
       dependencies: options.project.dependencies,
+      registry: options.project.registry,
     }
   }
 
@@ -65,7 +66,7 @@ function compile(options: CompileOpenapiOptions): CompileResult[] {
           }
 
           {
-            const fileContent = templates.t_hook({ ...context })
+            const fileContent = templates.t_hook(R.clone(context))
             const filename = formatFilename(getSafeOperationName(pathname, method, operation))
             const filepath = path.join(output, 'hooks', `${filename}.ts`)
 

diff --git a/app/sdk/src/compile-project.ts b/app/sdk/src/compile-project.ts
@@ -1,5 +1,6 @@
 import * as fs from 'fs-extra'
 import * as path from 'path'
+import * as R from 'ramda'
 import { readAndCompileTemplate } from './utils/read-and-compile-template'
 
 import './handlebar/register-helper.js'
@@ -15,6 +16,7 @@ const templates = {
   t_build_sh: readAndCompileTemplate('project/build_sh'),
   t__gitignore: readAndCompileTemplate('project/_gitignore'),
   t__npmignore: readAndCompileTemplate('project/_npmignore'),
+  t__npmrc: readAndCompileTemplate('project/_npmrc'),
 }
 
 export async function compileProject(options: CompileProjectOptions): Promise<void> {
@@ -24,27 +26,40 @@ export async function compileProject(options: CompileProjectOptions): Promise<vo
     throw TypeError(message)
   }
 
-  const { outdir, name, version } = Value.Default(CompileProjectOptions, Value.Clone(options)) as Required<CompileProjectOptions>
-  const context = { name, version }
+  const opts = Value.Default(CompileProjectOptions, Value.Clone(options)) as Required<CompileProjectOptions>
+
+  const { outdir, name, version, dependencies, registry } = opts
+  const context = {
+    package: {
+      name,
+      outdir,
+      version,
+      registry,
+      dependencies,
+    },
+  }
 
 
   const tsconfigFilepath = path.join(outdir, 'tsconfig.json')
-  const tsconfigFileContent = templates.t_tsconfig_json(context)
+  const tsconfigFileContent = templates.t_tsconfig_json(R.clone(context))
 
   const tsconfigEsFilepath = path.join(outdir, 'tsconfig.es.json')
-  const tsconfigEsFileContent = templates.t_tsconfig_es_json(context)
+  const tsconfigEsFileContent = templates.t_tsconfig_es_json(R.clone(context))
 
   const tsconfigUmdFilepath = path.join(outdir, 'tsconfig.umd.json')
-  const tsconfigUmdFileContent = templates.t_tsconfig_umd_json(context)
+  const tsconfigUmdFileContent = templates.t_tsconfig_umd_json(R.clone(context))
 
   const buildShFilepath = path.join(outdir, 'build.sh')
-  const buildShFileContent = templates.t_build_sh(context)
+  const buildShFileContent = templates.t_build_sh(R.clone(context))
 
   const gitignoreFilepath = path.join(outdir, '.gitignore')
-  const gitignoreFileContent = templates.t__gitignore(context)
+  const gitignoreFileContent = templates.t__gitignore(R.clone(context))
 
   const npmignoreFilepath = path.join(outdir, '.npmignore')
-  const npmignoreFileContent = templates.t__npmignore(context)
+  const npmignoreFileContent = templates.t__npmignore(R.clone(context))
+
+  const npmrcFilepath = path.join(outdir, '.npmrc')
+  const npmrcFileContent = templates.t__npmrc(R.clone(context))
 
   await Promise.allSettled([
     fs.outputFile(tsconfigFilepath, tsconfigFileContent),
@@ -53,6 +68,7 @@ export async function compileProject(options: CompileProjectOptions): Promise<vo
     fs.outputFile(buildShFilepath, buildShFileContent),
     fs.outputFile(gitignoreFilepath, gitignoreFileContent),
     fs.outputFile(npmignoreFilepath, npmignoreFileContent),
+    fs.outputFile(npmrcFilepath, npmrcFileContent),
   ])
 
   await fs.chmod(buildShFilepath, 0o755)

diff --git a/app/sdk/src/interface/compile-project-options.ts b/app/sdk/src/interface/compile-project-options.ts
@@ -6,7 +6,15 @@ export const CompileProjectOptions = Type.Object({
   name: Type.String(),
   version: Type.Optional(Type.String({ default: '0.0.1' })),
 
-  dependencies: Type.Optional(Type.Record(Type.String(), Type.String())),
+  dependencies: Type.Optional(Type.Record(
+    Type.String(),
+    Type.Object({
+      name: Type.String(),
+      version: Type.String(),
+    }),
+    { default: {} }
+  )),
+  registry: Type.Optional(Type.Record(Type.String(), Type.String(), { default: {} })),
 })
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare

diff --git a/app/sdk/src/templates/openapi-react/hook.hbs b/app/sdk/src/templates/openapi-react/hook.hbs
@@ -1,7 +1,7 @@
 // @ts-nocheck
 import { useEffect, useState } from "react"
-import type { RequestParameters, ResponseMap } from "${{package.dependencies.core}}/types/{{h__change-case @root.fileNamingStyle (h__get-safe-operation-name pathname method operation)}}.js"
-import { {{h__get-safe-operation-name pathname method operation}} } from "{{package.dependencies.core}}/operations/{{h__change-case @root.fileNamingStyle (h__get-safe-operation-name pathname method operation)}}.js"
+import type { RequestParameters, ResponseMap } from "${{package.dependencies.core.name}}/types/{{h__change-case @root.fileNamingStyle (h__get-safe-operation-name pathname method operation)}}.js"
+import { {{h__get-safe-operation-name pathname method operation}} } from "{{package.dependencies.core.name}}/operations/{{h__change-case @root.fileNamingStyle (h__get-safe-operation-name pathname method operation)}}.js"
 
 
 export interface Use{{h__change-case "pascalCase" (h__get-safe-operation-name pathname method operation)}}<STATUS extends keyof ResponseMap> {

diff --git a/app/sdk/src/templates/openapi-react/package_json.hbs b/app/sdk/src/templates/openapi-react/package_json.hbs
@@ -28,7 +28,7 @@
   },
 
   "peerDependencies": {
-    "{{package.dependencies.core}}": "{{package.version}}",
+    "{{package.dependencies.core.name}}": "{{package.dependencies.core.version}}",
     "react": ">= 16"
   }
 }
diff --git a/app/sdk/src/templates/project/_npmrc.hbs b/app/sdk/src/templates/project/_npmrc.hbs
@@ -0,0 +1,5 @@
+auto-install-peers=false
+
+{{#each package.registry as |registry scope|}}
+{{scope}}={{registry}}
+{{/each}}
diff --git a/package.json b/package.json
@@ -5,8 +5,8 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "pnpm -r exec rm -rf node_modules && rm -rf node_modules",
-    "build": "turbo build --filter @opendoc/*",
-    "dev": "turbo dev --filter @opendoc/*"
+    "build": "turbo build --filter=@opendoc/* --filter=!@opendoc/frontend --filter=!@opendoc/backend",
+    "dev": "turbo dev --filter=@opendoc/* --filter=!@opendoc/frontend --filter=!@opendoc/backend"
   },
   "keywords": [
     "opendoc"