@cms-lab/cli 1.2.2 → 1.2.4

package/README.md

@@ -11,9 +11,11 @@ npx @cms-lab/cli scan
 ```sh
 cms-lab init
 cms-lab init --cms strapi --router pages
+cms-lab init --cms directus --router pages
 cms-lab doctor
 cms-lab doctor --debug --verbose 2
 cms-lab scan --report
+cms-lab scan --report --share-report
 cms-lab scan --markdown
 cms-lab scan --junit
 cms-lab scan --slack-webhook "$CMS_LAB_SLACK_WEBHOOK"
@@ -41,6 +43,8 @@ project-specific required fields.
 
 `cms-lab init --cms strapi --router pages` writes a Strapi starter config with
 collections, single types, route examples, and the Strapi relation route helper.
+`cms-lab init --cms directus --router pages` writes a Directus starter config
+with branch, menu item, category, and non-routable pricing collection examples.
 Use `site.healthPath` or `site.healthUrl` in config when the app root is not the
 right page for the initial health probe.
 
@@ -52,10 +56,13 @@ unless `--include-sensitive-output` is passed explicitly.
 CI strictness can be raised with `--fail-on warning`, `--max-warnings <count>`,
 `--max-info <count>`, or `--strict`.
 
-Exports include local HTML (`--report`), Markdown (`--markdown`), JUnit XML
-(`--junit`), and redacted Slack incoming webhook summaries
-(`--slack-webhook <url>`). Slack notifications send counts and diagnostic codes
-only, never raw CMS payloads, local paths, or webhook URLs.
+Exports include local HTML (`--report`), share-safe local HTML
+(`--report --share-report`), Markdown (`--markdown`), JUnit XML (`--junit`),
+and redacted Slack incoming webhook summaries (`--slack-webhook <url>`).
+Share-safe HTML redacts CMS source IDs and local project paths while keeping
+diagnostic codes, severity, route paths, and field paths visible. Slack
+notifications send counts and diagnostic codes only, never raw CMS payloads,
+local paths, or webhook URLs.
 
 `cms-lab agent-context` writes safe handoff files so coding agents can read the
 cms-lab docs, package links, route mappings, and safe project facts before

package/dist/bin.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   runCli
-} from "./chunk-SVTBRARJ.js";
+} from "./chunk-R7T3O3TT.js";
 
 // src/bin.ts
 var exitCode = await runCli(process.argv.slice(2));

package/dist/{chunk-SVTBRARJ.js → chunk-R7T3O3TT.js}

@@ -565,7 +565,7 @@ var noColor = {
 // src/index.ts
 async function runCli(argv, dependencies = {}) {
   let exitCode = 0;
-  const program = new Command().name("cms-lab").description("Catch CMS bugs before deploy.").version("1.2.2").exitOverride().configureOutput({
+  const program = new Command().name("cms-lab").description("Catch CMS bugs before deploy.").version("1.2.4").exitOverride().configureOutput({
     writeOut: (text) => writeStdout(dependencies, text),
     writeErr: (text) => writeStderr(dependencies, text)
   });
@@ -597,6 +597,9 @@ Examples:
   ).option(
     "--report [path]",
     "Write an HTML report. Defaults to .cms-lab/report.html"
+  ).option(
+    "--share-report",
+    "Redact CMS source IDs and local project paths in the HTML report"
   ).option(
     "--markdown [path]",
     "Write a Markdown summary. Defaults to .cms-lab/summary.md"
@@ -666,19 +669,20 @@ Examples:
   });
   program.command("init").description("Create a starter cms-lab.config.ts file.").option("--config <path>", "Config file path", "cms-lab.config.ts").option("--force", "Overwrite an existing config file").option(
     "--cms <provider>",
-    "Starter CMS provider: prismic or strapi",
+    "Starter CMS provider: prismic, strapi, or directus",
     "prismic"
   ).option("--router <router>", "Next.js router: app or pages", "app").option("--repository <name>", "Prismic repository name", "my-repo").option("--url <url>", "Site URL", "http://localhost:3000").option(
     "--strapi-url <url>",
     "Strapi REST API URL",
     "http://localhost:1337"
-  ).option("--strapi-locale <locale>", "Strapi locale query param").addHelpText(
+  ).option("--strapi-locale <locale>", "Strapi locale query param").option("--directus-url <url>", "Directus API URL", "http://localhost:8055").addHelpText(
     "after",
     `
 Examples:
   cms-lab init
   cms-lab init --repository my-prismic-repo --url http://localhost:3000
   cms-lab init --cms strapi --router pages --strapi-url http://localhost:1337
