@abgov/nx-adsp 13.31.0 → 13.31.2

package/src/utils/vue-side-menu.js

@@ -11,8 +11,42 @@ exports.insertSideMenuItem = insertSideMenuItem;
 // read and change in one obvious place -- not behaviour resolved at runtime by
 // the shell that every app then has to work around.
 const ANCHOR = 'const primaryItems = [';
+// Finds the `]` closing the array literal that ANCHOR opens, so items can be
+// appended at the end rather than inserted at the head. Tracks nesting depth and
+// skips over string literals, so a label containing a bracket can't end the scan
+// early. Returns -1 if the literal is unterminated (a hand-edited App.vue we
+// shouldn't touch).
+function findArrayEnd(content, openIndex) {
+    let depth = 1;
+    let quote = null;
+    for (let i = openIndex; i < content.length; i++) {
+        const ch = content[i];
+        if (quote) {
+            if (ch === '\\')
+                i++;
+            else if (ch === quote)
+                quote = null;
+            continue;
+        }
+        if (ch === "'" || ch === '"' || ch === '`')
+            quote = ch;
+        else if (ch === '[' || ch === '{')
+            depth++;
+        else if (ch === ']' || ch === '}') {
+            depth--;
+            if (depth === 0)
+                return i;
+        }
+    }
+    return -1;
+}
 /**
- * Adds a nav item to a generated app's side menu.
+ * Appends a nav item to a generated app's side menu.
+ *
+ * Appends rather than prepends so the shell's own 'Home' entry stays first and
+ * generated items accumulate in the order they were run. Inserting at the head
+ * (an earlier version of this function) pushed Home to the bottom of the nav
+ * after the first generator run, which no consuming app wants.
  *
  * A no-op when the app has no `primaryItems` array. That is the signal the app
  * was generated with `--layout=header` (a public app has no side menu at all),
@@ -33,9 +67,20 @@ function insertSideMenuItem(host, projectRoot, item) {
         return;
     if (content.includes(`to: '${item.to}'`))
         return;
-    const insertAt = anchorIndex + ANCHOR.length;
-    host.write(appPath, content.slice(0, insertAt) +
-        `\n  { label: '${item.label}', to: '${item.to}' },` +
-        content.slice(insertAt));
+    const openIndex = anchorIndex + ANCHOR.length;
+    const closeIndex = findArrayEnd(content, openIndex);
+    if (closeIndex === -1)
+        return;
+    const icon = item.icon ? `, icon: '${item.icon}'` : '';
+    const entry = `{ label: '${item.label}', to: '${item.to}'${icon} },`;
+    // Trim the whitespace ahead of the closing bracket and re-emit it, rather than
+    // inserting in front of it: the array may already end with a newline (a
+    // previous append) or not (the one-line literal formatFiles produces), and
+    // prepending a newline to the former leaves a blank line between entries.
+    const head = content.slice(0, closeIndex).replace(/\s+$/, '');
+    // The last element may or may not carry a trailing comma depending on whether
+    // formatFiles has run; add one if it's missing so appending stays valid.
+    const separator = head.endsWith('[') || head.endsWith(',') ? '' : ',';
+    host.write(appPath, `${head}${separator}\n  ${entry}\n` + content.slice(closeIndex));
 }
 //# sourceMappingURL=vue-side-menu.js.map

package/src/utils/vue-side-menu.js.map

@@ -1 +1 @@
-{"version":3,"file":"vue-side-menu.js","sourceRoot":"","sources":["../../../../../packages/nx-adsp/src/utils/vue-side-menu.ts"],"names":[],"mappings":";;AA+BA,gDAqBC;AA3CD,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,EAAE;AACF,iFAAiF;AACjF,8EAA8E;AAC9E,iFAAiF;AACjF,+EAA+E;AAC/E,oDAAoD;AACpD,MAAM,MAAM,GAAG,wBAAwB,CAAC;AAExC;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAChC,IAAU,EACV,WAAmB,EACnB,IAAsB;;IAEtB,MAAM,OAAO,GAAG,GAAG,WAAW,cAAc,CAAC;IAC7C,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,0CAAE,QAAQ,EAAE,CAAC;IAC/C,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO;IAElC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,OAAO;IAE/B,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,IAAI,CAAC,EAAE,GAAG,CAAC;QAAE,OAAO;IAEjD,MAAM,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,IAAI,CAAC,KAAK,CACR,OAAO,EACP,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC;QACxB,iBAAiB,IAAI,CAAC,KAAK,WAAW,IAAI,CAAC,EAAE,MAAM;QACnD,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAC1B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"vue-side-menu.js","sourceRoot":"","sources":["../../../../../packages/nx-adsp/src/utils/vue-side-menu.ts"],"names":[],"mappings":";;AAoEA,gDAmCC;AAvFD,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,EAAE;AACF,iFAAiF;AACjF,8EAA8E;AAC9E,iFAAiF;AACjF,+EAA+E;AAC/E,oDAAoD;AACpD,MAAM,MAAM,GAAG,wBAAwB,CAAC;AAExC,6EAA6E;AAC7E,iFAAiF;AACjF,iFAAiF;AACjF,6EAA6E;AAC7E,oBAAoB;AACpB,SAAS,YAAY,CAAC,OAAe,EAAE,SAAiB;IACtD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAkB,IAAI,CAAC;IAChC,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChD,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,EAAE,KAAK,IAAI;gBAAE,CAAC,EAAE,CAAC;iBAChB,IAAI,EAAE,KAAK,KAAK;gBAAE,KAAK,GAAG,IAAI,CAAC;YACpC,SAAS;QACX,CAAC;QACD,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;YAAE,KAAK,GAAG,EAAE,CAAC;aAClD,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;YAAE,KAAK,EAAE,CAAC;aACtC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YAClC,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,KAAK,CAAC;gBAAE,OAAO,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,kBAAkB,CAChC,IAAU,EACV,WAAmB,EACnB,IAAsB;;IAEtB,MAAM,OAAO,GAAG,GAAG,WAAW,cAAc,CAAC;IAC7C,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,0CAAE,QAAQ,EAAE,CAAC;IAC/C,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO;IAElC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,OAAO;IAE/B,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,IAAI,CAAC,EAAE,GAAG,CAAC;QAAE,OAAO;IAEjD,MAAM,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpD,IAAI,UAAU,KAAK,CAAC,CAAC;QAAE,OAAO;IAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,MAAM,KAAK,GAAG,aAAa,IAAI,CAAC,KAAK,WAAW,IAAI,CAAC,EAAE,IAAI,IAAI,KAAK,CAAC;IAErE,+EAA+E;IAC/E,wEAAwE;IACxE,2EAA2E;IAC3E,0EAA0E;IAC1E,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAE9D,8EAA8E;IAC9E,yEAAyE;IACzE,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAEtE,IAAI,CAAC,KAAK,CACR,OAAO,EACP,GAAG,IAAI,GAAG,SAAS,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAChE,CAAC;AACJ,CAAC"}

package/src/utils/vue-side-menu.spec.ts

@@ -68,4 +68,104 @@ describe('insertSideMenuItem', () => {
       insertSideMenuItem(host, 'apps/missing', { label: 'X', to: '/x' }),
     ).not.toThrow();
   });
+
+  // The original spec asserted both items were present but never their relative
+  // order, so it passed while the function prepended and pushed Home to the
+  // bottom of every generated app's nav.
+  it("appends after the shell's own Home entry rather than before it", () => {
+    host.write('apps/staff/src/App.vue', INTERNAL_APP);
+    insertSideMenuItem(host, 'apps/staff', {
+      label: 'Review queue',
+      to: '/queue',
+    });
+    const app = host.read('apps/staff/src/App.vue')?.toString() ?? '';
+    expect(app.indexOf("to: '/'")).toBeLessThan(app.indexOf("to: '/queue'"));
+  });
+
+  it('accumulates multiple items in the order they were added', () => {
+    host.write('apps/staff/src/App.vue', INTERNAL_APP);
+    insertSideMenuItem(host, 'apps/staff', { label: 'Queue', to: '/queue' });
+    insertSideMenuItem(host, 'apps/staff', {
+      label: 'Livestock categories',
+      to: '/livestock',
+    });
+    const app = host.read('apps/staff/src/App.vue')?.toString() ?? '';
+    expect(app.indexOf("to: '/'")).toBeLessThan(app.indexOf("to: '/queue'"));
+    expect(app.indexOf("to: '/queue'")).toBeLessThan(
+      app.indexOf("to: '/livestock'"),
+    );
+  });
+
+  it('emits the icon, which the element needs to render a non-blank item', () => {
+    host.write('apps/staff/src/App.vue', INTERNAL_APP);
+    insertSideMenuItem(host, 'apps/staff', {
+      label: 'Queue',
+      to: '/queue',
+      icon: 'list',
+    });
+    expect(host.read('apps/staff/src/App.vue')?.toString()).toContain(
+      "{ label: 'Queue', to: '/queue', icon: 'list' },",
+    );
+  });
+
+  it('appends validly when the array literal has no trailing comma', () => {
+    host.write(
+      'apps/staff/src/App.vue',
+      `<script setup lang="ts">
+const primaryItems = [{ label: 'Home', to: '/' }];
+</script>
+`,
+    );
+    insertSideMenuItem(host, 'apps/staff', { label: 'Queue', to: '/queue' });
+    const app = host.read('apps/staff/src/App.vue')?.toString() ?? '';
+    expect(app).toContain("{ label: 'Home', to: '/' },");
+    expect(app.indexOf("to: '/'")).toBeLessThan(app.indexOf("to: '/queue'"));
+  });
+
+  it('does not end its scan early on a bracket inside a label', () => {
+    host.write(
+      'apps/staff/src/App.vue',
+      `<script setup lang="ts">
+const primaryItems = [
+  { label: 'Reports [beta]', to: '/reports' },
+];
+</script>
+`,
+    );
+    insertSideMenuItem(host, 'apps/staff', { label: 'Queue', to: '/queue' });
+    const app = host.read('apps/staff/src/App.vue')?.toString() ?? '';
+    expect(app.indexOf("to: '/reports'")).toBeLessThan(
+      app.indexOf("to: '/queue'"),
+    );
+  });
+
+  it('is a silent no-op on an unterminated array literal', () => {
+    const broken = `<script setup lang="ts">
+const primaryItems = [
+</script>
+`;
+    host.write('apps/staff/src/App.vue', broken);
+    insertSideMenuItem(host, 'apps/staff', { label: 'Queue', to: '/queue' });
+    expect(host.read('apps/staff/src/App.vue')?.toString()).toBe(broken);
+  });
+
+  it('does not leave blank lines between accumulated entries', () => {
+    host.write('apps/staff/src/App.vue', INTERNAL_APP);
+    insertSideMenuItem(host, 'apps/staff', {
+      label: 'A',
+      to: '/a',
+      icon: 'list',
+    });
+    insertSideMenuItem(host, 'apps/staff', {
+      label: 'B',
+      to: '/b',
+      icon: 'list',
+    });
+    const app = host.read('apps/staff/src/App.vue')?.toString() ?? '';
+    const array = app.slice(
+      app.indexOf('const primaryItems = ['),
+      app.indexOf('];') + 2,
+    );
+    expect(array).not.toMatch(/\n\s*\n/);
+  });
 });

package/src/utils/vue-tsconfig.d.ts

@@ -0,0 +1,26 @@
+import { Tree } from '@nx/devkit';
+/**
+ * Backfills a `module` setting on a generated Vue project's tsconfig when it
+ * declares `moduleResolution: "bundler"` without one.
+ *
+ * @nx/vue's library and application generators write `moduleResolution:
+ * "bundler"` into the project's tsconfig.json but leave `module` to be
+ * inherited. In a create-nx-workspace TS-solution workspace the base sets
+ * `module: "nodenext"`, and that pair is invalid two ways over:
+ *
+ *   error TS5095: Option 'bundler' can only be used when 'module' is set to
+ *                 'preserve', 'commonjs', or 'es2015' or later.
+ *   error TS5109: Option 'moduleResolution' must be set to 'NodeNext' (or left
+ *                 unspecified) when option 'module' is set to 'NodeNext'.
+ *
+ * so `nx build` fails on completely unmodified generator output. `esnext`
+ * matches what @nx/vue itself writes beside `bundler` in the app's
+ * tsconfig.app.json, so this aligns the project with its own sibling config
+ * rather than introducing a third convention.
+ *
+ * Deliberately conditional and idempotent: it only acts when
+ * `moduleResolution` is bundler-flavoured *and* `module` is absent, so a
+ * project whose tsconfig is already valid -- or which has been deliberately
+ * pinned to something else -- is left alone.
+ */
+export declare function ensureBundlerModuleOption(host: Tree, tsconfigPath: string): void;

