@voxgig/sdkgen 4.32.1 → 4.34.0

package/src/action/target.ts

@@ -56,6 +56,9 @@ import {
 import { kindModel, kindIndex, resolveKind, escapeRe } from './kind'
 
 import { BUNDLED, resolveSource, registerInstalled } from './resolve'
+import type { Source } from './resolve'
+
+import { recordCopies } from './copies'
 
 
 const CMD_MAP: any = {
@@ -125,11 +128,15 @@ async function target_add(targets: string[], actx: ActionContext): Promise<Actio
     ...Object.keys(featuremodel).filter((n: string) => false !== featuremodel[n]?.active),
   ]))
 
+  const installed: Source[] = []
+
   const jres = await jostraca.generate(opts, () =>
-    TargetRoot({ targets, features, actx }))
+    TargetRoot({ targets, features, actx, installed }))
 
   showChanges(opts.log, 'target-result', jres)
 
+  recordCopies(actx, jres, 'target', installed)
+
   if (actx.opts.dryrun) {
     showDryrun(opts.log, 'target-result', jres, actx.folder)
   }
@@ -152,7 +159,7 @@ async function target_add(targets: string[], actx: ActionContext): Promise<Actio
 
 
 const TargetRoot = cmp(function TargetRoot(props: any) {
-  const { ctx$, targets, features, actx } = props
+  const { ctx$, targets, features, actx, installed } = props
   const { model, log } = ctx$
 
   const fs = ctx$.fs()
@@ -185,6 +192,7 @@ const TargetRoot = cmp(function TargetRoot(props: any) {
       const source = resolveKind(tref, 'target', ctx$)
       const { name: tname, folder: tfolder, origname: torigname, base } = source
       tnames.push(tname)
+      installed?.push(source)
       const targetNote = tname + (tname != tref ? ' ref:' + tref : '')
 
       log.info({

package/src/helpers/naming.ts

@@ -149,7 +149,7 @@ function isPhpReservedType(Name: string): boolean {
 
 
 const PHP_SDK_CLASSES = new Set<string>([
-  'existstest', 'featurecorpustest', 'featuretest', 'netsimtest',
+  'cleantest', 'existstest', 'featurecorpustest', 'featuretest', 'netsimtest',
   'omnismoketest', 'pipelinetest', 'primaryutilitytest',
   'readmeexamplestest', 'structutilitytest',
   'ftclient', 'ftclock', 'ftctrl', 'ftentity', 'ftharness', 'ftrecorder',

package/src/sdkgen.ts

@@ -146,6 +146,7 @@ import {
 import {
   action_doctor,
   doctor,
+  copyCheck,
 } from './action/doctor'
 import type { DoctorReport } from './action/doctor'
 
@@ -202,6 +203,16 @@ type ExternalOverride = {
 const { Jostraca } = JostracaModule
 
 
+// The `const` block every action's model carries, and so what an add
+// substitutes into the copies it writes.
+function projectConst(model: any): any {
+  const projectconst: any = { name: model.name }
+  names(projectconst, model.name)
+  projectconst.year = new Date().getFullYear()
+  return projectconst
+}
+
+
 function modelError(path: string, cause: any, rooterrs: any[]): any {
   const detail = String(cause?.msg ?? cause?.message ?? cause ?? '').trim()
 
@@ -299,6 +310,10 @@ function SdkGen(opts: SdkGenOptions) {
 
     const root = Path.resolve(folder)
 
+    // Generation renders from the copies in `.sdk`, not from the installed
+    // generator, so an outdated copy would otherwise be used without a word.
+    await warnCopies(root, model)
+
     const externalOverride = resolveExternalOverride(opts, log)
     // Snapshot the decision before preflight. In particular, do not check a
     // missing optional destination once for safety and AGAIN before writing:
@@ -364,6 +379,34 @@ function SdkGen(opts: SdkGenOptions) {
   }
 
 
+  // A warning, never a failure: a difference may be a deliberate edit, and a
+  // check that cannot run must not stop a build.
+  async function warnCopies(root: string, model: any) {
+    const sdk = Path.join(root, '.sdk')
+
+    try {
+      if (!fs.existsSync(Path.join(sdk, 'model'))) {
+        return
+      }
+
+      // Compared with the values an add substituted. Generation derives its
+      // own `const` later, in the project's Root.
+      const lines = await copyCheck({
+        fs: () => fs, log, folder: sdk,
+        model: { ...model, const: projectConst(model) },
+        url: '', jostraca, opts: { dryrun: !!opts.dryrun }, flags: {},
+      } as ActionContext)
+
+      for (const note of lines) {
+        log.warn({ point: 'generate-copies', note })
+      }
+    }
+    catch (err: any) {
+      log.debug({ point: 'generate-copies-unchecked', err: err?.message })
+    }
+  }
+
+
   async function action(
     args: string[], flags?: Record<string, any>,
   ): Promise<any> {
@@ -445,11 +488,7 @@ function SdkGen(opts: SdkGenOptions) {
       throw modelError(path, errs[0], errs)
     }
 
-    model.const = { name: model.name }
-
-    names(model.const, model.name)
-
-    model.const.year = new Date().getFullYear()
+    model.const = projectConst(model)
 
     return {
       model,
@@ -1054,6 +1093,7 @@ export {
   deriveEntityNames,
   entityCollection,
   guardModelNames,
+  projectConst,
   isReservedName,
   safeVarName,
   exampleVarName,