@dokebi/cli 0.4.1 → 0.4.26

package/dist/view-choice.js

@@ -0,0 +1,131 @@
+// D-0098: the view of an app is a product choice whose default is Inertia + Vue. Outside a recipe
+// it is made by `dokebi app add <name>` (EJS unless --inertia or --view none; none when the
+// project's recipe built no browser screens, the api recipe) and by the first app of
+// `dokebi add <apps host>` (EJS). These commands record it in `.dokebi/recipe.json` (`choices`)
+// with who made it, the same way D-0095 records recipe answers, so verify's tellUser says it.
+import { debug } from './diagnostics.js';
+import { CliError } from './errors.js';
+/**
+ * The longest `--ai-reason` text, one line for the user like a catalog defaultReason: of a recipe
+ * answer (D-0095) and of the view `app add` records (D-0098). One rule, `aiReasonFits`, for both.
+ */
+export const AI_REASON_MAX = 200;
+/** The id `--ai-chose` and `--ai-reason` name on `app add`. */
+export const VIEW_ID = 'view';
+/** The view answer of a project without browser screens (recipe.ts NO_SCREENS), and of `--view none`. */
+export const NO_VIEW = 'none';
+/**
+ * The view the project's latest recipe recorded (`view` answer), if any: `none` for the api
+ * recipe, so `app add` makes an app without views there unless a flag says otherwise.
+ */
+export async function projectView(root) {
+    const { readAppliedRecipes } = await import('./recipe-record.js');
+    const recipes = await readAppliedRecipes(root);
+    for (const recipe of [...recipes].reverse()) {
+        const value = recipe.answers[VIEW_ID]?.value;
+        if (value !== undefined)
+            return value;
+    }
+    return undefined;
+}
+/** A trimmed `--ai-reason` text is one line of 1 to AI_REASON_MAX characters. */
+export function aiReasonFits(reason) {
+    return reason.length > 0 && reason.length <= AI_REASON_MAX && !/[\r\n]/.test(reason);
+}
+/** The value of the view question for an app made with these flags. */
+export function appViewValue(inertia, ssr, none = false) {
+    return inertia ? (ssr ? 'inertia-vue-ssr' : 'inertia-vue') : none ? NO_VIEW : 'ejs';
+}
+/**
+ * Checks the source flags of `app add` before anything changes: `--ai-chose` names only `view`,
+ * `--ai-reason` only an id of `--ai-chose`, and a reason is one line of 1 to 200 characters.
+ */
+export function checkViewSource(flags) {
+    for (const id of flags.aiChose ?? [])
+        if (id !== VIEW_ID)
+            throw new CliError('AI_CHOICE_UNKNOWN', `app add records only the view, not ${id}`, {
+                details: { aiChose: id, questions: [VIEW_ID], fix: '--ai-chose view' },
+                phase: 'arguments',
+            });
+    for (const [id, text] of Object.entries(flags.aiReasons ?? {})) {
+        if (!(flags.aiChose ?? []).includes(id))
+            throw new CliError('AI_REASON_WITHOUT_CHOICE', `--ai-reason ${id} is given, but ${id} is not in --ai-chose`, {
+                details: {
+                    question: id,
+                    aiChose: [...(flags.aiChose ?? [])],
+                    fix: 'add --ai-chose view if you chose the view because the user left it to you',
+                },
+                phase: 'arguments',
+            });
+        const reason = text.trim();
+        if (!aiReasonFits(reason))
+            throw new CliError('INVALID_AI_REASON', `--ai-reason ${id} must be one line of 1 to ${AI_REASON_MAX} characters`, {
+                details: {
+                    question: id,
+                    length: reason.length,
+                    fix: 'give one short line the user reads: why you chose this view',
+                },
+                phase: 'arguments',
+            });
+    }
+}
+/**
+ * The record of an app's view: `ai` with `--ai-chose view` (or `--answers-from defaults`),
+ * `user` with `--answers-from user`, `unstated` for an EJS app or one without views, without
+ * either (not the default, so the user hears about it); none for an Inertia app without either
+ * (the default), nor for an app without views the project's recipe implied (`inherited`: the
+ * recipe's own line already says who chose no screens).
+ */
+export function appViewChoice(app, value, flags, now = new Date(), inherited = false) {
+    const recordedAt = now.toISOString();
+    if ((flags.aiChose ?? []).includes(VIEW_ID) || flags.answersFrom === 'defaults') {
+        const reason = flags.aiReasons?.[VIEW_ID]?.trim();
+        return {
+            app,
+            id: VIEW_ID,
+            value,
+            answeredBy: 'ai',
+            ...(reason ? { aiReason: reason } : {}),
+            recordedAt,
+        };
+    }
+    if (flags.answersFrom === 'user')
+        return { app, id: VIEW_ID, value, answeredBy: 'user', recordedAt };
+    if (inherited) {
+        debug('app view: no views, as the project recipe built no screens', { app, value });
+        return undefined;
+    }
+    if (value === 'ejs' || value === NO_VIEW) {
+        debug('app view: a view other than the default without a stated source', { app, value });
+        return { app, id: VIEW_ID, value, answeredBy: 'unstated', recordedAt };
+    }
+    return undefined;
+}
+/** The warning of an EJS app (or one without views) whose chooser was not stated (D-0098). */
+export function unstatedViewWarning(app, value = 'ejs') {
+    const what = value === NO_VIEW ? 'an app without views (--view none)' : 'EJS';
+    return {
+        code: 'VIEW_SOURCE_UNSTATED',
+        path: `src/apps/${app}`,
+        hint: `The app ${app} is ${what}, which is not the default view (Inertia + Vue, npx dokebi app add <name> --inertia). verify's tellUser tells the user that nobody recorded who chose it. Next time say it: --answers-from user when the user or the request chose it, --ai-chose view --ai-reason view=<why> when the user left the view to you.`,
+    };
+}
+/**
+ * After `app add` (or `add` with the first app): records the app's view with its source and adds
+ * VIEW_SOURCE_UNSTATED to the result's warnings for an EJS app without a source. A dry run only
+ * warns. The result is the command's own; it is returned with the warning added.
+ */
+export async function recordAppView(root, result, app, value, flags, dryRun) {
+    // app add says what the app really got (an app without views in an api project).
+    const actual = result.appView?.value ?? value;
+    const choice = appViewChoice(app, actual, flags, new Date(), result.appView?.from === 'recipe');
+    if (!choice)
+        return result;
+    if (!dryRun) {
+        const { saveRecordedChoice } = await import('./recipe-record.js');
+        await saveRecordedChoice(root, choice);
+    }
+    if (choice.answeredBy !== 'unstated')
+        return result;
+    return { ...result, warnings: [...(result.warnings ?? []), unstatedViewWarning(app, actual)] };
+}

