@voxgig/sdkgen 4.33.0 → 4.34.0

package/src/action/edition.ts

@@ -17,6 +17,9 @@ import { resolveKind, kindModel, kindIndex, kindTrees } from './kind'
 import type { TreeDef } from './kind'
 
 import { registerInstalled } from './resolve'
+import type { Source } from './resolve'
+
+import { recordCopies } from './copies'
 
 import { aliasCmpTree, pruneStaleTemplates } from './target'
 
@@ -107,8 +110,12 @@ async function edition_add(
   // Later items in the command read this in-memory registration.
   registerInstalled('edition', edition, actx)
 
+  const installed: Source[] = []
+
   const jres = await jostraca.generate(opts, () =>
-    EditionRoot({ edition, actx }))
+    EditionRoot({ edition, actx, installed }))
+
+  recordCopies(actx, jres, 'edition', installed)
 
   return { jres }
 }
@@ -139,7 +146,7 @@ function preflight(edition: string[], actx: ActionContext) {
 
 
 const EditionRoot = cmp(function EditionRoot(props: any) {
-  const { ctx$, edition } = props
+  const { ctx$, edition, installed } = props
   const { log } = ctx$
 
   Project({}, () => {
@@ -153,6 +160,7 @@ const EditionRoot = cmp(function EditionRoot(props: any) {
       const source = resolveKind(dref, 'edition', ctx$)
 
       dnames.push(source.name)
+      installed?.push(source)
 
       log.info({
         point: 'edition-name', edition: source.name, folder: source.folder, ref: dref,

package/src/action/feature.ts

@@ -32,6 +32,9 @@ import { templateReplacements } from '../helpers/stdrep'
 import { copyOpts } from '../helpers/junk'
 
 import { resolveKind, kindModel, kindIndex } from './kind'
+import type { Source } from './resolve'
+
+import { recordCopies } from './copies'
 
 
 import {
@@ -111,10 +114,15 @@ async function feature_add(features: string[], actx: ActionContext): Promise<Act
     note: (actx.opts.dryrun ? '** DRY RUN **' : '')
   })
 
-  const jres = await jostraca.generate(opts, () => FeatureRoot({ features }))
+  const installed: Source[] = []
+
+  const jres = await jostraca.generate(opts, () =>
+    FeatureRoot({ features, installed }))
 
   showChanges(opts.log, 'feature-result', jres)
 
+  recordCopies(actx, jres, 'feature', installed)
+
   if (actx.opts.dryrun) {
     showDryrun(opts.log, 'feature-result', jres, actx.folder)
   }
@@ -131,7 +139,7 @@ async function feature_add(features: string[], actx: ActionContext): Promise<Act
 
 
 const FeatureRoot = cmp(function FeatureRoot(props: any) {
-  const { ctx$, features } = props
+  const { ctx$, features, installed } = props
   const { model, log } = ctx$
 
   const fs = ctx$.fs()
@@ -167,6 +175,7 @@ const FeatureRoot = cmp(function FeatureRoot(props: any) {
 
       const fname = source.name
       fnames.push(fname)
+      installed?.push(source)
 
       log.info({
         point: 'feature-build',

package/src/action/package.ts

@@ -29,6 +29,8 @@ import { cmd_package_check } from './check'
 
 import { doctor } from './doctor'
 
+import { COPIES } from './copies'
+
 import { resolveSource, registerInstalled, nameConflict } from './resolve'
 import type { Source } from './resolve'
 
@@ -639,6 +641,16 @@ async function preCheck(
 
   const report = res.report
 
+  // Unchanged since an add wrote them, so refreshing them loses nothing.
+  if (0 < report.outdated.length) {
+    actx.log.info({
+      point: 'package-update-outdated', package: pkgname,
+      files: report.outdated.length,
+      note: pkgname + ': ' + report.outdated.length + ' outdated file(s) ' +
+        'will be refreshed; ' + COPIES + ' shows nothing in them was changed'
+    })
+  }
+
   const changed = [...report.forked, ...report.edited]
 
   if (0 === changed.length) {
@@ -654,19 +666,28 @@ async function preCheck(
     return
   }
 
+  const unrecorded = new Set<string>(report.unrecorded)
+  const edited = changed.filter((file: string) => !unrecorded.has(file))
+  const unknown = changed.filter((file: string) => unrecorded.has(file))
+
   throw new SdkGenError(
     pkgname + ': ' + changed.length + ' file(s) differ from the installed ' +
     'source, so updating would overwrite them:\n  ' + changed.join('\n  ') +
-    '\n\n  This means one of two things, and nothing recorded in the project ' +
-    'tells them apart:' +
-    '\n    - they are LOCAL EDITS, and `--force` will discard them;' +
-    '\n    - or ' + pkgname + ' was already updated out of band (an ' +
-    '`npm update` in another shell), in which case they are merely STALE ' +
-    'and nothing is at risk.' +
-    '\n\n  If you did not update it: copy anything you want to keep into ' +
-    '.sdk/model/, then re-run with --force.' +
-    '\n  If you did: reinstall the version you had, re-run this command, ' +
-    'and it will check against the right source.')
+    (0 === edited.length ? '' :
+      '\n\n  ' + edited.length + ' of them changed in this project after ' +
+      'an add wrote them (' + COPIES + ' records what it wrote), so updating ' +
+      'would discard those edits.') +
+    (0 === unknown.length ? '' :
+      '\n\n  ' + unknown.length + ' of them predate ' + COPIES + ', so ' +
+      'nothing tells these two apart:' +
+      '\n    - they are LOCAL EDITS, and `--force` will discard them;' +
+      '\n    - or ' + pkgname + ' was already updated out of band (an ' +
+      '`npm update` in another shell), in which case they are merely STALE ' +
+      'and nothing is at risk.' +
+      '\n  If you updated it and changed nothing, --force is safe. To check ' +
+      'first, reinstall the version you had and re-run this command.') +
+    '\n\n  Copy anything you want to keep into .sdk/model/, then re-run ' +
+    'with --force.')
 }
 
 

package/src/action/remove.ts

@@ -29,6 +29,8 @@ import { removeIndexEntries } from './action'
 
 import { doctor } from './doctor'
 
+import { forgetCopies } from './copies'
+
 
 // Everything one `remove` would touch, decided before anything is written.
 type RemovePlan = {
@@ -121,6 +123,8 @@ async function kind_remove(
     }
 
     removed.push(...applyRemove(plan, actx, dryrun))
+
+    forgetCopies(actx, kind, plan.name)
   }
 
   log.info({

package/src/action/resolve.ts

@@ -30,6 +30,9 @@ type Source = {
   // The sdkgen package that provided it, when the source has a manifest.
   // Undefined for a bare `.sdk`-shaped folder, which stays legal.
   package?: string
+
+  // That package's version, read from the same manifest.
+  version?: string
 }
 
 
@@ -113,6 +116,8 @@ function resolveSource(ref: string, kind: string, ctx$: any): Source {
   const nroot = Path.normalize(root)
   const rootslash = nroot.endsWith(Path.sep) ? nroot : nroot + Path.sep
 
+  const owner = sourcePackage(fs, folder, kind, origname, ctx$)
+
   return {
     name,
     origname,
@@ -125,14 +130,17 @@ function resolveSource(ref: string, kind: string, ctx$: any): Source {
     // separator path that some readers handle and others do not.
     model: definitionPathAny(fs, folder, kind, origname),
 
-    package: sourcePackage(fs, folder, kind, origname, ctx$),
+    ...(null == owner ? {} : {
+      package: owner.name,
+      ...(null == owner.version ? {} : { version: owner.version }),
+    }),
   }
 }
 
 
 function sourcePackage(
   fs: any, folder: string, kind: string, origname: string, ctx$: any,
-): string | undefined {
+): { name: string, version?: string } | undefined {
   const read = readManifest(fs, folder)
 
   if (null != read.err) {
@@ -164,7 +172,12 @@ function sourcePackage(
     return undefined
   }
 
-  return read.manifest.name
+  const version = read.manifest.version
+
+  return {
+    name: read.manifest.name,
+    ...('string' === typeof version && '' !== version ? { version } : {}),
+  }
 }
 
 

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/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,