chore: changelog and new readme

Reviewed-on: #7

.gitea/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Create Version Tag
+
+on:
+  push:
+    branches:
+      - main
+      - "prerelease-*"
+
+jobs:
+  version-check:
+    runs-on: ubuntu-latest
+    outputs:
+      tag_created: ${{ steps.tag.outputs.tag_created }}
+      tag_name: ${{ steps.tag.outputs.tag_name }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run version check
+        id: tag
+        uses: https://git.cyborggrizzly.com/bearmetal/ci-actions/version-check@v1
+
+  build-release:
+    if: needs.version-check.outputs.tag_created == 'true'
+    needs: version-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Build and release binaries
+        uses: https://git.cyborggrizzly.com/bearmetal/ci-actions/deno-release@main
+        with:
+          entrypoint: main.ts
+          compile-flags: "--allow-read --allow-write --allow-env --allow-net"
+        env:
+          GITEA_TOKEN: ${{ secrets.GIT_PAT }}
+
+  publish-release:
+    needs: build-release
+    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_PAT }}

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## v1.0.1 (2025-07-25)
+
+<!-- auto-changelog -->
+
+### Known Issues
+
+- help flags can cause issues
+
+## v1.0.0 (2025-07-25)
+
+### Features
+
+- Check Code Tool
+  - reads supplied code files to see if form fields are present and represented
+    in a switch statement
+- Field Rename Tool
+  - provide a search and replace pattern to bulk rename form fields
+- List Form Fields
+  - Sometimes you just need to see what fields there are
+
+### Known Issues
+
+- Field rename does not represent full change applied to the field, only the
+  replaced text
+- help flags can cause issues
+- ascii art is broken (sad face)
+- banana doesn't work
+
+## v0.0.0 (never)
+
+this is just here for a reference to the auto-changelog
+
+<!-- auto-changelog -->

README.md

@@ -1,7 +1,16 @@
-# Emma's Simple Form Field Checker
+# BearMetal PDF Tools
 
-Compares a PDF form to a list of CS class files to see if all field names are
+A collection of tools for working with PDF forms.
-present, excluding signature fields.
+
+## Features
+
+- Check Code Tool
+  - reads supplied code files to see if form fields are present and represented
+    in a switch statement
+- Field Rename Tool
+  - provide a search and replace pattern to bulk rename form fields
+- List Form Fields
+  - Sometimes you just need to see what fields there are
 
 ## Prereqs
 
@@ -20,17 +29,51 @@ Deno >=2.2 (not required if downloading .exe)
 > If you want it to be a global command, create an executables directory and add
 > it to the PATH
 
