minor refactoring (#143)

brillout · Jan 31, 2025 · 0be4e5d · 0be4e5d
1 parent 20ec17b
commit 0be4e5d
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/...ver/shield/codegen/generateShield.spec.ts → ...mer/generateShield/generateShield.spec.ts b/...ver/shield/codegen/generateShield.spec.ts → ...mer/generateShield/generateShield.spec.ts
diff --git a/...e/server/shield/codegen/generateShield.ts → ...nsformer/generateShield/generateShield.ts b/...e/server/shield/codegen/generateShield.ts → ...nsformer/generateShield/generateShield.ts
@@ -13,8 +13,8 @@ import {
   objectAssign,
   unique,
   assertPosixPath,
-} from '../../../utils'
-import { type ExportList, getExportList } from '../../../transformer/getExportList'
+} from '../../utils'
+import { type ExportList, getExportList } from '../getExportList'
 import fs from 'node:fs'
 import path from 'node:path'
 import pc from '@brillout/picocolors'
@@ -26,7 +26,7 @@ type GeneratedShield = {
   project: Project & { tsConfigFilePath: null | string }
 }
 
-assertModuleScope('codegen/generateShield.ts')
+assertModuleScope('generateShield/generateShield.ts')
 const generatedShields: GeneratedShield[] = []
 let resutlAlreayLogged = false
 const projects: Record<string, Project> = {}
@@ -121,19 +121,20 @@ function generate({
   telefuncFileSource: SourceFile
   shieldGenSource: SourceFile
   telefuncFilePath: string
+  // All exports of `.telefunc.js` files must be functions, thus we generate a shield() for each export.
+  // If an export isn't a function then the error message is a bit ugly: https://github.com/brillout/telefunc/issues/142
   exportList: ExportList
 }): string {
   shieldGenSource.addImportDeclaration({
     moduleSpecifier: getTelefuncFileImportPath(telefuncFilePath),
     namedImports: exportList.map((e) => e.exportName),
   })
 
-  // assign the template literal type to a string
-  // then diagnostics are used to get the value of the template literal type
-  for (const exportedFunction of exportList) {
+  // Assign the template literal type to a string, then diagnostics are used to get the value of the template literal type.
+  for (const e of exportList) {
     shieldGenSource.addTypeAlias({
-      name: getShieldName(exportedFunction.exportName),
-      type: `ShieldArrStr<Parameters<typeof ${exportedFunction.exportName}>>`,
+      name: getShieldName(e.exportName),
+      type: `ShieldArrStr<Parameters<typeof ${e.exportName}>>`,
     })
   }
 

diff --git a/...ode/server/shield/codegen/typeToShield.ts → ...ransformer/generateShield/typeToShield.ts b/...ode/server/shield/codegen/typeToShield.ts → ...ransformer/generateShield/typeToShield.ts
diff --git a/telefunc/node/transformer/transformTelefuncFileServerSide.ts b/telefunc/node/transformer/transformTelefuncFileServerSide.ts
@@ -2,7 +2,7 @@ export { transformTelefuncFileServerSide }
 
 import { ExportList, getExportList } from './getExportList'
 import { assertPosixPath } from './utils'
-import { generateShield } from '../server/shield/codegen/generateShield'
+import { generateShield } from './generateShield/generateShield'
 import { getServerConfig } from '../server/serverConfig'
 
 async function transformTelefuncFileServerSide(

diff --git a/telefunc/node/vite/plugins/printShieldGenResult.ts b/telefunc/node/vite/plugins/printShieldGenResult.ts
@@ -1,7 +1,7 @@
 export { printShieldGenResult }
 
 import type { Plugin, ResolvedConfig } from 'vite'
-import { logResult } from '../../server/shield/codegen/generateShield'
+import { logResult } from '../../transformer/generateShield/generateShield'
 import { projectInfo } from '../utils'
 import pc from '@brillout/picocolors'
 

diff --git a/telefunc/node/webpack/install.ts b/telefunc/node/webpack/install.ts
@@ -1,7 +1,7 @@
 export { install }
 
 import { resolve } from 'node:path'
-import { logResult } from '../server/shield/codegen/generateShield'
+import { logResult } from '../transformer/generateShield/generateShield'
 import { getRoot } from './getInfo'
 import type { Compiler } from './types'
 const dir = __dirname + (() => '')() // trick to avoid `@vercel/ncc` to glob import