@intentic/fileq 1.317.0 → 1.319.0

package/NOTICE

@@ -0,0 +1,208 @@
+NOTICE
+======
+
+fileq is part of the Intentic repository and is MIT-licensed (package.json).
+It includes material adapted from SurfSense, which is covered below.
+
+
+SurfSense
+---------
+
+Copyright (c) SurfSense
+https://github.com/MODSetter/SurfSense (read at a51f9a367ccafe873d7d85a4f3878e5a6de4e662)
+
+The adapted material comes from the parts of SurfSense licensed under the
+Apache License, Version 2.0; its full text follows. SurfSense ships no NOTICE
+file of its own. Each adapted file says in its header what it took and what it
+changed:
+
+  src/skill-authoring.ts     authoring rules, from
+                             docker/sandbox/skills/{pptx,docx,xlsx,pdf}/SKILL.md
+  src/lib/check/pptx.ts      geometry, crop and missing-media rules, from
+                             surfsense_backend/app/artifacts/verification/formats/pptx.py
+  src/lib/check/docx.ts      the literal-bullet rule, from .../formats/docx.py
+  src/lib/check/xlsx.ts      error-value and missing-cached-value rules, from
+                             .../formats/xlsx.py
+  src/lib/check/pdf.ts       blank-page and unembedded-font rules, from
+                             .../formats/pdf.py
+
+The code in those files is written for fileq, in TypeScript; what it carries
+over is the rules, their thresholds and the wording of the authoring guidance.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -1,26 +1,45 @@
 # fileq
 
-A CLI that shows an agent the contents of binary workspace files (Office documents, PDFs, images, audio, archives) as budgeted markdown, cached as sidecars.
+A CLI that shows an agent the contents of binary workspace files (Office documents, PDFs, images, audio, archives) as budgeted markdown, cached by content, and checks and draws the documents an agent makes.
 
 ```mermaid
 flowchart LR
     agent["Agent<br/>fileq read"] --> fileq(["fileq"])
-    daemon["Daemon<br/>derive · sweep"] --> fileq
+    maker["Agent<br/>fileq check · render"] --> fileq
+    daemon["Daemon<br/>derive"] --> fileq
     git["git diff · show<br/>textconv"] --> fileq
     fileq --> derivers["Derivers<br/>docx · pdf · xlsx · image …"]
     fileq --> sidecars["Sidecars<br/>.intentic/local/cache/derived"]
+    fileq --> tools["LibreOffice · pdftoppm<br/>.intentic/local/cache/rendered"]
 ```
 
 - An agent cannot `cat` a docx or the text layer of a PDF. `fileq <file>` prints a capsule line (title, format,
-  token cost, derived or fresh), then the markdown clipped to `--budget` tokens, and names the sidecar that holds the
-  whole text.
-- Each derivable file gets one sidecar at `.intentic/local/cache/derived/<path>.md`. It is fresh while the source's
-  sha256 and the deriver's version stamp both match, so reading a file twice derives it once. Text is neutralized at
-  write time, because a sidecar is later read as a plain file.
-- The daemon keeps sidecars converged in the background with `fileq derive` and `fileq sweep`
-  (`_sandbox/sandbox/src/derived/`), and imports `./formats` and `./sidecar` so both sides agree on what is derivable.
+  token cost, derived or fresh), then the markdown clipped to `--budget` tokens, and names the file that holds the whole
+  text.
+- Renderings are cached by content: keyed by the source's sha256 and the deriver's version stamp, never its path, so
+  a repeat read of unchanged content is instant, whether it is the same file, a copy or a move of it, or a file
+  outside the workspace. The entries live under `.intentic/local/cache/derived/.by-hash/`, or with no workspace under
+  `by-hash/` in `$FILEQ_HOME`, else `$XDG_CACHE_HOME/fileq`, else `~/.cache/fileq`. A cache that cannot be written costs the speed-up,
+  never the read.
+- A workspace file also gets a sidecar at `.intentic/local/cache/derived/<path>.md`, fresh while its sha256 and the
+  stamp both match. Text is neutralized at write time, because a sidecar or a cache entry is later read as a plain
+  file.
+- The daemon renders one file when asked with `fileq derive --json <path>` (`_sandbox/sandbox/src/derived/`), and
+  imports `./formats` and `./sidecar` so both sides agree on what is derivable.
 - In the sandbox image, `git diff` and `git show` on a document print its text through `fileq read --plain`, wired by
   `fileq git-attributes`.
