@hardlydifficult/text 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/text
 
-Text utilities for error formatting, template replacement, and chunking.
+Text utilities for error formatting, template replacement, chunking, and line numbering.
 
 ## Installation
 
@@ -99,3 +99,53 @@ formatDuration(3_600_000); // "1h"
 formatDuration(500);       // "<1s"
 formatDuration(90_000_000); // "1d 1h"
 ```
+
+### `convertFormat(content: string, to: TextFormat): string`
+
+Convert between JSON and YAML string formats. Auto-detects the input format and serializes to the requested output format.
+
+```typescript
+import { convertFormat } from "@hardlydifficult/text";
+
+// JSON to YAML
+convertFormat('{"name": "Alice", "age": 30}', "yaml");
+// name: Alice
+// age: 30
+
+// YAML to JSON
+convertFormat("name: Alice\nage: 30", "json");
+// {
+//   "name": "Alice",
+//   "age": 30
+// }
+```
+
+The function tries to parse as JSON first, then falls back to YAML. Returns pretty-printed JSON with 2-space indent or clean YAML. Throws a descriptive error if the input is neither valid JSON nor YAML.
+
+### `formatWithLineNumbers(content: string, startLine?: number): string`
+
+Format text content with right-aligned line numbers. Each line is prefixed with its line number, padded to align properly based on the maximum line number.
+
+```typescript
+import { formatWithLineNumbers } from "@hardlydifficult/text";
+
+// Default: starts at line 1
+formatWithLineNumbers("foo\nbar\nbaz");
+// 1: foo
+// 2: bar
+// 3: baz
+
+// Custom starting line for displaying file ranges
+formatWithLineNumbers("hello\nworld", 10);
+// 10: hello
+// 11: world
+
+// Proper alignment for larger line numbers
+formatWithLineNumbers("line 1\nline 2\n...\nline 100", 98);
+//  98: line 1
+//  99: line 2
+// 100: ...
+// 101: line 100
+```
+
+This is useful for displaying code snippets, file contents, or log output with line numbers for reference.

package/dist/convertFormat.d.ts

@@ -0,0 +1,25 @@
+export type TextFormat = "json" | "yaml";
+/**
+ * Convert between JSON and YAML string formats.
+ *
+ * Auto-detects the input format by trying JSON.parse first, then
+ * falling back to YAML parsing. Returns pretty-printed JSON (2-space indent)
+ * or clean YAML based on the `to` parameter.
+ *
+ * @example
+ * ```typescript
+ * // JSON to YAML
+ * convertFormat('{"name": "Alice", "age": 30}', "yaml")
+ * // name: Alice
+ * // age: 30
+ *
+ * // YAML to JSON
+ * convertFormat("name: Alice\nage: 30", "json")
+ * // {
+ * //   "name": "Alice",
+ * //   "age": 30
+ * // }
+ * ```
+ */
+export declare function convertFormat(content: string, to: TextFormat): string;
+//# sourceMappingURL=convertFormat.d.ts.map

package/dist/convertFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertFormat.d.ts","sourceRoot":"","sources":["../src/convertFormat.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAsBzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM,CAOrE"}

package/dist/convertFormat.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertFormat = convertFormat;
+const yaml_1 = require("yaml");
+/**
+ * Parse content as JSON or YAML, throwing a descriptive error if both fail.
+ */
+function parseContent(content) {
+    // Try JSON first
+    try {
+        return JSON.parse(content);
+    }
+    catch (jsonError) {
+        // Fall back to YAML
+        try {
+            return (0, yaml_1.parse)(content);
+        }
+        catch (yamlError) {
+            throw new Error(`Input is neither valid JSON nor YAML.\nJSON error: ${jsonError instanceof Error ? jsonError.message : String(jsonError)}\nYAML error: ${yamlError instanceof Error ? yamlError.message : String(yamlError)}`, { cause: yamlError });
+        }
+    }
+}
+/**
+ * Convert between JSON and YAML string formats.
+ *
+ * Auto-detects the input format by trying JSON.parse first, then
+ * falling back to YAML parsing. Returns pretty-printed JSON (2-space indent)
+ * or clean YAML based on the `to` parameter.
+ *
+ * @example
+ * ```typescript
+ * // JSON to YAML
+ * convertFormat('{"name": "Alice", "age": 30}', "yaml")
+ * // name: Alice
+ * // age: 30
+ *
+ * // YAML to JSON
+ * convertFormat("name: Alice\nage: 30", "json")
+ * // {
+ * //   "name": "Alice",
+ * //   "age": 30
+ * // }
+ * ```
+ */
+function convertFormat(content, to) {
+    const data = parseContent(content);
+    if (to === "json") {
+        return JSON.stringify(data, null, 2);
+    }
+    return (0, yaml_1.stringify)(data);
+}
+//# sourceMappingURL=convertFormat.js.map

package/dist/convertFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertFormat.js","sourceRoot":"","sources":["../src/convertFormat.ts"],"names":[],"mappings":";;AA8CA,sCAOC;AArDD,+BAAsE;AAItE;;GAEG;AACH,SAAS,YAAY,CAAC,OAAe;IACnC,iBAAiB;IACjB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,oBAAoB;QACpB,IAAI,CAAC;YACH,OAAO,IAAA,YAAS,EAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,sDAAsD,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,iBAAiB,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,EAC7M,EAAE,KAAK,EAAE,SAAS,EAAE,CACrB,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,aAAa,CAAC,OAAe,EAAE,EAAc;IAC3D,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,IAAA,gBAAa,EAAC,IAAI,CAAC,CAAC;AAC7B,CAAC"}

package/dist/formatWithLineNumbers.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Format text content with right-aligned line numbers.
+ *
+ * @param content - The text content to format
+ * @param startLine - The starting line number (default: 1)
+ * @returns The formatted text with line numbers
+ *
+ * @example
+ * ```typescript
+ * formatWithLineNumbers("foo\nbar\nbaz")
+ * // Returns:
+ * // "1: foo\n2: bar\n3: baz"
+ *
+ * formatWithLineNumbers("hello\nworld", 10)
+ * // Returns:
+ * // "10: hello\n11: world"
+ * ```
+ */
+export declare function formatWithLineNumbers(content: string, startLine?: number): string;
+//# sourceMappingURL=formatWithLineNumbers.d.ts.map

package/dist/formatWithLineNumbers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatWithLineNumbers.d.ts","sourceRoot":"","sources":["../src/formatWithLineNumbers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,SAAI,GAAG,MAAM,CAO5E"}

package/dist/formatWithLineNumbers.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatWithLineNumbers = formatWithLineNumbers;
+/**
+ * Format text content with right-aligned line numbers.
+ *
+ * @param content - The text content to format
+ * @param startLine - The starting line number (default: 1)
+ * @returns The formatted text with line numbers
+ *
+ * @example
+ * ```typescript
+ * formatWithLineNumbers("foo\nbar\nbaz")
+ * // Returns:
+ * // "1: foo\n2: bar\n3: baz"
+ *
+ * formatWithLineNumbers("hello\nworld", 10)
+ * // Returns:
+ * // "10: hello\n11: world"
+ * ```
+ */
+function formatWithLineNumbers(content, startLine = 1) {
+    const lines = content.split("\n");
+    const maxNum = startLine + lines.length - 1;
+    const width = String(maxNum).length;
+    return lines
+        .map((line, i) => `${String(startLine + i).padStart(width)}: ${line}`)
+        .join("\n");
+}
+//# sourceMappingURL=formatWithLineNumbers.js.map

package/dist/formatWithLineNumbers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatWithLineNumbers.js","sourceRoot":"","sources":["../src/formatWithLineNumbers.ts"],"names":[],"mappings":";;AAkBA,sDAOC;AAzBD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qBAAqB,CAAC,OAAe,EAAE,SAAS,GAAG,CAAC;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;IACpC,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;SACrE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/index.d.ts

@@ -5,4 +5,7 @@ export { slugify } from "./slugify.js";
 export { formatDuration } from "./formatDuration.js";
 export { buildFileTree, FILE_TREE_DEFAULTS } from "./buildFileTree.js";
 export type { BuildTreeOptions } from "./buildFileTree.js";
+export { convertFormat } from "./convertFormat.js";
+export type { TextFormat } from "./convertFormat.js";
+export { formatWithLineNumbers } from "./formatWithLineNumbers.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACvE,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACvE,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FILE_TREE_DEFAULTS = exports.buildFileTree = exports.formatDuration = exports.slugify = exports.chunkText = exports.extractPlaceholders = exports.replaceTemplate = exports.formatErrorForLog = exports.formatError = exports.getErrorMessage = void 0;
+exports.formatWithLineNumbers = exports.convertFormat = exports.FILE_TREE_DEFAULTS = exports.buildFileTree = exports.formatDuration = exports.slugify = exports.chunkText = exports.extractPlaceholders = exports.replaceTemplate = exports.formatErrorForLog = exports.formatError = exports.getErrorMessage = void 0;
 var errors_js_1 = require("./errors.js");
 Object.defineProperty(exports, "getErrorMessage", { enumerable: true, get: function () { return errors_js_1.getErrorMessage; } });
 Object.defineProperty(exports, "formatError", { enumerable: true, get: function () { return errors_js_1.formatError; } });
@@ -17,4 +17,8 @@ Object.defineProperty(exports, "formatDuration", { enumerable: true, get: functi
 var buildFileTree_js_1 = require("./buildFileTree.js");
 Object.defineProperty(exports, "buildFileTree", { enumerable: true, get: function () { return buildFileTree_js_1.buildFileTree; } });
 Object.defineProperty(exports, "FILE_TREE_DEFAULTS", { enumerable: true, get: function () { return buildFileTree_js_1.FILE_TREE_DEFAULTS; } });
+var convertFormat_js_1 = require("./convertFormat.js");
+Object.defineProperty(exports, "convertFormat", { enumerable: true, get: function () { return convertFormat_js_1.convertFormat; } });
+var formatWithLineNumbers_js_1 = require("./formatWithLineNumbers.js");
+Object.defineProperty(exports, "formatWithLineNumbers", { enumerable: true, get: function () { return formatWithLineNumbers_js_1.formatWithLineNumbers; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA8E;AAArE,4GAAA,eAAe,OAAA;AAAE,wGAAA,WAAW,OAAA;AAAE,8GAAA,iBAAiB,OAAA;AACxD,6CAAqE;AAA5D,8GAAA,eAAe,OAAA;AAAE,kHAAA,mBAAmB,OAAA;AAC7C,+CAA2C;AAAlC,yGAAA,SAAS,OAAA;AAClB,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAChB,yDAAqD;AAA5C,mHAAA,cAAc,OAAA;AACvB,uDAAuE;AAA9D,iHAAA,aAAa,OAAA;AAAE,sHAAA,kBAAkB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA8E;AAArE,4GAAA,eAAe,OAAA;AAAE,wGAAA,WAAW,OAAA;AAAE,8GAAA,iBAAiB,OAAA;AACxD,6CAAqE;AAA5D,8GAAA,eAAe,OAAA;AAAE,kHAAA,mBAAmB,OAAA;AAC7C,+CAA2C;AAAlC,yGAAA,SAAS,OAAA;AAClB,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAChB,yDAAqD;AAA5C,mHAAA,cAAc,OAAA;AACvB,uDAAuE;AAA9D,iHAAA,aAAa,OAAA;AAAE,sHAAA,kBAAkB,OAAA;AAE1C,uDAAmD;AAA1C,iHAAA,aAAa,OAAA;AAEtB,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hardlydifficult/text",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -14,6 +14,9 @@
     "lint": "tsc --noEmit",
     "clean": "rm -rf dist"
   },
+  "dependencies": {
+    "yaml": "2.8.2"
+  },
   "devDependencies": {
     "@types/node": "25.2.3",
     "typescript": "5.9.3",