npm - @nickmeriano/task - Versions diffs - 0.10.0 → 0.12.0 - Mend

@nickmeriano/task 0.10.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (101) hide show

package/README.md +232 -1
package/dist/asks.test.js +6 -0
package/dist/asks.test.js.map +1 -1
package/dist/board/github.d.ts +68 -0
package/dist/board/github.d.ts.map +1 -0
package/dist/board/github.js +112 -0
package/dist/board/github.js.map +1 -0
package/dist/board/handler.d.ts +50 -0
package/dist/board/handler.d.ts.map +1 -0
package/dist/board/handler.js +183 -0
package/dist/board/handler.js.map +1 -0
package/dist/board/handler.test.d.ts +11 -0
package/dist/board/handler.test.d.ts.map +1 -0
package/dist/board/handler.test.js +229 -0
package/dist/board/handler.test.js.map +1 -0
package/dist/board/pages-function.d.ts +23 -0
package/dist/board/pages-function.d.ts.map +1 -0
package/dist/board/pages-function.js +34 -0
package/dist/board/pages-function.js.map +1 -0
package/dist/board/source.d.ts +118 -0
package/dist/board/source.d.ts.map +1 -0
package/dist/board/source.js +333 -0
package/dist/board/source.js.map +1 -0
package/dist/board/source.test.d.ts +12 -0
package/dist/board/source.test.d.ts.map +1 -0
package/dist/board/source.test.js +165 -0
package/dist/board/source.test.js.map +1 -0
package/dist/board/tar.d.ts +28 -0
package/dist/board/tar.d.ts.map +1 -0
package/dist/board/tar.js +188 -0
package/dist/board/tar.js.map +1 -0
package/dist/board/tar.test.d.ts +9 -0
package/dist/board/tar.test.d.ts.map +1 -0
package/dist/board/tar.test.js +110 -0
package/dist/board/tar.test.js.map +1 -0
package/dist/claim-io.d.ts.map +1 -1
package/dist/claim-io.js +4 -3
package/dist/claim-io.js.map +1 -1
package/dist/claim.d.ts +14 -2
package/dist/claim.d.ts.map +1 -1
package/dist/claim.js +9 -3
package/dist/claim.js.map +1 -1
package/dist/claim.test.js +41 -1
package/dist/claim.test.js.map +1 -1
package/dist/cli.js +127 -7
package/dist/cli.js.map +1 -1
package/dist/export.d.ts +163 -0
package/dist/export.d.ts.map +1 -0
package/dist/export.js +259 -0
package/dist/export.js.map +1 -0
package/dist/export.test.d.ts +12 -0
package/dist/export.test.d.ts.map +1 -0
package/dist/export.test.js +264 -0
package/dist/export.test.js.map +1 -0
package/dist/functions/board.js +709 -0
package/dist/git-serve.d.ts +14 -1
package/dist/git-serve.d.ts.map +1 -1
package/dist/git-serve.js +30 -2
package/dist/git-serve.js.map +1 -1
package/dist/git-serve.test.d.ts +1 -0
package/dist/git-serve.test.d.ts.map +1 -1
package/dist/git-serve.test.js +36 -1
package/dist/git-serve.test.js.map +1 -1
package/dist/index.d.ts +2 -0
package/dist/index.d.ts.map +1 -1
package/dist/index.js +6 -0
package/dist/index.js.map +1 -1
package/dist/server.d.ts +6 -0
package/dist/server.d.ts.map +1 -1
package/dist/server.js +12 -3
package/dist/server.js.map +1 -1
package/dist/trailers.d.ts +51 -0
package/dist/trailers.d.ts.map +1 -0
package/dist/trailers.js +32 -0
package/dist/trailers.js.map +1 -0
package/package.json +3 -3
package/skill/SKILL.md +16 -1
package/src/asks.test.ts +15 -0
package/src/board/github.ts +151 -0
package/src/board/handler.test.ts +276 -0
package/src/board/handler.ts +228 -0
package/src/board/pages-function.ts +42 -0
package/src/board/source.test.ts +203 -0
package/src/board/source.ts +422 -0
package/src/board/tar.test.ts +128 -0
package/src/board/tar.ts +199 -0
package/src/claim-io.ts +12 -3
package/src/claim.test.ts +56 -1
package/src/claim.ts +27 -4
package/src/cli.ts +127 -7
package/src/export.test.ts +361 -0
package/src/export.ts +354 -0
package/src/git-serve.test.ts +41 -1
package/src/git-serve.ts +30 -2
package/src/index.ts +10 -0
package/src/server.ts +12 -3
package/src/trailers.ts +65 -0
package/ui/dist/assets/index-B8M_DaOt.js +229 -0
package/ui/dist/assets/{index-CoKCUYic.css → index-eHsqltgs.css} +1 -1
package/ui/dist/index.html +3 -3
package/ui/dist/assets/index-BjsorZOU.js +0 -229

