@heroiclands/package-build 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @heroiclands/package-build
 
+## 0.5.0
+
+### Minor Changes
+
+- 905254d: **`text.mjs` is deleted; the one implementation lives with the diagnostics
+  contract it serves.**
+  
+  `locateInText` and `positionOf` computed which line and column a substring sits
+  on. `@heroiclands/content-build` computes the same thing in
+  `engine/diagnostics.mjs` as `positionOfLiteral`, and has said so in a comment
+  for some time:
+  
+  > That is a duplicate worth naming: unlike the diagnostic _format_ or a
+  > validation _rule_, "which line and column is this substring on" has exactly
+  > one correct answer and cannot drift into disagreement. The tidier arrangement
+  > is for that package to re-export this one — the dependency runs that way — and
+  > it should, next time either is touched.
+  
+  This is that time. Rather than re-export, the module is removed outright: the
+  `./text` subpath was a library surface with one internal caller (`lang.mjs`) and
+  one external one, and this package's job is a command line, not a text-utility
+  grab bag.
+  
+  **Breaking for anyone importing `@heroiclands/package-build/text`.** Import
+  `positionOfLiteral` from `@heroiclands/content-build/engine/diagnostics`
+  instead; it is the same arithmetic, and returns `{}` rather than `undefined`
+  when the literal is absent — the shape the diagnostics contract already spreads.
+  `locateInText` had no callers anywhere and is simply gone.
+
 ## 0.4.0
 
 ### Minor Changes

package/index.mjs

@@ -56,6 +56,3 @@ export * as deploy from "./deploy.mjs";
 
 /** Localization files: what a shippable `lang/*.json` must satisfy. */
 export * as lang from "./lang.mjs";
-
-/** Locating a literal inside an arbitrary text file, for positioned findings. */
-export * as text from "./text.mjs";

package/lang.mjs

@@ -45,7 +45,7 @@
  * @module
  */
 
-import { positionOf } from "./text.mjs";
+import { positionOfLiteral } from "@heroiclands/content-build/engine/diagnostics";
 
 /**
  * A single finding, in the fields the shared diagnostic format takes.
@@ -140,7 +140,7 @@ export function validateLangSource(raw) {
      * @param {string} key - The localization key.
      * @returns {{line?: number, column?: number}} Spreadable position fields.
      */
-    const at = (key) => positionOf(raw, `"${key}"`);
+    const at = (key) => positionOfLiteral(raw, `"${key}"`);
 
     for (const [key, value] of Object.entries(json)) {
         if (typeof value !== "string") continue;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heroiclands/package-build",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "description": "Shared toolchain for building and shipping a HeroicLands Foundry VTT package \u2014 manifest, localization, staging, bundle, release and deployment.",
     "license": "GPL-3.0-or-later",
     "type": "module",
@@ -35,10 +35,6 @@
             "types": "./types/stage.d.mts",
             "import": "./stage.mjs"
         },
