Merge pull request 'dev' (#1) from dev into main

Reviewed-on: #1

.gitea/workflows/build-and-release.yml

@@ -0,0 +1,30 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build and release binaries
+        uses: bearmetal/ci-actions/deno-publish@main
+        with:
+          entrypoint: main.ts
+          compile-flags: "--allow-read --allow-write --allow-env --allow-net"
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: 2.3.1
+
+      - name: Publish to JSR
+        run: deno publish --token ${{ secrets.JSR_TOKEN }}

.gitea/workflows/tag-cli.yml

@@ -0,0 +1,13 @@
+name: Create Version Tag
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bearmetal/ci-actions/version-check@main

cli/TerminalLayout.ts

@@ -79,15 +79,15 @@ export class TerminalLayout {
   }
 
   clearAll() {
+    for (const name of this.layoutOrder) {
+      this.blocks[name].clear();
+    }
     Deno.stdout.writeSync(
       new TextEncoder().encode(
         TerminalLayout.ALT_BUFFER_DISABLE,
       ),
     );
     Cursor.show();
-    for (const name of this.layoutOrder) {
-      this.blocks[name].clear();
-    }
   }
 
   clear() {
@@ -223,7 +223,6 @@ export class TerminalBlock {
     for (let i = 0; i < this.renderedLineCount; i++) {
       Deno.stdout.writeSync(new TextEncoder().encode(`\x1b[2K\x1b[1E`));
     }
-    this.renderedLineCount = 0;
   }
 
   clearAll() {

cli/argParser.ts

@@ -1,5 +1,6 @@
-export class ArgParser {
+export class ArgParser<T extends Record<string, string[]>> {
   private args: string[];
+  private flags: Map<keyof T, boolean> = new Map();
 
   constructor(args: string[]) {
     this.args = args;
@@ -11,7 +12,22 @@ export class ArgParser {
     return this.args[index + 1];
   }
 
-  get flags() {
+  setFlagDefs(flagDefs: T) {
+    for (const [flag, defs] of Object.entries(flagDefs)) {
+      for (const def of defs) {
+        if (this.argFlags.includes(def)) {
+          this.flags.set(flag, true);
+        }
+      }
+    }
+    return this;
+  }
+
+  getFlag(flag: keyof T) {
+    return this.flags.get(flag);
+  }
+
+  get argFlags() {
     return this.args.filter((arg) => arg.startsWith("-"));
   }
 
@@ -26,6 +42,9 @@ export class ArgParser {
   get task() {
     return this.nonFlags[0];
   }
+  get taskArgs() {
+    return this.nonFlags.slice(1);
+  }
 
   static parse(args: string[]) {
     return new ArgParser(args);

cli/index.ts

@@ -5,26 +5,38 @@ import { colorize } from "./style.ts";
 import { selectMenuInteractive } from "./selectMenu.ts";
 import { TerminalBlock, TerminalLayout } from "./TerminalLayout.ts";
 import { cliAlert, cliLog } from "./prompts.ts";
+import type { ITool } from "../types.ts";
+import { join, toFileUrl } from "@std/path";
+import { log } from "util/logfile.ts";
+
+// Register tools here (filename, no extension)
+const toolRegistry: [string, Promise<{ default: ITool }>][] = [
+  ["checkCode", import("../tools/checkCode.ts")],
+  ["fieldRename", import("../tools/fieldRename.ts")],
+  ["listFormFields", import("../tools/listFormFields.ts")],
+];
 
 export class PdfToolsCli {
   private tools: Map<string, ITool> = new Map();
   private terminalLayout = new TerminalLayout();
+  closeMessage?: string;
 
-  private args = ArgParser.parse(Deno.args);
+  private args = ArgParser.parse(Deno.args).setFlagDefs({
+    help: ["-h", "--help"],
+  });
 
-  async importTools(tools?: string) {
-    tools = tools?.replace(/\/$/, "").replace(/^\.?\//, "") || "tools";
-    for (const toolfile of Deno.readDirSync(tools)) {
-      if (toolfile.isFile) {
-        const tool = await import(
-          Deno.cwd() + "/" + tools + "/" + toolfile.name
-        );
-        if (tool.default) {
+  async importTools() {
+    for (const [name, toolfile] of toolRegistry) {
+      const t = await toolfile;
+      try {
+        if (t.default) {
           this.tools.set(
-            toCase(toolfile.name.replace(".ts", ""), "title"),
-            tool.default,
+            toCase(name, "title"),
+            t.default,
           );
         }
+      } catch (e) {
+        cliLog(e + "\n", this.terminalLayout.getBlock("body"));
       }
     }
   }
@@ -47,21 +59,25 @@ export class PdfToolsCli {
 
   public async run() {
     try {
+      await this.importTools();
       const titleBlock = new TerminalBlock();
       this.terminalLayout.register("title", titleBlock);
       const bodyBlock = new TerminalBlock();
       this.terminalLayout.register("body", bodyBlock);
+      if (this.args.getFlag("help") && !this.args.task) {
+        await this.help();
+        return;
+      } else if (this.args.nonFlags.length === 0 || !this.args.task) {
         this.embiggenHeader();
-      if (Deno.args.length === 0) {
-        // console.log(
-        //   colorize("No tool specified. Importing all tools...", "gray"),
-        // );
-        await this.importTools();
-      }
         await this.toolMenu();
+      } else {
+        const task = this.args.task;
+        await this.runTool(toCase(task, "title"));
+      }
     } finally {
       this.terminalLayout.clearAll();
       Deno.stdin.setRaw(false);
+      if (this.closeMessage) console.log(this.closeMessage);
     }
   }
 
@@ -95,9 +111,15 @@ export class PdfToolsCli {
       const bodyBlock = this.terminalLayout.getBlock("body");
       bodyBlock.clearAll();
       tool.setBlock?.(bodyBlock);
-      await tool.run();
+      if (this.args.getFlag("help")) {
+        await tool.help?.();
+      } else {
+        await tool.run(...this.args.taskArgs);
         await tool.done?.();
-      this.embiggenHeader();
+      }
+      await this.embiggenHeader();
+    } else {
+      this.closeMessage = "No tool found for " + toolName;
     }
   }
 

cli/prompts.ts

@@ -1,3 +1,4 @@
+// deno-lint-disable-must-await-calls
 import { Cursor } from "./cursor.ts";
 import { colorize } from "./style.ts";
 import { TerminalBlock, TerminalLayout } from "./TerminalLayout.ts";
@@ -11,11 +12,8 @@ export async function cliPrompt(
 
   await Deno.stdin.setRaw(true);
 
-  let cursorVisible = true;
-  if (!block) {
-    cursorVisible = Cursor["visible"];
+  const cursorVisible = Cursor["visible"];
   Cursor.show();
-  }
 
   let range: [number, number] = [0, 1];
   if (block) {
@@ -54,7 +52,7 @@ export async function cliPrompt(
   }
 
   await Deno.stdin.setRaw(false);
-  if (!block && !cursorVisible) {
+  if (!cursorVisible) {
     Cursor.hide();
   }
   Deno.stdout.writeSync(encoder.encode("\n"));
@@ -77,19 +75,25 @@ export function cliAlert(message: string, block?: TerminalBlock) {
   });
 }
 
-export function cliLog(message: string, block?: TerminalBlock) {
+export function cliLog(
+  message: string | object | Array<unknown>,
+  block?: TerminalBlock,
+) {
   if (!block) {
     console.log(message);
   } else {
+    if (typeof message === "object") message = Deno.inspect(message);
     block.setLines(message.split("\n"));
   }
 }
 
 if (import.meta.main) {
+  Cursor.hide();
   const layout = new TerminalLayout();
   const title = new TerminalBlock();
   const block = new TerminalBlock();
   block.setPreserveHistory(true);
+  // ScrollManager.enable(block);
   title.setLines(["Hello, World!"]);
   title.setFixedHeight(1);
 
@@ -105,6 +109,7 @@ if (import.meta.main) {
   cliLog(`Hello, ${name}!`, block);
   const single = await cliConfirm("Are you single?", block);
   cliLog(single ? "Do you want to go out with me?" : "Okay", block);
+  // ScrollManager.enable(block);
   const loopingConvo = [
     "No response?",
     "I guess that's okay",

cli/selectMenu.ts

@@ -1,3 +1,4 @@
+import type { callback } from "../types.ts";
 import { colorize } from "./style.ts";
 import { TerminalBlock } from "./TerminalLayout.ts";
 

deno.json

@@ -1,6 +1,7 @@
 {
   "name": "@bearmetal/pdf-tools",
-  "version": "0.0.1",
+  "version": "1.0.0",
+  "license": "GPL 3.0",
   "tasks": {
     "dev": "deno run -A --env-file=.env --watch main.ts",
     "compile": "deno compile -o compare-form-fields.exe --target x86_64-pc-windows-msvc -R ./main.ts",
@@ -9,6 +10,7 @@
   },
   "imports": {
     "@std/assert": "jsr:@std/assert@1",
+    "@std/path": "jsr:@std/path@^1.0.9",
     "pdf-lib": "npm:pdf-lib@^1.17.1",
     "util/": "./util/"
   },
@@ -19,10 +21,14 @@
     "rules": {
       "exclude": [
         "no-explicit-any"
+      ],
+      "include": [
+        "require-await"
       ]
     },
     "plugins": [
-      "./no-log.ts"
+      "./no-log.ts",
+      "./must_await_cli_prompts.ts"
     ]
   }
 }

deno.lock

@@ -1,8 +1,9 @@
 {
-  "version": "4",
+  "version": "5",
   "specifiers": {
     "jsr:@std/assert@1": "1.0.12",
     "jsr:@std/internal@^1.0.6": "1.0.6",
+    "jsr:@std/path@^1.0.9": "1.0.9",
     "npm:pdf-lib@^1.17.1": "1.17.1"
   },
   "jsr": {
@@ -14,6 +15,9 @@
     },
     "@std/internal@1.0.6": {
       "integrity": "9533b128f230f73bd209408bb07a4b12f8d4255ab2a4d22a1fd6d87304aca9a4"
+    },
+    "@std/path@1.0.9": {
+      "integrity": "260a49f11edd3db93dd38350bf9cd1b4d1366afa98e81b86167b4e3dd750129e"
     }
   },
   "npm": {
@@ -48,6 +52,7 @@
   "workspace": {
     "dependencies": [
       "jsr:@std/assert@1",
+      "jsr:@std/path@^1.0.9",
       "npm:pdf-lib@^1.17.1"
     ]
   }

main.ts

@@ -1,3 +1,4 @@
+/// <reference types="./types.ts" />
 import { PdfToolsCli } from "./cli/index.ts";
 
 const app = new PdfToolsCli();

must_await_cli_prompts.ts

@@ -0,0 +1,45 @@
+const TARGET_FUNCTIONS = new Set(["cliAlert", "cliPrompt", "cliConfirm"]);
+
+const plugin: Deno.lint.Plugin = {
+  name: "must-await-calls",
+  rules: {
+    "must-await-calls": {
+      create(context) {
+        return {
+          CallExpression(node) {
+            if (
+              node.callee.type !== "Identifier" ||
+              !TARGET_FUNCTIONS.has(node.callee.name)
+            ) return;
+
+            const parent = node.parent;
+
+            // Allow `await fetchData()`
+            if (parent?.type === "AwaitExpression") return;
+
+            // Allow `return fetchData()` or `return await fetchData()`
+            if (parent?.type === "ReturnStatement") return;
+
+            // Allow `fetchData().then(...)`
+            if (
+              parent?.type === "MemberExpression" &&
+              parent.property.type === "Identifier" &&
+              parent.property.name === "then"
+            ) return;
+
+            context.report({
+              node,
+              message:
+                `Call to "${node.callee.name}" must be awaited, returned, or .then-chained.`,
+              fix(fixer) {
+                return fixer.insertTextBefore(node, "await ");
+              },
+            });
+          },
+        };
+      },
+    },
+  },
+};
+
+export default plugin;

testing/test.ts

@@ -0,0 +1,7 @@
+const thing: string = "";
+switch (thing) {
+  case "Text1":
+    break;
+  default:
+    break;
+}

tools/checkCode.ts

@@ -1,57 +1,75 @@
+import { forceArgs } from "../cli/forceArgs.ts";
+import { cliAlert, cliLog } from "../cli/prompts.ts";
+import { colorize } from "../cli/style.ts";
+import type { TerminalBlock } from "../cli/TerminalLayout.ts";
+import type { ITool } from "../types.ts";
 import { loadPdfForm } from "../util/saveLoadPdf.ts";
-import { callWithArgPrompt } from "util/call.ts";
 
-export async function checkFile(pdfPath: string, csPath: string) {
-  while (!pdfPath || !pdfPath.endsWith(".pdf")) {
-    pdfPath = prompt("Please provide path to PDF file:") || "";
-  }
-  while (!csPath || !csPath.endsWith(".cs")) {
-    csPath = prompt("Please provide path to CS class file:") || "";
-  }
-
-  const form = await loadPdfForm(pdfPath);
-
-  const fields = form.getFields();
-  const csFiles = await Promise.all(
-    csPath.split(",").map((c) => Deno.readTextFile(c.trim())),
-  );
-
-  const fieldNames: string[] = fields.map((f) => f.getName())
-    .filter((f) => {
-      const rx = new RegExp(
-        `(?<!//\s?)case ?"${f.replace(/\[\d\]/, "\\[\\?\\]")}"`,
-      );
-      return !csFiles.some((c) => rx.test(c));
-    })
-    .filter((f) => !f.toLowerCase().includes("signature"));
-
-  if (fieldNames.length) {
-    console.log(
-      "%cThe following field names are not present in the CS code",
-      "color: red",
-    );
-    console.log(fieldNames);
-    alert("Your princess is in another castle...");
-  } else {
-    console.log("%cAll form fields present", "color: lime");
-    alert("Ok!");
+function getCaseSyntaxPatternByFileExtension(
+  extenstion: string,
+  field: string,
+) {
+  switch (extenstion.trim().toLowerCase().replace(".", "")) {
+    case "cs":
+    case "js":
+    case "ts":
+    default:
+      return `(?<!//\s?)case ?"${field.replace(/\[\d\]/, `\\[\\?|\\d+\\]`)}"`;
   }
 }
 
 class CheckCode implements ITool {
   name = "checkcode";
-  description = "Checks if form fields are present in CS code";
-  help() {
-    console.log("Usage: checkcode <pdfPath> <csPath>");
+  description = "Checks if form fields are present in a given code file";
+  private block?: TerminalBlock;
+  setBlock(block: TerminalBlock) {
+    this.block = block;
+    this.block.setPreserveHistory(true);
+  }
+  async help() {
+    cliLog("Usage: checkcode <pdfPath> <csPath>", this.block);
+    await cliAlert("", this.block);
+  }
+  async run(pdfPath: string, codePaths: string) {
+    [pdfPath, codePaths] = await forceArgs([pdfPath, codePaths], [
+      "Please provide path to PDF file:",
+      "Please provide path(s) to code file(s) (comma separated for multiple):",
+    ], this.block);
+
+    const form = await loadPdfForm(pdfPath);
+
+    const fields = form.getFields();
+    const codeFiles: [string, string][] = codePaths.split(",").map((
+      c,
+    ) => [c, Deno.readTextFileSync(c.trim())]);
+
+    const fieldNames: string[] = fields.map((f) => f.getName())
+      .filter((f) => !f.toLowerCase().includes("signature"));
+    let unfound = fieldNames.slice();
+
+    for (const [path, content] of codeFiles) {
+      unfound = unfound.filter((f) => {
+        const rx = new RegExp(
+          getCaseSyntaxPatternByFileExtension(path.split(".").at(-1) ?? "", f),
+        );
+        return rx.test(content);
+      });
+    }
+
+    if (unfound.length) {
+      cliLog(
+        colorize(
+          "The following field names are not present in the CS code",
+          "red",
+        ),
+        this.block,
+      );
+      cliLog(unfound, this.block);
+      await cliAlert("Your princess is in another castle...", this.block);
+    } else {
+      cliLog(colorize("All form fields present", "green"), this.block);
+      await cliAlert("Ok!", this.block);
     }
-  async run(...args: string[]) {
-    await callWithArgPrompt(checkFile, [
-      ["Please provide path to PDF file:", (p) => !!p && p.endsWith(".pdf")],
-      [
-        "Please provide path to CS file (comma separated for multiple):",
-        (p) => !!p && p.endsWith(".cs"),
-      ],
-    ], args);
   }
 }
 

tools/fieldRename.ts

@@ -4,24 +4,9 @@ import { callWithArgPrompt } from "util/call.ts";
 import { TerminalBlock } from "../cli/TerminalLayout.ts";
 import { forceArgs } from "../cli/forceArgs.ts";
 import { colorize } from "../cli/style.ts";
-import { cliLog, cliPrompt } from "../cli/prompts.ts";
+import { cliAlert, cliLog, cliPrompt } from "../cli/prompts.ts";
 import { multiSelectMenuInteractive } from "../cli/selectMenu.ts";
-
-// const thing = PDFAcroField.prototype.getFullyQualifiedName;
-// PDFAcroField.prototype.getFullyQualifiedName = function () {
-//     const name = thing.call(this)
-//     // if (name?.includes('langauge'))
-//     console.log(name)
-//     return name;
-// }
-
-// const thing = PDFHexString.prototype.copyBytesInto
-// PDFHexString.prototype.copyBytesInto = function (buffer: Uint8Array, offset: number) {
-//     console.log((this as any).value)
-
-//     const result = thing.call(this, buffer, offset)
-//     return result;
-// }
+import type { callback, ITool } from "../types.ts";
 
 async function renameFields(
   path: string,
@@ -48,29 +33,10 @@ async function renameFields(
           if (mName) {
             changesMade = true;
             cField.dict.set(PDFName.of("T"), PDFString.of(mName));
-            // console.log(cField.getPartialName())
           }
         }
         cField = cField.getParent();
-        // console.log(cField?.getPartialName())
       }
-      console.log(field.getName());
-      // const newName = name.replace(pattern, change);
-      // console.log("Change to: %c" + newName, "color: yellow");
-      // if (confirm('Ok?')) {
-      //     let parent = field.acroField.getParent();
-      //     field.acroField.setPartialName(segments.pop())
-      //     while (parent && segments.length) {
-      //         console.log(parent.getPartialName())
-      //         parent.setPartialName(segments.pop())
-      //         parent = parent.getParent();
-      //     }
-      //     changesMade = true;
-      //     console.log(field.getName())
-      //     // dict.set(PDFName.of("T"), PDFHexString.fromText(newName))
-      //     console.log("%cDone!", "color: lime")
-      // }
-      // break;
     }
   }
   if (changesMade) {
@@ -122,9 +88,9 @@ class RenameFields implements ITool {
     this.block = block;
   }
 
-  help(standalone = false) {
-    cliLog(
-      "Usage: renamefields <pdfPath> <pattern> <change>",
+  async help(standalone = false) {
+    await cliAlert(
+      "Usage: rename-fields <pdfPath> <pattern> <change>\n",
       standalone ? undefined : this.block,
     );
   }

tools/listFormFields.ts

@@ -2,6 +2,7 @@ import { forceArgs } from "../cli/forceArgs.ts";
 import { cliAlert } from "../cli/prompts.ts";
 import { TerminalBlock } from "../cli/TerminalLayout.ts";
 import { loadPdfForm } from "util/saveLoadPdf.ts";
+import type { ITool } from "../types.ts";
 
 export class ListFormFields implements ITool {
   name = "listformfields";

types.ts

@@ -1,8 +1,7 @@
 import type { TerminalBlock } from "./cli/TerminalLayout.ts";
 
-declare global {
-  type ToolFunc<T extends unknown[]> = (...args: T) => Promise<void>;
-  interface ITool {
+export type ToolFunc<T extends unknown[]> = (...args: T) => Promise<void>;
+export interface ITool {
   name: string;
   description: string;
   run: ToolFunc<any[]>;
@@ -11,5 +10,4 @@ declare global {
   setBlock?: (block: TerminalBlock) => void;
 }
 
-  type callback = (...args: any[]) => any;
-}
+export type callback = (...args: any[]) => any;

util/call.ts

@@ -1,3 +1,5 @@
+import type { ToolFunc } from "../types.ts";
+
 type transformer = (arg: string) => any;
 interface IConfig {
   multiTransform?: boolean;

util/saveLoadPdf.ts

@@ -1,4 +1,4 @@
-import { PDFDocument } from "pdf-lib";
+import { PDFDocument, PDFTextField } from "pdf-lib";
 
 export async function loadPdfForm(path: string) {
   const pdfDoc = await loadPdf(path);
@@ -13,6 +13,11 @@ export async function loadPdf(path: string) {
 }
 
 export async function savePdf(doc: PDFDocument, path: string) {
+  doc.getForm().getFields().forEach((field) => {
+    if (field instanceof PDFTextField) {
+      field.disableRichFormatting();
+    }
+  });
   const pdfBytes = await doc.save();
   if (Deno.env.get("DRYRUN") || path.includes("dryrun")) return;
   await Deno.writeFile(path, pdfBytes);