@wirecat/cli-template 0.1.4 → 0.1.6

package/src/program.test.ts

@@ -1,6 +1,7 @@
 import { mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs"
 import { join } from "node:path"
 import { expect, it } from "vitest"
+import { doctorReport } from "./commands/doctor.js"
 import { IDENTITY } from "./identity.js"
 import { run } from "./program.js"
 
@@ -25,20 +26,40 @@ it("lists the required root commands and config", async () => {
 it("doctor answers without a config file", async () => {
   const { code, out } = await ran(["doctor", "--json"])
   expect(code).toBe(0)
-  expect(json(out).item).toMatchObject({ config: { exists: false }, profiles: [], read_only: null })
+  expect(json(out).item).toMatchObject({ config: { found: false, issues: [] }, profiles: [], read_only: null })
 })
 
-it("doctor reports an unreadable config as a field", async () => {
+const withConfig = async (text: string, check: (config: unknown) => void) => {
   const dir = process.env.CLIDEV_CONFIG_DIR ?? ""
   mkdirSync(dir, { recursive: true })
-  writeFileSync(join(dir, "config.json"), "not json")
+  writeFileSync(join(dir, "config.json"), text)
   try {
     const { code, out } = await ran(["doctor", "--json"])
     expect(code).toBe(0)
-    expect(json(out).item.config).toMatchObject({ exists: true, error: expect.any(String) })
+    check(json(out).item.config)
   } finally {
     rmSync(join(dir, "config.json"))
   }
+}
+
+it("doctor reports invalid JSON as an issue", async () => {
+  await withConfig('{\n  "defaults": {\n', (config) =>
+    expect(config).toMatchObject({ found: true, issues: [{ kind: "invalid_json", line: 3 }] }),
+  )
+})
+
+it("doctor reports an unknown setting with the command that removes it", async () => {
+  await withConfig('{ "defaults": { "limt": 3 } }', (config) =>
+    expect(config).toMatchObject({
+      found: true,
+      issues: [{ kind: "unknown_setting", key: "limt", fix: "clidev config unset --defaults limt" }],
+    }),
+  )
+})
+
+it("doctor reports settings an environment variable breaks, and still answers", () => {
+  const report = doctorReport({ ...process.env, CLIDEV_EMBEDDING_DIMS: "many" })
+  expect(report).toMatchObject({ config: { issues: [] }, settings: { error: expect.any(String) }, profiles: null })
 })
 
 it("config show names the profile it was given", async () => {
@@ -65,7 +86,7 @@ it("upgrade --check installs nothing when npm cannot be reached", async () => {
   expect(json(out).item).toMatchObject({ current: IDENTITY.version, latest: null, updated: false })
 })
 
-it("keeps a failed command as a run, and runs list, show and path read it back (WC-LIFE-15)", async () => {
+it("keeps a failed command as a run, and runs list, show and path read it back", async () => {
   expect((await ran(["--no-such-flag"])).code).toBe(2)
   const listed = await ran(["runs", "list", "--limit", "5", "--page", "1", "--json"])
   expect(listed.code).toBe(0)

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = "0.1.4"
+export const VERSION = "0.1.6"

package/vitest.config.ts

@@ -10,10 +10,18 @@ export default defineConfig({
     globalSetup: ["src/testing/argv-log.ts"],
     coverage: {
       provider: "v8",
-      include: ["src/**/*.ts"],
-      exclude: ["src/**/*.test.ts", "src/testing/**", "src/bin/**"],
+      include: ["src/**/*.ts", "kit/src/**/*.ts"],
+      exclude: [
+        "src/**/*.test.ts",
+        // Test setup: the sandbox and the argv log run only under vitest.
+        "src/testing/**",
+        // The entry point: one line handing argv to run(), which the suite drives directly.
+        "src/bin/**",
+        // The kit's entry point runs only as a separate process, in kit/test/package.test.ts.
+        "kit/src/main.ts",
+      ],
       reporter: ["text-summary", "json-summary"],
-      thresholds: { lines: 90, statements: 90, functions: 80, branches: 70 },
+      thresholds: { lines: 90, statements: 90, functions: 80, branches: 70, perFile: { lines: 50 } },
     },
   },
 })

package/kit/README.md

@@ -1,136 +0,0 @@
-# kit — `new` and `upgrade`
-
-The copy tool behind `npx @wirecat/cli-template`. It is the package's `cli-template` bin
-(`kit/dist/main.js`, built from `kit/src` by `tsc -p kit`). It is never copied into a new CLI.
-
-```sh
-npx @wirecat/cli-template new cal-cli --command cal --package @wirecat/cal-cli --owner WireCatLabs \
-  --category notes --content-lang en,ru --sign-in token --api official-docs --filters time,person \
-  --never-store tokens --untrusted messages,links
-npx @wirecat/cli-template upgrade --dry-run
-```
-
-## `new <name>`
-
-`new` copies the files of its own package version into `./<name>`. It renames the placeholders, rewrites
-`package.json`, runs `git init` and writes `template.json`, `docs/dev/DESIGN.md` and the reference CLI into
-`AGENTS.md`. It then prints the four steps that need a person. It does not install packages, commit or push.
-
-In a terminal it asks for every missing answer. Without a terminal, a missing answer is an error that lists the
-choices. Nothing is guessed.
-
-| Flag | Answers (several are comma-separated) |
-|---|---|
-| `<name>` | the folder and repository name |
-| `--command` | the command word |
-| `--package` | the npm package name |
-| `--owner` | the GitHub owner |
-| `--category` | `messenger`, `mail`, `notes`, `files`, `calendar`, `meetings` |
-| `--content-lang` | language codes, several: `en,ru` |
-| `--sign-in` | `oauth`, `token`, `session`, `none` |
-| `--api` | `official-client`, `official-docs`, `unofficial` |
-| `--filters` | several of `time`, `person`, `container`, `text`, `status` |
-| `--never-store` | several of `tokens`, `codes`, `secret-links`, `content` |
-| `--untrusted` | several of `messages`, `files`, `links`, `names`, or `none` alone |
-
-Every question except the names and `--content-lang` also takes `other:<your answer>`.
-
-`new` writes the content languages into `contentLanguages` in `src/identity.ts`; on the first run, cli-core ticks them
-in advance in the search-language question, and the person confirms. `DESIGN.md` records them too, with the
-speech-model order a messenger definition should use and the warnings for languages that have no stemmer or speech
-model in cli-core. `new` writes no search or model setting.
-
-## `upgrade`
-
-Run it in a CLI made from the template, with a clean git working tree. For each template-owned file that the
-template changed since the recorded version, it asks one of four things:
-
-- **apply** merges the change with `git merge-file`. The base is the recorded version, downloaded with `npm pack`.
-  "Ours" is the CLI's file and "theirs" is this version. Both template versions are renamed first, so the command
-  word never conflicts.
-- **replace** takes the template's file as it is.
-- **skip** keeps the CLI's file. It is asked again only when the template changes that file again.
-- **diff** shows the template's change.
-
-Without a terminal, `--apply`, `--replace` or `--skip` sets the answer for every file. `--dry-run` lists what each
-file would get and writes nothing. Seeds and `package.json` are never touched.
-
-A conflict leaves git markers, and `template.json` keeps the new state under `pending`. Resolve the markers and run
-`upgrade` again: it checks that the markers are gone and then moves to the new version.
-
-## `template.json` in this repository
-
-```json
-{
-  "files": [".github/", "bin/release", "AGENTS.md", "docs/meta.json"],
-  "seeds": ["src/", "README.md", "docs/", "config/wirecat/"],
-  "placeholders": {
-    "command": "clidev", "name": "clidev-cli", "package": "@wirecat/clidev-cli", "repository": "WireCatLabs/clidev-cli"
-  }
-}
-```
-
-- `files` lists the template-owned files that `upgrade` replays. `seeds` lists the files copied once and never
-  touched again; `config/wirecat/` goes there, because community's installer owns it. An entry ending in `/` is a
-  folder. The most specific entry wins: an exact path beats a folder, a deeper folder beats a shallower one, and a
-  seed wins a tie. Only listed files are copied. A listed file missing from the package stops `new`.
-- `template.json` and `kit/` are never copied, whatever the lists say. The kit's tests run inside `pnpm test`, so
-  the configs name `kit/`: `new` and `upgrade` drop every `"kit/…"` entry from `vitest.config.ts`, `biome.json`,
-  `cspell.json`, `tsconfig*.json` and `.markdownlint-cli2.jsonc`. Do not add a kit-only workflow: `.github/` is
-  template-owned and would carry it into every new CLI.
-- `README.md` and `CHANGELOG.md` describe the template, so `new` writes short ones for the new CLI.
-- `config/parity-groups.json` puts the template in parity groups with the published CLIs, so `scripts/audit.sh`
-  compares its `commands`, `upgrade`, `config` and `skill` paths with theirs. It is in neither list, so a new CLI does
-  not get it: the file replaces cli-base's `PARITY_GROUPS`, and a new CLI joins those groups instead (step 4 of
-  `new`'s output).
-- `docs/dev/DESIGN.md` is always a seed: it holds the CLI's interview answers.
-- `package.json` is always a seed. `new` rewrites it: `name` becomes `--package`, `version` becomes `0.0.0`, and
-  `repository`, `homepage` and `bugs` point at `<owner>/<name>`. It also drops every `bin`, `files` entry and script
-  that points into `kit/`, and the `&& pnpm kit:…` parts of other scripts. `src/version.ts` gets `VERSION = "0.0.0"`.
-- `placeholders` names the words `new` and `upgrade` replace. The command word is replaced as a whole word, so
-  `clidev` changes but `clidevs` and cli-base's `cli-dev` do not. Its upper-case form changes too: `CLIDEV_HOME`
-  becomes `CAL_HOME`. Followed by a colon and a space it is a key and stays: `clidev: CLIDEV` becomes `clidev: CAL`.
-  `name` (`clidev-cli`) is the repository name: `skills/clidev-cli/` becomes `skills/cal-cli/`. The word `clidev`
-  cannot appear in prose for any other meaning. Paths are renamed the same way: `src/bin/clidev.ts` becomes
-  `src/bin/cal.ts`.
-- Each template version is renamed with its own `placeholders`, so `upgrade` from 0.1.0 or 0.1.1, which used `app`,
-  merges cleanly. A key missing from `placeholders` means its `app` value (`app`, `app-cli`, `@wirecat/app-cli`,
-  `WireCatLabs/app-cli`): those versions left `name` out.
-- The version is `package.json`'s, never a second copy.
-- `AGENTS.md` can hold the block that `new` fills with the reference CLI:
-
-  ```md
-  <!-- cli-template:reference-cli:start -->
-  <!-- cli-template:reference-cli:end -->
-  ```
-
-  Without the block, `new` appends one.
-
-## `template.json` in a CLI made from it
-
-`new` writes this shape and `upgrade` keeps it current:
-
-```json
-{
-  "template": "@wirecat/cli-template",
-  "version": "0.1.0",
-  "names": { "name": "cal-cli", "command": "cal", "package": "@wirecat/cal-cli", "owner": "WireCatLabs" },
-  "files": { ".github/workflows/ci.yml": "<sha256 of the renamed template file at this version>" },
-  "seeds": ["src/", "README.md", "docs/", "config/wirecat/"]
-}
-```
-
-## What the package needs from the repository
-
-- `"bin": { "cli-template": "kit/dist/main.js" }`, and `kit/dist` in `files`. No ignore file inside `kit/`: npm
-  applies it and drops `kit/dist` from the package. npm also never packs `pnpm-lock.yaml`, so it is not a seed; the
-  new CLI makes its own on `pnpm install`.
-- Every template-owned file and seed in `files`. npm drops a nested `.gitignore` and any `.npmrc` when it packs.
-  When it installs a package, it renames `.gitignore` to `.npmignore`. So the package ships the root `.gitignore` as
-  `gitignore`, and `new` and `upgrade` read it back as `.gitignore`. The test in `kit/test/package.test.ts` runs the
-  bin from a tarball installed with `npm install` to catch that.
-- `kit:build` (`tsc -p kit`, then the copy to `gitignore`) run by `build`, because `bin/release` and CI pack with
-  `--ignore-scripts`. Node does not strip types under `node_modules`, so the bin must be JavaScript.
-- `pnpm kit:e2e` packs this repository, installs the tarball with npm, runs `new` and then `pnpm install` and
-  `pnpm ci:quick` in the new CLI. It needs the network and takes a few minutes, so it is not part of `pnpm test`.
-- `kit/test/**/*.test.ts` in vitest's `include`; `kit/dist` is ignored by the root `**/dist` rules of Biome and git.

package/kit/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2023",
-    "lib": ["ES2023"],
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "types": ["node"],
-    "strict": true,
-    "noUncheckedIndexedAccess": true,
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "skipLibCheck": true,
-    "rootDir": "src",
-    "outDir": "dist"
-  },
-  "include": ["src/**/*.ts"]
-}

package/kit/tsconfig.test.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": { "noEmit": true, "rootDir": "." },
-  "include": ["src/**/*.ts", "test/**/*.ts"]
-}