-        "./text": {
-            "types": "./types/text.d.mts",
-            "import": "./text.mjs"
-        },
         "./package.json": "./package.json",
         "./config": {
             "types": "./types/config.d.mts",
@@ -53,7 +49,6 @@
         "manifest.mjs",
         "release.mjs",
         "stage.mjs",
-        "text.mjs",
         "types",
         "CHANGELOG.md",
         "README.md",

package/types/index.d.mts

@@ -4,4 +4,3 @@ export * as stage from "./stage.mjs";
 export * as release from "./release.mjs";
 export * as deploy from "./deploy.mjs";
 export * as lang from "./lang.mjs";
-export * as text from "./text.mjs";

package/text.mjs

@@ -1,74 +0,0 @@
-/*
- * This file is part of the Song of Heroic Lands (SoHL) system for Foundry VTT.
- * Copyright (c) 2024-2026 Tom Rodriguez ("Toasty") — <toasty@heroiclands.org>
- *
- * This work is licensed under the GNU General Public License v3.0 (GPLv3).
- * You may copy, modify, and distribute it under the terms of that license.
- *
- * For full terms, see the LICENSE.md file in the project root or visit:
- * https://www.gnu.org/licenses/gpl-3.0.html
- *
- * SPDX-License-Identifier: GPL-3.0-or-later
- */
-
-/**
- * Locating a literal inside an arbitrary text file.
- *
- * A build check reports a **finding**, and a finding is only actionable if it
- * says where it is (#1668). Most findings are *about* a string the check
- * matched — a key, a marker, a caption — so its position is one string search
- * away, and making that search is the difference between a finding that can be
- * opened and one that has to be hunted for.
- *
- * `@heroiclands/content-build` owns the diagnostic **format**, and its
- * `positionInBody` maps an offset within a parsed content note back to its
- * file. That is a different job: the checks here read localization files,
- * manifests, source and bundles — none of which are notes. So this module
- * carries the generic operation, and nothing carries it twice.
- *
- * Plain ESM with no filesystem access, so it is unit-testable.
- *
- * @module
- */
-
-/**
- * Where a literal sits in a text.
- *
- * @param {string} text - The file's contents.
- * @param {string} needle - The literal to locate.
- * @param {number} [occurrence] - Which occurrence, 1-based. Repeats of the same
- *   literal are otherwise indistinguishable, which is the symptom the
- *   diagnostic format exists to remove.
- * @returns {{line: number, column: number}|undefined} 1-based position, or
- *   `undefined` when the literal is not there. A caller that gets `undefined`
- *   reports the file alone rather than a position that is not the problem.
- */
-export function locateInText(text, needle, occurrence = 1) {
-    if (typeof text !== "string" || !needle) return undefined;
-    let at = -1;
-    for (let n = 0; n < occurrence; n++) {
-        at = text.indexOf(needle, at + 1);
-        if (at === -1) return undefined;
-    }
-    const before = text.slice(0, at);
-    return {
-        line: before.split("\n").length,
-        column: at - before.lastIndexOf("\n"),
-    };
-}
-
-/**
- * Where a literal sits, as spreadable diagnostic fields.
- *
- * Keeps the drop-rather-than-guess rule in one place: an unfound literal
- * contributes no position at all, rather than `undefined` fields that read as a
- * bug or a `1:1` that sends the reader to the top of the file.
- *
- * @param {string} text - The file's contents.
- * @param {string} needle - The literal to locate.
- * @param {number} [occurrence] - Which occurrence, 1-based.
- * @returns {{line?: number, column?: number}} Spreadable position fields.
- */
-export function positionOf(text, needle, occurrence = 1) {
-    return locateInText(text, needle, occurrence) ?? {};
-}

package/types/text.d.mts

@@ -1,51 +0,0 @@
-/**
- * Locating a literal inside an arbitrary text file.
- *
- * A build check reports a **finding**, and a finding is only actionable if it
- * says where it is (#1668). Most findings are *about* a string the check
- * matched — a key, a marker, a caption — so its position is one string search
- * away, and making that search is the difference between a finding that can be
- * opened and one that has to be hunted for.
- *
- * `@heroiclands/content-build` owns the diagnostic **format**, and its
- * `positionInBody` maps an offset within a parsed content note back to its
- * file. That is a different job: the checks here read localization files,
- * manifests, source and bundles — none of which are notes. So this module
- * carries the generic operation, and nothing carries it twice.
- *
- * Plain ESM with no filesystem access, so it is unit-testable.
- *
- * @module
- */
-/**
- * Where a literal sits in a text.
- *
- * @param {string} text - The file's contents.
- * @param {string} needle - The literal to locate.
- * @param {number} [occurrence] - Which occurrence, 1-based. Repeats of the same
- *   literal are otherwise indistinguishable, which is the symptom the
- *   diagnostic format exists to remove.
- * @returns {{line: number, column: number}|undefined} 1-based position, or
- *   `undefined` when the literal is not there. A caller that gets `undefined`
- *   reports the file alone rather than a position that is not the problem.
- */
-export function locateInText(text: string, needle: string, occurrence?: number): {
-    line: number;
-    column: number;
-} | undefined;
-/**
- * Where a literal sits, as spreadable diagnostic fields.
- *
- * Keeps the drop-rather-than-guess rule in one place: an unfound literal
- * contributes no position at all, rather than `undefined` fields that read as a
- * bug or a `1:1` that sends the reader to the top of the file.
- *
- * @param {string} text - The file's contents.
- * @param {string} needle - The literal to locate.
- * @param {number} [occurrence] - Which occurrence, 1-based.
- * @returns {{line?: number, column?: number}} Spreadable position fields.
- */
-export function positionOf(text: string, needle: string, occurrence?: number): {
-    line?: number;
-    column?: number;
-};