+- `fileq check <file>` lints a docx, pptx, xlsx or pdf an agent produced and names each problem where a reader meets
+  it (`slide 3 · "Title 1"`, `'Q3 plan'!C4`, `page 7`, `paragraph 12 · "…"`). An error is a fact read off the
+  structure (a missing image, a cell showing `#REF!`, a link to a bookmark that is not there, a blank page, Office's
+  own "Click to add title" left as text) and makes it exit 1; a warning is a judgement call or an estimate (text
+  overflowing its box, from average glyph widths). Some rules are adapted from SurfSense's artifact verification
+  (Apache-2.0); [NOTICE](NOTICE) names them.
+- `fileq render <file>` draws pages or slides to PNG under `.intentic/local/cache/rendered/<path>/` (or `--out`) and
+  prints their paths for an image reader. Office formats go through LibreOffice to PDF first, keeping hidden slides
+  so slide N is image N; `pdftoppm` or `mutool` draws the PDF. A render is keyed by the document's hash, so an
+  unchanged file answers from the last one. A missing tool exits 2 with what installs it.
+- Its skill ([src/skill.ts](src/skill.ts)) tells an agent to check and look at every document it makes, with short
+  authoring rules adapted from SurfSense's document skills ([src/skill-authoring.ts](src/skill-authoring.ts)).
 - Out of scope: plain text files (read them directly), web pages ([webq](../webq)), OCR and transcription.
 
 ## Usage
@@ -28,16 +47,24 @@ flowchart LR
 ```sh
 fileq report.docx                    # capsule + markdown up to 4000 tokens, whole text saved
 fileq read deck.pptx --budget 8000   # a bigger slice on stdout
+fileq check deck.pptx                # problems by slide and drawing; exit 1 on an error
+fileq render deck.pptx --pages 1-3   # slide-1.png … slide-3.png, one path per line
 ```
 
+2026-09-29: rendering shells out to LibreOffice and poppler instead of bundling a renderer. pdf.js draws only onto a
+canvas fileq does not carry, and an office layout faithful enough to judge overflow is LibreOffice itself. No published sandbox
+image carries them: they are the opt-in `office` pack (`_sandbox/sandbox/image-packs/office.Dockerfile`, ~335 MB), so
+there `fileq render` names the missing tool and prints `environment propose office --pack`, which asks the owner for it.
+
 ## Key files
 
 - [src/app.ts](src/app.ts) — the command routes and the `--help` text an agent reads.
-- [src/lib/derive.ts](src/lib/derive.ts) — `ensureSidecar`: the pipeline `read`, `derive` and `sweep` all run.
+- [src/lib/derive.ts](src/lib/derive.ts) — `ensureSidecar` and `renderByContent`: the pipeline `read` and `derive` both run.
+- [src/lib/content-cache.ts](src/lib/content-cache.ts) — renderings keyed by content hash and deriver stamp.
 - [src/lib/formats.ts](src/lib/formats.ts) — `detectFormat`: magic bytes first, extension as fallback.
 - [src/lib/sidecar.ts](src/lib/sidecar.ts) — sidecar paths, front matter and the freshness rule.
-- [src/lib/derivers/deriver.ts](src/lib/derivers/deriver.ts) — the contract every format handler meets.
-- [src/derivers.integration.test.ts](src/derivers.integration.test.ts) — each format's output, by fixture.
+- [src/lib/check/check.ts](src/lib/check/check.ts) — `fileq check`: which formats have a checker; each format's rules sit beside it.
+- [src/lib/render/render.ts](src/lib/render/render.ts) — `fileq render`: conversion, rasterizing and the render cache.
 
 ## Commands
 