+  cms-lab init --cms directus --router pages --directus-url http://localhost:8055
   cms-lab init --config cms-lab.config.ts --force
 `
   ).action(async (options) => {
@@ -809,7 +813,9 @@ async function runScan(options, dependencies) {
     });
     const status = exitCode === 0 ? "passed" : "failed";
     const endReport = debug.time("exports", 2);
-    await maybeWriteReport(options.report, result, cwd);
+    await maybeWriteReport(options.report, result, cwd, {
+      share: Boolean(options.shareReport)
+    });
     await maybeWriteMarkdown(options.markdown, result, status, cwd);
     await maybeWriteJUnit(options.junit, result, cwd);
     const slackSent = await maybePostSlack({
@@ -1504,13 +1510,17 @@ function exitCodeForResult(result, options) {
 function thresholdExceeded(result, maxWarnings, maxInfo) {
   return maxWarnings !== void 0 && result.summary.warnings > maxWarnings || maxInfo !== void 0 && result.summary.info > maxInfo;
 }
-async function maybeWriteReport(report, result, cwd) {
+async function maybeWriteReport(report, result, cwd, options = {}) {
   if (!report) {
     return;
   }
   const path = reportPathFromOption(report, cwd);
   await mkdir(dirname(path), { recursive: true });
-  await writeFile(path, renderHtmlReport(result), "utf8");
+  await writeFile(
+    path,
+    renderHtmlReport(result, { privacy: options.share ? "share" : "full" }),
+    "utf8"
+  );
 }
 function reportPathFromOption(report, cwd) {
   return resolve(
@@ -1612,8 +1622,10 @@ function plural3(value, singular) {
 }
 function parseInitOptions(options) {
   const cms = options.cms ?? "prismic";
-  if (cms !== "prismic" && cms !== "strapi") {
-    throw new ConfigLoadError("--cms must be one of: prismic, strapi");
+  if (cms !== "prismic" && cms !== "strapi" && cms !== "directus") {
+    throw new ConfigLoadError(
+      "--cms must be one of: prismic, strapi, directus"
+    );
   }
   const router = options.router ?? "app";
   if (router !== "app" && router !== "pages") {
@@ -1625,13 +1637,17 @@ function parseInitOptions(options) {
     repository: options.repository ?? "my-repo",
     url: options.url ?? "http://localhost:3000",
     strapiUrl: options.strapiUrl ?? "http://localhost:1337",
-    strapiLocale: options.strapiLocale
+    strapiLocale: options.strapiLocale,
+    directusUrl: options.directusUrl ?? "http://localhost:8055"
   };
 }
 function starterConfig(options) {
   if (options.cms === "strapi") {
     return strapiStarterConfig(options);
   }
+  if (options.cms === "directus") {
+    return directusStarterConfig(options);
+  }
   return `import { defineConfig } from "@cms-lab/core";
 
 export default defineConfig({
@@ -1653,6 +1669,71 @@ export default defineConfig({
 });
 `;
 }
+function directusStarterConfig(options) {
+  return `import { defineConfig, readCmsDataPath } from "@cms-lab/core";
+
+export default defineConfig({
+  site: {
+    url: ${JSON.stringify(options.url)},
+    // Use healthPath when your app's root redirects or errors but a locale route is healthy.
+    // healthPath: "/en",
+  },
+  framework: { type: "next", router: ${JSON.stringify(options.router)} },
+  cms: {
+    provider: "directus",
+    url: ${JSON.stringify(options.directusUrl)},
+    token: process.env.DIRECTUS_TOKEN,
+    collections: [
+      { type: "branch", collection: "branches", uidField: "slug" },
+      { type: "menu_item", collection: "menu_items", uidField: "slug" },
+      { type: "category", collection: "menu_categories", uidField: "slug" },
+      {
+        type: "pricing",
+        collection: "item_branch_pricing",
+        uidField: "id",
+        routable: false,
+      },
+    ],
+  },
+  routes: [
+    {
+      type: "branch",
+      pattern: "/branches/:slug",
+      getPath: (doc) => \`/branches/\${doc.uid}\`,
+    },
+    {
+      type: "category",
+      pattern: "/categories/:slug",
+      getPath: (doc) => \`/categories/\${doc.uid}\`,
+    },
+    {
+      type: "menu_item",
+      pattern: "/menu/:branch/:slug",
+      getPath: (doc) => {
+        const branch =
+          readCmsDataPath(doc.data, "branch.slug") ??
+          readCmsDataPath(doc.data, "branch_id.slug") ??
+          "branch";
+
+        return \`/menu/\${branch}/\${doc.uid}\`;
+      },
+    },
+  ],
+  checks: {
+    fields: {
+      required: [
+        { type: "branch", path: "name" },
+        { type: "branch", path: "city" },
+        { type: "menu_item", path: "name" },
+        { type: "menu_item", path: "base_price", severity: "warning" },
+        { type: "pricing", path: "price", severity: "warning" },
+        { type: "pricing", path: "is_available", severity: "warning" },
+      ],
+    },
+  },
+});
+`;
+}
 function strapiStarterConfig(options) {
   const localeLine = options.strapiLocale ? `
     locale: ${JSON.stringify(options.strapiLocale)},` : "";

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   runCli
-} from "./chunk-SVTBRARJ.js";
+} from "./chunk-R7T3O3TT.js";
 export {
   runCli
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms-lab/cli",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "type": "module",
   "description": "Catch CMS bugs before deploy.",
   "license": "MIT",
@@ -47,15 +47,15 @@
   "dependencies": {
     "commander": "^14.0.2",
     "picocolors": "^1.1.1",
-    "@cms-lab/contentful": "1.2.2",
-    "@cms-lab/directus": "1.2.2",
-    "@cms-lab/next": "1.2.2",
-    "@cms-lab/core": "1.2.2",
-    "@cms-lab/reporter": "1.2.2",
-    "@cms-lab/prismic": "1.2.2",
-    "@cms-lab/sanity": "1.2.2",
-    "@cms-lab/strapi": "1.2.2",
-    "@cms-lab/wordpress": "1.2.2"
+    "@cms-lab/contentful": "1.2.4",
+    "@cms-lab/next": "1.2.4",
+    "@cms-lab/directus": "1.2.4",
+    "@cms-lab/core": "1.2.4",
+    "@cms-lab/reporter": "1.2.4",
+    "@cms-lab/sanity": "1.2.4",
+    "@cms-lab/prismic": "1.2.4",
+    "@cms-lab/strapi": "1.2.4",
+    "@cms-lab/wordpress": "1.2.4"
   },
   "author": "Afaq Rashid",
   "scripts": {