package/src/export.test.ts ADDED Viewed

@@ -0,0 +1,361 @@
+/**
+ * `task export` writes a file another program reads, so what's checked here is
+ * the contract rather than the code: every field comes from the same store
+ * call the matching `/api/…` route makes, and the directory it lands in
+ * refreshes without eating what someone else put there.
+ *
+ * The round trip through the actual reader (`parseSnapshot` + `snapshotSource`)
+ * lives in `ui/src/deployment.test.ts` — it's the UI's tsconfig that can see
+ * both sides.
+ */
+import assert from "node:assert/strict"
+import { test } from "node:test"
+import { execFileSync } from "node:child_process"
+import {
+  existsSync,
+  mkdirSync,
+  mkdtempSync,
+  readFileSync,
+  rmSync,
+  writeFileSync,
+} from "node:fs"
+import { tmpdir } from "node:os"
+import { join } from "node:path"
+import { initProject, openBoard } from "./file-store.ts"
+import {
+  buildSnapshot,
+  functionPath,
+  renderFunction,
+  writeExport,
+  SNAPSHOT_FILE,
+  SNAPSHOT_VERSION,
+  type Snapshot,
+} from "./export.ts"
+import { STATUSES } from "./types.ts"
+function tempRoot(): string {
+  const dir = mkdtempSync(join(tmpdir(), "task-export-"))
+  process.on("exit", () => rmSync(dir, { recursive: true, force: true }))
+  return dir
+}
+/** A fake `ui/dist` — the shape of one is all the copy step cares about. */
+function fakeUi(): string {
+  const dir = tempRoot()
+  writeFileSync(join(dir, "index.html"), "<!doctype html><html><head><title>board</title></head></html>")
+  mkdirSync(join(dir, "assets"))
+  writeFileSync(join(dir, "assets", "index-abc123.js"), "// bundle")
+  return dir
+}
+/** A single-board repo with enough in it to be worth exporting. */
+function board(): string {
+  const root = tempRoot()
+  const store = initProject(root, { name: "acme", prefix: "ACM" })
+  const talked = store.create({ title: "Ship the export", status: "todo" })
+  store.addComment(talked.key, "on it", "claude")
+  store.addComment(talked.key, "still on it", "claude")
+  store.create({ title: "Quiet ticket", status: "backlog" })
+  const finished = store.create({ title: "Already shipped", status: "done" })
+  store.archive(finished.key)
+  store.createGoal({ title: "Launch", slug: "launch" })
+  store.createGoal({ title: "Old plan", slug: "old-plan" })
+  store.archiveGoal("old-plan")
+  store.close()
+  return root
+}
+test("the snapshot answers what the serve API answers", () => {
+  const root = board()
+  const store = openBoard(root)
+  const snapshot = buildSnapshot(root)
+  const data = snapshot.data["."]
+  // /api/project — field for field, minus readOnly (the reader forces it).
+  assert.equal(data.project.name, store.config.name)
+  assert.equal(data.project.prefix, store.config.prefix)
+  assert.deepEqual(data.project.statuses, STATUSES)
+  assert.equal(typeof data.project.author, "string")
+  assert.ok(!("readOnly" in data.project))
+  // /api/tasks — the same list, in the same order, with the same counts.
+  const tasks = store.list()
+  const counts = store.commentCounts()
+  assert.deepEqual(
+    data.tasks,
+    tasks.map((t) => ({ ...t, commentCount: counts.get(t.key) ?? 0 })),
+  )
+  // /api/goals — live first, archived riding along flagged.
+  assert.deepEqual(data.goals, [...store.goals(), ...store.goals(true)])
+  assert.ok(data.goals.some((g) => g.archived))
+  // /api/tasks/:n — comments per task, oldest first, empty ones omitted.
+  const talkative = tasks.find((t) => t.title === "Ship the export")!
+  const quiet = tasks.find((t) => t.title === "Quiet ticket")!
+  assert.deepEqual(data.comments[talkative.key], store.comments(talkative.key))
+  assert.equal(data.comments[quiet.key], undefined)
+  store.close()
+})
+test("an archived ticket is off the board, in the export too", () => {
+  const root = board()
+  const snapshot = buildSnapshot(root)
+  assert.ok(!snapshot.data["."].tasks.some((t) => t.title === "Already shipped"))
+})
+test("a monorepo root exports every board, keyed by what /boards says", () => {
+  const root = tempRoot()
+  initProject(root, { name: "acme", prefix: "ACM" }).close()
+  const nested = join(root, "projects", "widget")
+  mkdirSync(nested, { recursive: true })
+  initProject(nested, { name: "widget", prefix: "WID" }).close()
+  const snapshot = buildSnapshot(root)
+  assert.deepEqual(
+    snapshot.boards.map((b) => b.id),
+    [".", "projects/widget"],
+  )
+  assert.deepEqual(snapshot.boards[1], { id: "projects/widget", name: "widget", prefix: "WID" })
+  // Every board in the list has an entry, and nothing else does.
+  assert.deepEqual(Object.keys(snapshot.data).sort(), [".", "projects/widget"])
+})
+test("a board with nothing above or below it is not an export", () => {
+  assert.throws(() => buildSnapshot(tempRoot()), /run `task init`/)
+})
+test("the commit is the HEAD it was exported from, or null outside a repo", () => {
+  const loose = board()
+  assert.equal(buildSnapshot(loose).meta.commit, null)
+  const repo = board()
+  const git = (...args: string[]) =>
+    execFileSync("git", args, { cwd: repo, stdio: ["ignore", "pipe", "ignore"] })
+  git("init", "-q")
+  git("config", "user.email", "t@example.com")
+  git("config", "user.name", "Test")
+  git("add", "-A")
+  git("commit", "-qm", "board")
+  const head = git("rev-parse", "HEAD").toString().trim()
+  assert.equal(buildSnapshot(repo).meta.commit, head)
+})
+test("the export is the assets plus the snapshot", () => {
+  const root = board()
+  const out = join(tempRoot(), "board")
+  const summary = writeExport({ serveRoot: root, outDir: out, uiDir: fakeUi() })
+  assert.ok(existsSync(join(out, "index.html")))
+  assert.ok(existsSync(join(out, "assets", "index-abc123.js")))
+  const snapshot = JSON.parse(readFileSync(join(out, SNAPSHOT_FILE), "utf8")) as Snapshot
+  assert.equal(snapshot.version, SNAPSHOT_VERSION)
+  assert.equal(snapshot.boards.length, 1)
+  assert.deepEqual(summary, {
+    outDir: out,
+    base: "/",
+    boards: 1,
+    tasks: snapshot.data["."].tasks.length,
+    commit: null,
+    builtAt: snapshot.meta.builtAt,
+    functions: null,
+  })
+})
+test("exporting without a built UI says which build to run", () => {
+  assert.throws(
+    () =>
+      writeExport({
+        serveRoot: board(),
+        outDir: join(tempRoot(), "board"),
+        uiDir: join(tempRoot(), "never-built"),
+      }),
+    /run the package build/,
+  )
+})
+test("exporting onto the UI build is refused, not a way to delete it", () => {
+  const ui = fakeUi()
+  assert.throws(
+    () => writeExport({ serveRoot: board(), outDir: ui, uiDir: ui, force: true }),
+    /the UI build itself/,
+  )
+  assert.ok(existsSync(join(ui, "index.html")))
+})
+test("re-exporting refreshes in place and leaves a deployed function alone", () => {
+  const root = board()
+  const out = join(tempRoot(), "board")
+  const ui = fakeUi()
+  writeExport({ serveRoot: root, outDir: out, uiDir: ui })
+  // TAS-33's room: something the export didn't put there and must not remove.
+  mkdirSync(join(out, "functions"))
+  writeFileSync(join(out, "functions", "handler.js"), "// live proxy")
+  // A stale bundle from the previous build, which it *should* remove.
+  writeFileSync(join(out, "assets", "index-old.js"), "// last time")
+  const store = openBoard(root)
+  store.create({ title: "Added since the last export", status: "todo" })
+  store.close()
+  writeExport({ serveRoot: root, outDir: out, uiDir: ui })
+  const snapshot = JSON.parse(readFileSync(join(out, SNAPSHOT_FILE), "utf8")) as Snapshot
+  assert.ok(snapshot.data["."].tasks.some((t) => t.title === "Added since the last export"))
+  assert.equal(readFileSync(join(out, "functions", "handler.js"), "utf8"), "// live proxy")
+  assert.ok(!existsSync(join(out, "assets", "index-old.js")))
+})
+test("a directory that isn't a previous export is refused, not overwritten", () => {
+  const root = board()
+  const out = join(tempRoot(), "not-an-export")
+  mkdirSync(out)
+  writeFileSync(join(out, "thesis.md"), "years of work")
+  assert.throws(
+    () => writeExport({ serveRoot: root, outDir: out, uiDir: fakeUi() }),
+    /--force/,
+  )
+  assert.equal(readFileSync(join(out, "thesis.md"), "utf8"), "years of work")
+  // --force writes in; it still only ever overwrites what it writes.
+  writeExport({ serveRoot: root, outDir: out, uiDir: fakeUi(), force: true })
+  assert.ok(existsSync(join(out, SNAPSHOT_FILE)))
+  assert.equal(readFileSync(join(out, "thesis.md"), "utf8"), "years of work")
+})
+// ── The mount point, stamped into the page ──────────────────────────────────
+test("the exported page carries its mount point as a <base> tag", () => {
+  const root = board()
+  const atRoot = join(tempRoot(), "root")
+  writeExport({ serveRoot: root, outDir: atRoot, uiDir: fakeUi() })
+  assert.match(readFileSync(join(atRoot, "index.html"), "utf8"), /<head><base href="\/" \/>/)
+  const atSubpath = join(tempRoot(), "sub")
+  const summary = writeExport({ serveRoot: root, outDir: atSubpath, uiDir: fakeUi(), base: "board" })
+  assert.equal(summary.base, "/board/")
+  assert.match(
+    readFileSync(join(atSubpath, "index.html"), "utf8"),
+    /<head><base href="\/board\/" \/>/,
+  )
+})
+test("a base that isn't a plain URL path is refused", () => {
+  const root = board()
+  for (const bad of ["//cdn.example.com", "/a b/", '/"/']) {
+    assert.throws(
+      () => writeExport({ serveRoot: root, outDir: join(tempRoot(), "out"), uiDir: fakeUi(), base: bad }),
+      /--base/,
+      bad,
+    )
+  }
+})
+// ── The live proxy, written beside the snapshot ─────────────────────────────
+/** A stand-in for `dist/functions/board.js`: the placeholders are the contract. */
+function fakeBundle(): string {
+  const dir = tempRoot()
+  const path = join(dir, "board.js")
+  writeFileSync(
+    path,
+    'const REPO = "__TASK_EXPORT_REPO__";\nconst BASE_PATH = "__TASK_EXPORT_BASE_PATH__";\nexport const onRequest = () => [REPO, BASE_PATH];\n',
+  )
+  return path
+}
+test("--functions writes the Pages Function where the SPA will look for its API", () => {
+  const root = board()
+  const out = join(tempRoot(), "board")
+  const summary = writeExport({
+    serveRoot: root,
+    outDir: out,
+    uiDir: fakeUi(),
+    functions: { repo: "acme/widgets", bundle: fakeBundle() },
+  })
+  assert.equal(summary.functions, join("functions", "api", "[[path]].js"))
+  const written = readFileSync(join(out, summary.functions!), "utf8")
+  assert.match(written, /const REPO = "acme\/widgets";/)
+  assert.match(written, /const BASE_PATH = "\/api";/)
+  assert.ok(!written.includes("__TASK_EXPORT_"))
+  // The snapshot is still there: the function is an upgrade, not a replacement.
+  assert.ok(existsSync(join(out, SNAPSHOT_FILE)))
+})
+test("under --base the function moves with the mount point", () => {
+  assert.equal(functionPath("/"), join("functions", "api", "[[path]].js"))
+  assert.equal(functionPath("board"), join("functions", "board", "api", "[[path]].js"))
+  assert.equal(functionPath("/a/b/"), join("functions", "a", "b", "api", "[[path]].js"))
+  const out = join(tempRoot(), "sub")
+  const summary = writeExport({
+    serveRoot: board(),
+    outDir: out,
+    uiDir: fakeUi(),
+    base: "/board/",
+    functions: { repo: "acme/widgets", bundle: fakeBundle() },
+  })
+  assert.equal(summary.functions, join("functions", "board", "api", "[[path]].js"))
+  assert.match(readFileSync(join(out, summary.functions!), "utf8"), /const BASE_PATH = "\/board\/api";/)
+})
+test("a re-export without --functions leaves the function as deployed; with it, refreshes it", () => {
+  const root = board()
+  const out = join(tempRoot(), "board")
+  const ui = fakeUi()
+  const first = writeExport({
+    serveRoot: root,
+    outDir: out,
+    uiDir: ui,
+    functions: { repo: "acme/widgets", bundle: fakeBundle() },
+  })
+  const file = join(out, first.functions!)
+  writeFileSync(file, "// hand-edited on the host")
+  const plain = writeExport({ serveRoot: root, outDir: out, uiDir: ui })
+  assert.equal(plain.functions, null)
+  assert.equal(readFileSync(file, "utf8"), "// hand-edited on the host")
+  writeExport({ serveRoot: root, outDir: out, uiDir: ui, functions: { repo: "acme/gadgets", bundle: fakeBundle() } })
+  assert.match(readFileSync(file, "utf8"), /acme\/gadgets/)
+})
+test("a repo that isn't owner/name, or a missing bundle, fails before anything is written", () => {
+  const out = join(tempRoot(), "board")
+  assert.throws(
+    () =>
+      writeExport({
+        serveRoot: board(),
+        outDir: out,
+        uiDir: fakeUi(),
+        functions: { repo: 'acme/"; fetch("evil', bundle: fakeBundle() },
+      }),
+    /owner\/name/,
+  )
+  assert.ok(!existsSync(out))
+  assert.throws(
+    () =>
+      writeExport({
+        serveRoot: board(),
+        outDir: out,
+        uiDir: fakeUi(),
+        functions: { repo: "acme/widgets", bundle: join(tempRoot(), "missing.js") },
+      }),
+    /function bundle not found/,
+  )
+  assert.ok(!existsSync(out))
+  // A bundle without the placeholders is not the function — refuse rather
+  // than ship a file that reads the wrong repository.
+  assert.throws(() => renderFunction("export const onRequest = 1", "acme/widgets", "/"), /placeholder|__TASK_EXPORT_/)
+})