package/dist/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AA8BA,eAAO,MAAM,GAAG,6EAiBf,CAAC"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAyCA,eAAO,MAAM,GAAG,6EAkBf,CAAC"}

package/dist/app.js

@@ -1,35 +1,47 @@
 import { packageVersion } from "@intentic/agent-cli/version";
 import { buildApplication, buildRouteMap } from "@stricli/core";
+import { checkCommand } from "./commands/check.command.js";
 import { deriveCommand } from "./commands/derive.command.js";
 import { gitAttributesCommand } from "./commands/git-attributes.command.js";
 import { readCommand } from "./commands/read.command.js";
-import { sweepCommand } from "./commands/sweep.command.js";
+import { renderCommand } from "./commands/render.command.js";
 const HELP = `fileq — binary workspace files as clean, budgeted markdown.
 
 Reads the formats an agent cannot: docx, xlsx, pptx, pdf (text layer), images
-(dimensions + EXIF), audio/video (duration + tags), html. Each workspace file
-gets a markdown SIDECAR under .intentic/local/cache/derived/<path>.md, kept
-fresh by content hash — reading a file twice derives once.
+(dimensions + EXIF), audio/video (duration + tags), html. Renderings are cached
+by content hash, so reading unchanged bytes again (the same file, a copy, a
+download outside the workspace) is instant; each workspace file also gets a
+markdown SIDECAR under .intentic/local/cache/derived/<path>.md.
 
   fileq <file>            print it as markdown (default: read), budgeted
   fileq read <file> --budget 8000
   fileq derive <file…>    converge named files' sidecars (stale→derive, gone→remove)
-  fileq sweep             converge the whole workspace, prune orphaned sidecars
   fileq read --plain <f>  the markdown alone, for a program; git's textconv driver
   fileq git-attributes    the gitattributes that route documents through it
 
+After producing a document, check it and look at it:
+
+  fileq check <file>      docx, pptx, xlsx, pdf: problems a reader would meet, each
+                          with its slide, page, cell or paragraph; exit 1 on an error
+  fileq render <file> [--pages 1-3] [--out <dir>]
+                          pages or slides as PNG files, one path per line, for an
+                          image reader (office formats need LibreOffice; all need
+                          pdftoppm or mutool)
+
 git diff, git show and git log -p on a document print its text, not "Binary
 files differ": the sandbox names every derivable extension diff=fileq.
 
 Not fileq's business: plain text (read it directly), the open web (webq),
 files needing OCR or transcription (later tiers say so in their sidecars).
 
-Exit codes: 0 content, 1 nothing derivable, 2 broken invocation or install.`;
+Exit codes: 0 content, 1 nothing derivable (check: an error found), 2 broken
+invocation or install (render: a tool it needs is missing).`;
 export const app = buildApplication(buildRouteMap({
     routes: {
         read: readCommand,
+        check: checkCommand,
+        render: renderCommand,
         derive: deriveCommand,
-        sweep: sweepCommand,
         gitAttributes: gitAttributesCommand,
     },
     defaultCommand: "read",

package/dist/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAG3D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;4EAoB+D,CAAC;AAE7E,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAC/B,aAAa,CAAC;IACV,MAAM,EAAE;QACJ,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,YAAY;QACnB,aAAa,EAAE,oBAAoB;KACtC;IACD,cAAc,EAAE,MAAM;IACtB,IAAI,EAAE,EAAE,KAAK,EAAE,2EAA2E,EAAE,eAAe,EAAE,IAAI,EAAE;CACtH,CAAC,EACF;IACI,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,EAAE,cAAc,EAAE,cAAc,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE;IAChE,OAAO,EAAE,EAAE,SAAS,EAAE,uBAAuB,EAAE;IAC/C,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC;CAC7B,CACJ,CAAC"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAG7D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4DA8B+C,CAAC;AAE7D,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAC/B,aAAa,CAAC;IACV,MAAM,EAAE;QACJ,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,aAAa;QACrB,aAAa,EAAE,oBAAoB;KACtC;IACD,cAAc,EAAE,MAAM;IACtB,IAAI,EAAE,EAAE,KAAK,EAAE,2EAA2E,EAAE,eAAe,EAAE,IAAI,EAAE;CACtH,CAAC,EACF;IACI,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,EAAE,cAAc,EAAE,cAAc,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE;IAChE,OAAO,EAAE,EAAE,SAAS,EAAE,uBAAuB,EAAE;IAC/C,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC;CAC7B,CACJ,CAAC"}

package/dist/commands/check.command.d.ts

@@ -0,0 +1,3 @@
+import { type CommandContext } from "@stricli/core";
+export declare const checkCommand: import("@stricli/core").Command<CommandContext>;
+//# sourceMappingURL=check.command.d.ts.map

package/dist/commands/check.command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.command.d.ts","sourceRoot":"","sources":["../../src/commands/check.command.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AA+ClE,eAAO,MAAM,YAAY,iDA6CvB,CAAC"}

package/dist/commands/check.command.js

@@ -0,0 +1,80 @@
+import { basename, resolve } from "node:path";
+import { capsule } from "@intentic/agent-cli/output";
+import { neutralizeOutsideText } from "@intentic/base/outside-text";
+import { buildCommand } from "@stricli/core";
+const SHOWN_PER_RULE = 12;
+const line = (finding) => {
+    const where = finding.where === "" ? "" : `${finding.where}: `;
+    return neutralizeOutsideText(`${finding.severity === "error" ? "error  " : "warning"} ${where}${finding.message}`);
+};
+const listing = (findings) => {
+    const shown = new Map();
+    const lines = [];
+    const hidden = new Map();
+    for (const finding of [...findings.filter((item) => item.severity === "error"), ...findings.filter((item) => item.severity === "warning")]) {
+        const count = shown.get(finding.rule) ?? 0;
+        if (count < SHOWN_PER_RULE) {
+            lines.push(line(finding));
+            shown.set(finding.rule, count + 1);
+        }
+        else {
+            hidden.set(finding.rule, (hidden.get(finding.rule) ?? 0) + 1);
+        }
+    }
+    for (const [rule, count] of hidden) {
+        lines.push(`… and ${count} more ${rule} (--json lists every one)`);
+    }
+    return lines;
+};
+const counted = (count, noun) => `${count} ${noun}${count === 1 ? "" : "s"}`;
+const tally = (report) => {
+    const errors = report.findings.filter((finding) => finding.severity === "error").length;
+    const warnings = report.findings.length - errors;
+    if (report.findings.length === 0) {
+        return "no problems found";
+    }
+    return [errors > 0 ? counted(errors, "error") : "", warnings > 0 ? counted(warnings, "warning") : ""].filter((part) => part !== "").join(", ");
+};
+export const checkCommand = buildCommand({
+    docs: { brief: "Lint a docx, pptx, xlsx or pdf for problems a reader would meet; exit 1 on any error" },
+    parameters: {
+        flags: {
+            json: { kind: "boolean", default: false, brief: "Every finding as JSON on stdout" },
+        },
+        positional: {
+            kind: "tuple",
+            parameters: [{ parse: String, brief: "The document to check (relative paths resolve against the cwd)", placeholder: "file" }],
+        },
+    },
+    async func(flags, file) {
+        const absPath = resolve(file);
+        const { CHECKABLE, checkFile } = await import("../lib/check/check.js");
+        const outcome = await checkFile(absPath);
+        if (outcome.kind !== "checked") {
+            const reason = outcome.kind === "unreadable"
+                ? outcome.reason
+                : `fileq check reads ${CHECKABLE.join(", ")}; this is ${outcome.format ?? "none of them"} (fileq read shows what it holds)`;
+            this.process.stdout.write(`fileq: cannot check ${absPath}: ${reason}\n`);
+            process.exitCode = 2;
+            return;
+        }
+        const { report } = outcome;
+        const errors = report.findings.filter((finding) => finding.severity === "error").length;
+        process.exitCode = errors > 0 ? 1 : 0;
+        if (flags.json) {
+            const findings = report.findings.map((finding) => ({ ...finding, where: neutralizeOutsideText(finding.where), message: neutralizeOutsideText(finding.message) }));
+            this.process.stdout.write(`${JSON.stringify({ file: absPath, format: report.format, extent: report.extent, errors, warnings: findings.length - errors, findings, notes: report.notes })}\n`);
+            return;
+        }
+        const fields = [basename(absPath), report.format, ...(report.extent === undefined ? [] : [report.extent]), tally(report)];
+        this.process.stdout.write(capsule("fileq", fields, report.notes));
+        const lines = listing(report.findings);
+        if (lines.length > 0) {
+            this.process.stdout.write(`${lines.join("\n")}\n`);
+        }
+        if (errors === 0) {
+            this.process.stdout.write(`structure only: look at the ${report.format === "pptx" ? "slides" : "pages"} with \`fileq render ${file}\`\n`);
+        }
+    },
+});
+//# sourceMappingURL=check.command.js.map

