docrev 0.9.17 → 0.10.0

package/scripts/postbuild.js

@@ -6,14 +6,20 @@
  * tsc compiles bin/rev.ts → dist/bin/rev.js but:
  *   1. Preserves the #!/usr/bin/env tsx shebang (needs to be node)
  *   2. Relative paths like '../package.json' break (bin/ → dist/bin/ adds a level)
+ *
+ * Also copies non-TS asset files (lua filters) from lib/ to dist/lib/ so the
+ * compiled output can locate them via `import.meta.url`. Without this step
+ * the lua filters live in lib/ in the published tarball while the runtime
+ * looks for them in dist/lib/.
  */
 
-import { readFileSync, writeFileSync } from 'fs';
+import { readFileSync, writeFileSync, readdirSync, copyFileSync, mkdirSync, existsSync } from 'fs';
 import { join, dirname } from 'path';
 import { fileURLToPath } from 'url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
-const revPath = join(__dirname, '..', 'dist', 'bin', 'rev.js');
+const projectRoot = join(__dirname, '..');
+const revPath = join(projectRoot, 'dist', 'bin', 'rev.js');
 
 let content = readFileSync(revPath, 'utf-8');
 
@@ -26,3 +32,16 @@ content = content.replace("'../package.json'", "'../../package.json'");
 
 writeFileSync(revPath, content, 'utf-8');
 console.log('postbuild: fixed dist/bin/rev.js (shebang + paths)');
+
+// Copy lua filter assets so import.meta.url resolves them at runtime.
+const libDir = join(projectRoot, 'lib');
+const distLibDir = join(projectRoot, 'dist', 'lib');
+if (!existsSync(distLibDir)) {
+  mkdirSync(distLibDir, { recursive: true });
+}
+for (const entry of readdirSync(libDir)) {
+  if (entry.endsWith('.lua')) {
+    copyFileSync(join(libDir, entry), join(distLibDir, entry));
+    console.log(`postbuild: copied ${entry} → dist/lib/`);
+  }
+}

package/skill/REFERENCE.md

@@ -62,11 +62,77 @@ rev build docx               # DOCX only
 rev build --toc              # Include table of contents
 rev build docx --dual        # Clean + annotated versions
 rev build docx --show-changes  # DOCX with visible track changes (audit)
+rev build docx --pandoc-arg=--lua-filter=tofill.lua   # Pass extra args to pandoc
+rev build -o Final_Report     # Override output filename (extension auto-added)
+rev build pdf --verbose      # Echo the pandoc invocation (useful for filter debugging)
 ```
 
 By default, outputs land in `output/` next to `rev.yaml`. Override or
 disable via the `outputDir` field in rev.yaml (see below).
 
+#### Choosing output filenames
+
+By default, the output basename is derived from `title:` (slugified — e.g.
+"My Paper" → `my-paper.docx`). Long titles are truncated at word boundaries
+(at the last `-` at-or-before 80 chars), so `communities` stays whole instead
+of becoming `communitie`.
+
+To pick your own filename, set per-format names in `rev.yaml`:
+
+```yaml
+output:
+  docx: ADAPT_proposal_draft.docx
+  pdf: ADAPT_proposal_draft.pdf
+```
+
+Extensions are optional — `ADAPT_proposal_draft` is fine, the right extension
+is added per format. Relative paths resolve under `outputDir`; absolute paths
+bypass `outputDir`.
+
+Or override on the command line with `-o, --output <path>`:
+
+```bash
+rev build docx -o Final_Report           # → output/Final_Report.docx
+rev build pdf docx -o Final_Report       # Applies to both formats
+rev build -o /tmp/draft.docx docx        # Absolute path bypasses outputDir
+```
+
+CLI `-o` wins over `output:` in `rev.yaml`. When `--dual` is on, the
+`_comments` variant piggybacks on the chosen name (e.g.
+`Final_Report_comments.docx`). When `--show-changes` is on, the audit DOCX
+uses the chosen name with a `-changes` suffix
+(e.g. `Final_Report-changes.docx`).
+
+#### Passing custom pandoc args
+
+For pandoc flags rev doesn't surface directly (Lua/JSON filters, custom
+templates, variables, etc.), use the repeatable `--pandoc-arg` flag or the
+`pandoc-args` field in `rev.yaml`:
+
+```yaml
+# rev.yaml — applies to every format
+pandoc-args:
+  - --lua-filter=tofill.lua
+  - --shift-heading-level-by=1
+
+# Format-specific (concatenated after the top-level list)
+docx:
+  pandoc-args:
+    - --lua-filter=docx_only.lua
+pdf:
+  pandoc-args:
+    - --variable=papersize:a4
+```
+
+```bash
+# CLI overrides — appended last, so pandoc's last-wins rule lets CLI flags
+# beat repeated config flags
+rev build docx --pandoc-arg=--lua-filter=cli.lua --pandoc-arg=--metadata=draft:true
+```
+
+Run with `--verbose` to print the full pandoc command line (one per format).
+Copy-paste it into a terminal to reproduce a build manually.
+
 The `--dual` flag produces:
 - `output/<title>.docx` — clean, for submission
 - `output/<title>_comments.docx` — includes comment threads as Word comments

package/skill/SKILL.md

@@ -17,9 +17,8 @@ Layout is controlled in `rev.yaml`:
 
 ```yaml
 title: "My Document"
-output:
-  docx:
-    reference-doc: template.docx
+docx:
+  reference: template.docx
 ```
 
 Change the template, rebuild, and every document gets the new formatting.
@@ -98,7 +97,15 @@ revision is rendered as a visible Word track change. Useful when a co-author
 wants to see what changed since the last shared version.
 
 Outputs land in `output/` by default; set `outputDir: null` in `rev.yaml`
-to keep them alongside `paper.md` (legacy layout).
+to keep them alongside `paper.md` (legacy layout). The basename is derived
+from `title:` unless overridden — set `output: { docx: foo.docx, pdf: foo.pdf }`
+in `rev.yaml` or pass `-o, --output <path>` on the CLI. See REFERENCE.md →
+"Choosing output filenames".
+
+For pandoc flags rev doesn't surface directly (Lua filters, custom variables,
+templates), use `--pandoc-arg` (repeatable) or `pandoc-args:` in `rev.yaml`
+(both top-level and per-format). Run with `--verbose` to see the exact pandoc
+invocation. See REFERENCE.md → "Passing custom pandoc args" for details.
 
 ### 8. Archive reviewer files
 
@@ -183,6 +190,20 @@ Use in markdown files:
 - `@eq:label` - Equation reference
 - `{#fig:label}` - Anchor for figures
 
+Insert a figure with the format-portable syntax (renders in both PDF and Word):
+
+```markdown
+![Caption text.](figures/foo.pdf){#fig:foo width=80%}
+```
+
+Raw `\begin{figure}...\end{figure}` LaTeX blocks are PDF-only. For docx
+builds, `rev` auto-translates the common shape (single `\includegraphics`
+with optional `\caption{...}` and `\label{...}`) to the markdown form above
+so figures still render. Exotic blocks (`\subfloat`, `\rotatebox`, multiple
+`\includegraphics`) are left alone and warned about — convert them by hand
+or supply a custom Lua filter via `--pandoc-arg`. Opt out of auto-translate
+with `docx.translateRawFigures: false` in `rev.yaml`.
+
 ## Template Variables
 
 Available in section files (processed during build):

package/.claude/settings.local.json

@@ -1,9 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Skill(code-quality)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}