+### Precompiled
+
+Download the latest release from the
+[releases page](https://git.cyborggrizzly.com/BearMetal/pdf-tools/releases)
+
 ## Usage
 
-`checkfields <path to PDF> <comma-separated list of paths to CS class files>`
+`pdf-tools <tool> <args>` -> `<tool>` is one of the following
--OR- `checkfields` and follow prompts.
 
-### Output
+- check-code
+- field-rename
+- list-form-fields
 
-> All form fields present!
+## Contributing
 
--OR-
+Contributions are welcome!
 
-> The following field names are not present in the CS code
+## License
 
-> \<list of missing form fields\>
+GPL 3.0
+
+---
+
+### About this project
+
+BearMetal PDF Tools is a collection of tools made to fix the current state of
+PDF form editing. Adobe Acrobat is a great tool, but it's not always the easiest
+to use, nor is it free. It also lacks some features that I find useful, such as
+bulk renaming of form fields. There's also a lack of powerful, free, and open
+source tools for PDF editing.
+
+This project aims to fill that gap by providing a set of tools that can be used
+to edit PDF forms. The tools are written in Deno, a modern and secure runtime
+for JavaScript and TypeScript. They are designed to be easy to use and to
+provide a great user experience.
+
+The tools are designed to be used in a terminal, and are not designed to be
+integrated into other applications. They are also not designed to be used as a
+library, but rather as a command line tool.
+
+### About BearMetal
+
+BearMetal is a project that aims to decrapify modern web development. It is a
+collection of tools, libraries, and resources that aim to make web development
+more accessible and less intimidating. The project is open source and free to
+use, and is designed to be used by anyone, regardless of skill level or
+experience. You can find a list of libraries and tools on
+[JSR](https://jsr.io/@bearmetal).

cli/index.ts

@@ -5,6 +5,14 @@ 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";
+
+// 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();
@@ -13,30 +21,28 @@ export class PdfToolsCli {
 
   private args = ArgParser.parse(Deno.args).setFlagDefs({
     help: ["-h", "--help"],
+    banana: ["-b", "--banana"],
   });
 
-  async importTools(tools?: string) {
+  async importTools() {
-    tools = tools?.replace(/\/$/, "").replace(/^\.?\//, "") || "tools";
+    for (const [name, toolfile] of toolRegistry) {
-    for (const toolfile of Deno.readDirSync(tools)) {
+      const t = await toolfile;
-      if (toolfile.isFile) {
+      try {
-        const tool = await import(
+        if (t.default) {
-          Deno.cwd() + "/" + tools + "/" + toolfile.name
-        );
-        if (tool.default) {
           this.tools.set(
-            toCase(toolfile.name.replace(".ts", ""), "title"),
+            toCase(name, "title"),
-            tool.default,
+            t.default,
           );
         }
+      } catch (e) {
+        cliLog(e + "\n", this.terminalLayout.getBlock("body"));
       }
     }
   }
 
   private async banana() {
     const asciiArt = await getAsciiArt("banana");
-    const body = this.terminalLayout.getBlock("body");
+    this.closeMessage = colorize(asciiArt, "yellow");
-    body.clearAll();
-    cliLog(colorize(asciiArt, "yellow"), body);
   }
 
   private async help() {
@@ -50,28 +56,36 @@ 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("banana")) {
+        titleBlock.setFixedHeight(0);
+        await this.banana();
+        return;
+      }
       if (this.args.getFlag("help") && !this.args.task) {
         await this.help();
         return;
       } else if (this.args.nonFlags.length === 0 || !this.args.task) {
         this.embiggenHeader();
-        await this.importTools();
         await this.toolMenu();
       } else {
-        await this.importTools();
         const task = this.args.task;
         await this.runTool(toCase(task, "title"));
       }
     } finally {
+      this.cleanup();
+    }
+  }
+
+  private cleanup() {
     this.terminalLayout.clearAll();
     Deno.stdin.setRaw(false);
     if (this.closeMessage) console.log(this.closeMessage);
   }
-  }
 
   private async toolMenu() {
     const tools = this.tools.keys().toArray();

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.1",
+  "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/"
   },

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();

tools/checkCode.ts

@@ -2,6 +2,7 @@ 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";
 
 function getCaseSyntaxPatternByFileExtension(
@@ -33,7 +34,7 @@ class CheckCode implements ITool {
     [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);
 

tools/fieldRename.ts

@@ -6,6 +6,7 @@ import { forceArgs } from "../cli/forceArgs.ts";
 import { colorize } from "../cli/style.ts";
 import { cliAlert, cliLog, cliPrompt } from "../cli/prompts.ts";
 import { multiSelectMenuInteractive } from "../cli/selectMenu.ts";
+import type { callback, ITool } from "../types.ts";
 
 async function renameFields(
   path: string,
@@ -122,8 +123,9 @@ class RenameFields implements ITool {
       const match = patternRegex.exec(name);
       if (match) {
         const toChange = evaluateChange(change, match);
+        const preview = name.replace(new RegExp(patternRegex), toChange);
         foundUpdates.push([
-          `${colorize(name, "red")} -> ${colorize(toChange, "green")}`,
+          `${colorize(name, "red")} -> ${colorize(preview, "green")}`,
           () => {
             applyRename(field, name, patternRegex, toChange);
           },

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 {
+export type ToolFunc<T extends unknown[]> = (...args: T) => Promise<void>;
-  type ToolFunc<T extends unknown[]> = (...args: T) => Promise<void>;
+export interface ITool {
-  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/asciiArt.ts

@@ -26,5 +26,5 @@ function getBearmetalAsciiPath() {
       return filename.name;
     }
   }
-  return null;
+  return "https://git.cyborggrizzly.com/BearMetal/pdf-tools/raw/branch/main/asciiart.txt";
 }

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);