package/dist/commands/check.command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.command.js","sourceRoot":"","sources":["../../src/commands/check.command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,YAAY,EAAuB,MAAM,eAAe,CAAC;AAQlE,MAAM,cAAc,GAAG,EAAE,CAAC;AAG1B,MAAM,IAAI,GAAG,CAAC,OAAgB,EAAU,EAAE;IACtC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC;IAC/D,OAAO,qBAAqB,CAAC,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,IAAI,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;AACvH,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,QAA4B,EAAY,EAAE;IACvD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEzC,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC;QACzI,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,KAAK,GAAG,cAAc,EAAE,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAClE,CAAC;IACL,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,2BAA2B,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,IAAY,EAAU,EAAE,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AAErG,MAAM,KAAK,GAAG,CAAC,MAAmB,EAAU,EAAE;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IACxF,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;IACjD,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC;IACrC,IAAI,EAAE,EAAE,KAAK,EAAE,sFAAsF,EAAE;IACvG,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,iCAAiC,EAAE;SACtF;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,gEAAgE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;SAChI;KACJ;IACD,KAAK,CAAC,IAAI,CAAuB,KAAiB,EAAE,IAAY;QAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAG9B,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,MAAM,GACR,OAAO,CAAC,IAAI,KAAK,YAAY;gBACzB,CAAC,CAAC,OAAO,CAAC,MAAM;gBAChB,CAAC,CAAC,qBAAqB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,OAAO,CAAC,MAAM,IAAI,cAAc,mCAAmC,CAAC;YACpI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,OAAO,KAAK,MAAM,IAAI,CAAC,CAAC;YACzE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACb,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YAClK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;YAC7L,OAAO;QACX,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1H,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,wBAAwB,IAAI,MAAM,CAAC,CAAC;QAC9I,CAAC;IACL,CAAC;CACJ,CAAC,CAAC"}