package/src/utils/vue-tsconfig.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureBundlerModuleOption = ensureBundlerModuleOption;
+const devkit_1 = require("@nx/devkit");
+// `moduleResolution` values that TypeScript only accepts alongside a
+// bundler-compatible `module` (TS5095) and which additionally conflict with an
+// inherited `module: nodenext` (TS5109).
+const BUNDLER_RESOLUTIONS = ['bundler', 'Bundler'];
+/**
+ * Backfills a `module` setting on a generated Vue project's tsconfig when it
+ * declares `moduleResolution: "bundler"` without one.
+ *
+ * @nx/vue's library and application generators write `moduleResolution:
+ * "bundler"` into the project's tsconfig.json but leave `module` to be
+ * inherited. In a create-nx-workspace TS-solution workspace the base sets
+ * `module: "nodenext"`, and that pair is invalid two ways over:
+ *
+ *   error TS5095: Option 'bundler' can only be used when 'module' is set to
+ *                 'preserve', 'commonjs', or 'es2015' or later.
+ *   error TS5109: Option 'moduleResolution' must be set to 'NodeNext' (or left
+ *                 unspecified) when option 'module' is set to 'NodeNext'.
+ *
+ * so `nx build` fails on completely unmodified generator output. `esnext`
+ * matches what @nx/vue itself writes beside `bundler` in the app's
+ * tsconfig.app.json, so this aligns the project with its own sibling config
+ * rather than introducing a third convention.
+ *
+ * Deliberately conditional and idempotent: it only acts when
+ * `moduleResolution` is bundler-flavoured *and* `module` is absent, so a
+ * project whose tsconfig is already valid -- or which has been deliberately
+ * pinned to something else -- is left alone.
+ */
+function ensureBundlerModuleOption(host, tsconfigPath) {
+    if (!host.exists(tsconfigPath))
+        return;
+    (0, devkit_1.updateJson)(host, tsconfigPath, (tsconfig) => {
+        const compilerOptions = tsconfig.compilerOptions;
+        if (!compilerOptions)
+            return tsconfig;
+        if (!BUNDLER_RESOLUTIONS.includes(compilerOptions.moduleResolution)) {
+            return tsconfig;
+        }
+        if (compilerOptions.module)
+            return tsconfig;
+        compilerOptions.module = 'esnext';
+        return tsconfig;
+    });
+}
+//# sourceMappingURL=vue-tsconfig.js.map

package/src/utils/vue-tsconfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue-tsconfig.js","sourceRoot":"","sources":["../../../../../packages/nx-adsp/src/utils/vue-tsconfig.ts"],"names":[],"mappings":";;AA+BA,8DAiBC;AAhDD,uCAA8C;AAE9C,qEAAqE;AACrE,+EAA+E;AAC/E,yCAAyC;AACzC,MAAM,mBAAmB,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,yBAAyB,CACvC,IAAU,EACV,YAAoB;IAEpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;QAAE,OAAO;IAEvC,IAAA,mBAAU,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC1C,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC;QACjD,IAAI,CAAC,eAAe;YAAE,OAAO,QAAQ,CAAC;QACtC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,IAAI,eAAe,CAAC,MAAM;YAAE,OAAO,QAAQ,CAAC;QAE5C,eAAe,CAAC,MAAM,GAAG,QAAQ,CAAC;QAClC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}