package/dist/vite-watch.js

@@ -1,6 +1,8 @@
 // Run by `dokebi dev` (D-0044) for one Vite config: a watch build that never empties its outDir.
-// The browser build's `emptyOutDir: true` would otherwise delete dist/ssr/ on every rebuild,
-// which is fine for `npm run build` (one build after the other) but not for two watchers.
+// The templates of @dokebi/app write `emptyOutDir: false` (a rolling deploy keeps the previous
+// chunks), but a vite.config of a project created before them still says `true`: the browser
+// build (outDir dist/) would then delete dist/ssr/ on every rebuild, which `npm run build` (one
+// build after the other) survives but two watchers do not. So dev overrides it for every config.
 // Every finished build is reported to dev over the IPC channel ({ built: true } or
 // { failed: true }); output goes to the terminal as usual.
 import { join } from 'node:path';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dokebi/cli",
-  "version": "0.4.1",
+  "version": "0.4.26",
   "description": "Project scaffolding, plugin catalog, recipes, install and verification CLI for Dokebi.",
   "keywords": [
     "dokebi",
@@ -24,17 +24,18 @@
   "files": [
     "dist",
     "AI.md",
-    "catalog.json"
+    "catalog.json",
+    "describe.schema.json"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "typecheck": "tsc -p tsconfig.test.json --noEmit",
-    "test": "node -e \"require('node:fs').rmSync('.tmp/tests',{recursive:true,force:true})\" && tsc -p tsconfig.test.json && node --test \".tmp/tests/tests/*.test.js\""
+    "test": "node -e \"require('node:fs').rmSync('.tmp/tests',{recursive:true,force:true})\" && tsc -p tsconfig.test.json && node .tmp/tests/tests/run-suite.js"
   },
   "dependencies": {
     "semver": "7.8.5",
-    "@dokebi/core": "^0.4.0",
-    "@dokebi/config": "^0.4.0",
+    "@dokebi/core": "^0.4.2",
+    "@dokebi/config": "^0.4.2",
     "yaml": "2.9.1"
   },
   "devDependencies": {
@@ -59,7 +60,8 @@
     ],
     "recipes": [
       "api",
-      "blog"
+      "blog",
+      "site"
     ]
   }
 }