package/dist/commands/derive.command.js

@@ -30,7 +30,7 @@ export const deriveCommand = buildCommand({
             return;
         }
         if (files.length === 0) {
-            this.process.stdout.write("fileq: derive takes file paths (or run `fileq sweep` for the whole workspace)\n");
+            this.process.stdout.write("fileq: derive takes file paths\n");
             process.exitCode = 2;
             return;
         }

package/dist/commands/derive.command.js.map

@@ -1 +1 @@
-{"version":3,"file":"derive.command.js","sourceRoot":"","sources":["../../src/commands/derive.command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAuB,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,aAAa,EAAgB,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAM9C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAU,EAAE;IACpD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,OAAO,OAAO,CAAC,WAAW,KAAK,OAAO,CAAC,MAAM,UAAU,CAAC;QAC7F,KAAK,OAAO;YACR,OAAO,SAAS,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,gBAAgB,CAAC;QACtD,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IAC/D,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC;IACtC,IAAI,EAAE,EAAE,KAAK,EAAE,mFAAmF,EAAE;IACpG,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,0BAA0B,EAAE;SAC/E;QACD,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,sFAAsF,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE;KAClL;IACD,KAAK,CAAC,IAAI,CAAuB,KAAkB,EAAE,GAAG,KAAe;QACnE,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mGAAmG,CAAC,CAAC;YAC/H,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,iFAAiF,CAAC,CAAC;YAC7G,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC/D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7I,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;CACJ,CAAC,CAAC"}
+{"version":3,"file":"derive.command.js","sourceRoot":"","sources":["../../src/commands/derive.command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAuB,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,aAAa,EAAgB,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAM9C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAU,EAAE;IACpD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,OAAO,OAAO,CAAC,WAAW,KAAK,OAAO,CAAC,MAAM,UAAU,CAAC;QAC7F,KAAK,OAAO;YACR,OAAO,SAAS,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,gBAAgB,CAAC;QACtD,KAAK,SAAS;YACV,OAAO,WAAW,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IAC/D,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC;IACtC,IAAI,EAAE,EAAE,KAAK,EAAE,mFAAmF,EAAE;IACpG,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,0BAA0B,EAAE;SAC/E;QACD,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,sFAAsF,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE;KAClL;IACD,KAAK,CAAC,IAAI,CAAuB,KAAkB,EAAE,GAAG,KAAe;QACnE,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,mGAAmG,CAAC,CAAC;YAC/H,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAC9D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC/D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7I,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;CACJ,CAAC,CAAC"}

package/dist/commands/read.command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read.command.d.ts","sourceRoot":"","sources":["../../src/commands/read.command.ts"],"names":[],"mappings":"AAQA,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAalE,eAAO,MAAM,WAAW,iDAwCtB,CAAC"}
+{"version":3,"file":"read.command.d.ts","sourceRoot":"","sources":["../../src/commands/read.command.ts"],"names":[],"mappings":"AAKA,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAWlE,eAAO,MAAM,WAAW,iDA2CtB,CAAC"}

package/dist/commands/read.command.js

@@ -1,15 +1,10 @@
-import { createHash } from "node:crypto";
-import { mkdir, writeFile } from "node:fs/promises";
-import { basename, join, resolve } from "node:path";
-import { toolOutDir } from "@intentic/agent-cli/env";
+import { basename, resolve } from "node:path";
 import { countParser } from "@intentic/agent-cli/flags";
 import { capsule, clip } from "@intentic/agent-cli/output";
 import { estimateTokens } from "@intentic/base/format";
 import { buildCommand } from "@stricli/core";
-import { errorMessage } from "@intentic/base/errors";
-import { deriverStamp, neutralizeDoc } from "../lib/derivers/deriver.js";
-import { detectFormat } from "../lib/formats.js";
-import { DERIVERS, ensureSidecar } from "../lib/derive.js";
+import { deriverStamp } from "../lib/derivers/deriver.js";
+import { DERIVERS, ensureSidecar, renderByContent } from "../lib/derive.js";
 import { workspaceRoot } from "../lib/env.js";
 export const readCommand = buildCommand({
     docs: { brief: "One file as clean markdown: budgeted on stdout, whole in its sidecar" },
@@ -17,7 +12,7 @@ export const readCommand = buildCommand({
         flags: {
             budget: { kind: "parsed", parse: countParser, default: "4000", brief: "Max stdout tokens; 0 prints only the capsule" },
             json: { kind: "boolean", default: false, brief: "Machine-readable result on stdout" },
-            plain: { kind: "boolean", default: false, brief: "The markdown alone, whole and unbudgeted; nothing saved for a file outside the workspace (git textconv)" },
+            plain: { kind: "boolean", default: false, brief: "The markdown alone, whole and unbudgeted (git textconv)" },
         },
         positional: {
             kind: "tuple",
@@ -27,8 +22,7 @@ export const readCommand = buildCommand({
     async func(flags, file) {
         const absPath = resolve(file);
         const root = workspaceRoot();
-        const save = !flags.plain;
-        const result = root === undefined ? await readOutsideWorkspace(absPath, save) : await readInWorkspace(root, absPath, save);
+        const result = root === undefined ? await readOutsideWorkspace(undefined, absPath) : await readInWorkspace(root, absPath);
         if (result === undefined) {
             process.exitCode = 1;
             return;
@@ -42,18 +36,22 @@ export const readCommand = buildCommand({
             return;
         }
         const fields = [result.title ?? basename(absPath), result.format, `${result.tokens} tokens`, result.source];
-        this.process.stdout.write(capsule("fileq", fields, result.notes));
-        this.process.stdout.write(`saved: ${result.savedPath}\n`);
+        const notes = result.savedPath === undefined ? [...result.notes, "nothing saved: the rendering cache could not be written"] : result.notes;
+        this.process.stdout.write(capsule("fileq", fields, notes));
+        if (result.savedPath !== undefined) {
+            this.process.stdout.write(`saved: ${result.savedPath}\n`);
+        }
         if (flags.budget > 0 && result.body !== "") {
+            const whole = result.savedPath ?? `the output of \`fileq read --plain ${absPath}\``;
             this.process.stdout.write("---\n");
-            this.process.stdout.write(withFinalNewline(clip(result.body, flags.budget, result.savedPath, "document")));
+            this.process.stdout.write(withFinalNewline(clip(result.body, flags.budget, whole, "document")));
         }
     },
 });
-const readInWorkspace = async (root, absPath, save) => {
+const readInWorkspace = async (root, absPath) => {
     const outcome = await ensureSidecar(root, absPath);
     if (outcome.kind === "skipped" && outcome.reason === "outside-workspace") {
-        return readOutsideWorkspace(absPath, save);
+        return readOutsideWorkspace(root, absPath);
     }
     return fromOutcome(outcome);
 };
@@ -88,38 +86,21 @@ const fromOutcome = (outcome) => {
         }
     }
 };
-const readOutsideWorkspace = async (absPath, save) => {
-    const format = await detectFormat(absPath).catch(() => undefined);
-    if (format === undefined) {
-        process.stdout.write(`fileq: cannot read ${absPath}: unsupported or missing\n`);
+const readOutsideWorkspace = async (root, absPath) => {
+    const outcome = await renderByContent(root, absPath);
+    if (outcome.kind === "failed") {
+        process.stdout.write(`fileq: cannot read ${absPath}: ${outcome.reason}\n`);
         return undefined;
     }
-    let doc;
-    try {
-        doc = neutralizeDoc(await DERIVERS[format].derive(absPath));
-    }
-    catch (error) {
-        process.stdout.write(`fileq: cannot read ${absPath}: derive-failed (${format}): ${errorMessage(error).split("\n")[0]}\n`);
-        return undefined;
-    }
-    const outDir = toolOutDir("fileq");
-    const hash = createHash("sha256").update(absPath).digest("hex").slice(0, 8);
-    const savedPath = join(outDir, `${basename(absPath)
-        .toLowerCase()
-        .replaceAll(/[^a-z0-9.]+/g, "-")}-${hash}.md`);
-    if (save) {
-        await mkdir(outDir, { recursive: true });
-        await writeFile(savedPath, `${doc.markdown}\n`);
-    }
     return {
-        format,
-        deriver: deriverStamp(DERIVERS[format]),
-        body: doc.markdown,
-        tokens: estimateTokens(doc.markdown),
-        savedPath,
-        source: "derived",
-        title: doc.title,
-        notes: doc.notes,
+        format: outcome.format,
+        deriver: deriverStamp(DERIVERS[outcome.format]),
+        body: outcome.doc.markdown,
+        tokens: estimateTokens(outcome.doc.markdown),
+        savedPath: outcome.cachedPath,
+        source: outcome.kind,
+        title: outcome.doc.title,
+        notes: outcome.doc.notes,
     };
 };
 const withFinalNewline = (text) => (text.endsWith("\n") ? text : `${text}\n`);