@node-cli/comments 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Arno Versini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# @node-cli/comments
+
+CLI tool to reflow, normalize, and optionally merge JavaScript / TypeScript comment blocks (JSDoc and `//` single-line comments).
+
+## Features (Planned)
+
+- Reflow JSDoc blocks to a max line width
+- Optional wrapping of single-line `//` comments
+- Optional merging of consecutive `//` lines into a JSDoc block
+- Dry run mode with diff output
+- Width / punctuation heuristics and NOTE normalization
+
+## Usage
+
+```
+comments [options] <files...>
+```
+
+Examples:
+
+```
+comments src/**/*.ts
+comments --dry-run src/index.ts
+comments --width 100 --merge-line-comments 'src/**/*.ts'
+comments --no-line-wrap src/file.ts
+```
+
+## Flags
+
+| Flag                    | Description                                   |
+| ----------------------- | --------------------------------------------- |
+| `--width <n>`           | Max output line width (default 80)            |
+| `--dry-run`             | Show diff only; exit 1 if changes would occur |
+| `--stdout`              | Print transformed content of a single file    |
+| `--no-line-wrap`        | Disable wrapping of `//` comments             |
+| `--merge-line-comments` | Merge groups of `//` into JSDoc blocks        |
+| `-h, --help`            | Show help                                     |
+| `-v, --version`         | Show version                                  |
+
+## Exit Codes
+
+- `0` success or dry run with no changes
+- `1` dry run with changes or usage error
+
+## Roadmap
+
+See project PRD `reflow-jsdoc-PRD.md` for full specification.

package/dist/__tests__/glob.test.js

@@ -0,0 +1,135 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { describe, expect, it } from "vitest";
+import { augmentPatterns, expandGlobs } from "../glob.js";
+import { parseAndTransformComments } from "../lib.js";
+describe("glob utilities & additional lib branches", function() {
+    it("augmentPatterns adds deep variant only when needed", function() {
+        var input = [
+            "/tmp/dir/*.ts",
+            "/tmp/dir/**/a.ts",
+            "/tmp/file.txt"
+        ]; // second already deep, third no wildcard folder/file split
+        var out = augmentPatterns(input);
+        // Should add one deep variant for first pattern
+        var additions = out.filter(function(p) {
+            return p.includes("**/*.ts");
+        });
+        expect(additions.length).toBe(1);
+    });
+    it("expandGlobs matches literals and wildcards including ?", function() {
+        var root = fs.mkdtempSync(path.join(os.tmpdir(), "comments-glob2-"));
+        var files = [
+            "a.ts",
+            "ab.ts",
+            "abc.ts",
+            "note.md"
+        ]; // to test ? wildcard and *
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            for(var _iterator = files[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                var f = _step.value;
+                fs.writeFileSync(path.join(root, f), "// x", "utf8");
+            }
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+        var patterns = [
+            path.join(root, "a?.ts"),
+            path.join(root, "a*.ts"),
+            path.join(root, "note.md")
+        ];
+        var expanded = expandGlobs(patterns).map(function(p) {
+            return path.basename(p);
+        }).sort();
+        expect(expanded).toEqual([
+            "a.ts",
+            "ab.ts",
+            "abc.ts",
+            "note.md"
+        ].sort());
+    });
+    it("expandGlobs handles symlinks when followSymlinks true", function() {
+        var root = fs.mkdtempSync(path.join(os.tmpdir(), "comments-glob-sym-"));
+        var target = path.join(root, "target.ts");
+        fs.writeFileSync(target, "// target", "utf8");
+        var link = path.join(root, "link.ts");
+        try {
+            fs.symlinkSync(target, link);
+        } catch (e) {
+            // Some file systems may not allow symlinks (CI on Windows); skip gracefully.
+            return;
+        }
+        var pattern = path.join(root, "*.ts");
+        var noFollow = expandGlobs([
+            pattern
+        ], {
+            followSymlinks: false
+        });
+        expect(noFollow).toContain(target);
+        expect(noFollow).not.toContain(link);
+        var withFollow = expandGlobs([
+            pattern
+        ], {
+            followSymlinks: true
+        });
+        expect(withFollow).toContain(target);
+        expect(withFollow).toContain(link);
+    });
+    it("expandGlobs handles file literals, duplicate patterns and nonexistent paths", function() {
+        var root = fs.mkdtempSync(path.join(os.tmpdir(), "comments-glob-lit-"));
+        var file = path.join(root, "only.ts");
+        fs.writeFileSync(file, "// only", "utf8");
+        // duplicate patterns plus a nonexistent literal
+        var patterns = [
+            file,
+            file,
+            path.join(root, "missing.ts")
+        ];
+        var out = expandGlobs(patterns);
+        expect(out).toEqual([
+            file
+        ]); // only once
+    });
+    it("lib buildJsDoc preserves blank line separation and fences (edge branch)", function() {
+        var input = [
+            "/**",
+            " * First paragraph line",
+            " *",
+            " * ```sh",
+            " * echo hi",
+            " * ```",
+            " *",
+            " * Second paragraph without period",
+            " */"
+        ].join("\n");
+        var out = parseAndTransformComments(input, {
+            width: 60,
+            wrapLineComments: true,
+            mergeLineComments: false
+        }).transformed;
+        // At least one blank line (line with only '*') preserved around fence
+        var starBlankCount = out.split(/\n/).filter(function(l) {
+            return /^\s*\*\s*$/.test(l);
+        }).length;
+        expect(starBlankCount).toBeGreaterThanOrEqual(1);
+        // Fenced code block retained
+        expect(out).toContain("```sh");
+        // Second paragraph ended with period added
+        expect(/Second paragraph without period\./.test(out)).toBe(true);
+    });
+});
+
+//# sourceMappingURL=glob.test.js.map

package/dist/__tests__/glob.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/__tests__/glob.test.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\nimport { describe, expect, it } from \"vitest\";\nimport { augmentPatterns, expandGlobs } from \"../glob.js\";\nimport { parseAndTransformComments } from \"../lib.js\";\n\ndescribe(\"glob utilities & additional lib branches\", () => {\n\tit(\"augmentPatterns adds deep variant only when needed\", () => {\n\t\tconst input = [\"/tmp/dir/*.ts\", \"/tmp/dir/**/a.ts\", \"/tmp/file.txt\"]; // second already deep, third no wildcard folder/file split\n\t\tconst out = augmentPatterns(input);\n\t\t// Should add one deep variant for first pattern\n\t\tconst additions = out.filter((p) => p.includes(\"**/*.ts\"));\n\t\texpect(additions.length).toBe(1);\n\t});\n\n\tit(\"expandGlobs matches literals and wildcards including ?\", () => {\n\t\tconst root = fs.mkdtempSync(path.join(os.tmpdir(), \"comments-glob2-\"));\n\t\tconst files = [\"a.ts\", \"ab.ts\", \"abc.ts\", \"note.md\"]; // to test ? wildcard and *\n\t\tfor (const f of files) {\n\t\t\tfs.writeFileSync(path.join(root, f), \"// x\", \"utf8\");\n\t\t}\n\t\tconst patterns = [\n\t\t\tpath.join(root, \"a?.ts\"), // should match ab.ts only\n\t\t\tpath.join(root, \"a*.ts\"), // matches a.ts, ab.ts, abc.ts\n\t\t\tpath.join(root, \"note.md\"), // literal\n\t\t];\n\t\tconst expanded = expandGlobs(patterns)\n\t\t\t.map((p) => path.basename(p))\n\t\t\t.sort();\n\t\texpect(expanded).toEqual([\"a.ts\", \"ab.ts\", \"abc.ts\", \"note.md\"].sort());\n\t});\n\n\tit(\"expandGlobs handles symlinks when followSymlinks true\", () => {\n\t\tconst root = fs.mkdtempSync(path.join(os.tmpdir(), \"comments-glob-sym-\"));\n\t\tconst target = path.join(root, \"target.ts\");\n\t\tfs.writeFileSync(target, \"// target\", \"utf8\");\n\t\tconst link = path.join(root, \"link.ts\");\n\t\ttry {\n\t\t\tfs.symlinkSync(target, link);\n\t\t} catch {\n\t\t\t// Some file systems may not allow symlinks (CI on Windows); skip gracefully.\n\t\t\treturn;\n\t\t}\n\t\tconst pattern = path.join(root, \"*.ts\");\n\t\tconst noFollow = expandGlobs([pattern], { followSymlinks: false });\n\t\texpect(noFollow).toContain(target);\n\t\texpect(noFollow).not.toContain(link);\n\t\tconst withFollow = expandGlobs([pattern], { followSymlinks: true });\n\t\texpect(withFollow).toContain(target);\n\t\texpect(withFollow).toContain(link);\n\t});\n\n\tit(\"expandGlobs handles file literals, duplicate patterns and nonexistent paths\", () => {\n\t\tconst root = fs.mkdtempSync(path.join(os.tmpdir(), \"comments-glob-lit-\"));\n\t\tconst file = path.join(root, \"only.ts\");\n\t\tfs.writeFileSync(file, \"// only\", \"utf8\");\n\t\t// duplicate patterns plus a nonexistent literal\n\t\tconst patterns = [file, file, path.join(root, \"missing.ts\")];\n\t\tconst out = expandGlobs(patterns);\n\t\texpect(out).toEqual([file]); // only once\n\t});\n\n\tit(\"lib buildJsDoc preserves blank line separation and fences (edge branch)\", () => {\n\t\tconst input = [\n\t\t\t\"/**\",\n\t\t\t\" * First paragraph line\",\n\t\t\t\" *\",\n\t\t\t\" * ```sh\",\n\t\t\t\" * echo hi\",\n\t\t\t\" * ```\",\n\t\t\t\" *\",\n\t\t\t\" * Second paragraph without period\",\n\t\t\t\" */\",\n\t\t].join(\"\\n\");\n\t\tconst out = parseAndTransformComments(input, {\n\t\t\twidth: 60,\n\t\t\twrapLineComments: true,\n\t\t\tmergeLineComments: false,\n\t\t}).transformed;\n\t\t// At least one blank line (line with only '*') preserved around fence\n\t\tconst starBlankCount = out\n\t\t\t.split(/\\n/)\n\t\t\t.filter((l) => /^\\s*\\*\\s*$/.test(l)).length;\n\t\texpect(starBlankCount).toBeGreaterThanOrEqual(1);\n\t\t// Fenced code block retained\n\t\texpect(out).toContain(\"```sh\");\n\t\t// Second paragraph ended with period added\n\t\texpect(/Second paragraph without period\\./.test(out)).toBe(true);\n\t});\n});\n"],"names":["fs","os","path","describe","expect","it","augmentPatterns","expandGlobs","parseAndTransformComments","input","out","additions","filter","p","includes","length","toBe","root","mkdtempSync","join","tmpdir","files","f","writeFileSync","patterns","expanded","map","basename","sort","toEqual","target","link","symlinkSync","pattern","noFollow","followSymlinks","toContain","not","withFollow","file","width","wrapLineComments","mergeLineComments","transformed","starBlankCount","split","l","test","toBeGreaterThanOrEqual"],"mappings":"AAAA,OAAOA,QAAQ,UAAU;AACzB,OAAOC,QAAQ,UAAU;AACzB,OAAOC,UAAU,YAAY;AAC7B,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAS;AAC9C,SAASC,eAAe,EAAEC,WAAW,QAAQ,aAAa;AAC1D,SAASC,yBAAyB,QAAQ,YAAY;AAEtDL,SAAS,4CAA4C;IACpDE,GAAG,sDAAsD;QACxD,IAAMI,QAAQ;YAAC;YAAiB;YAAoB;SAAgB,EAAE,2DAA2D;QACjI,IAAMC,MAAMJ,gBAAgBG;QAC5B,gDAAgD;QAChD,IAAME,YAAYD,IAAIE,MAAM,CAAC,SAACC;mBAAMA,EAAEC,QAAQ,CAAC;;QAC/CV,OAAOO,UAAUI,MAAM,EAAEC,IAAI,CAAC;IAC/B;IAEAX,GAAG,0DAA0D;QAC5D,IAAMY,OAAOjB,GAAGkB,WAAW,CAAChB,KAAKiB,IAAI,CAAClB,GAAGmB,MAAM,IAAI;QACnD,IAAMC,QAAQ;YAAC;YAAQ;YAAS;YAAU;SAAU,EAAE,2BAA2B;YAC5E,kCAAA,2BAAA;;YAAL,QAAK,YAAWA,0BAAX,SAAA,6BAAA,QAAA,yBAAA,iCAAkB;gBAAlB,IAAMC,IAAN;gBACJtB,GAAGuB,aAAa,CAACrB,KAAKiB,IAAI,CAACF,MAAMK,IAAI,QAAQ;YAC9C;;YAFK;YAAA;;;qBAAA,6BAAA;oBAAA;;;oBAAA;0BAAA;;;;QAGL,IAAME,WAAW;YAChBtB,KAAKiB,IAAI,CAACF,MAAM;YAChBf,KAAKiB,IAAI,CAACF,MAAM;YAChBf,KAAKiB,IAAI,CAACF,MAAM;SAChB;QACD,IAAMQ,WAAWlB,YAAYiB,UAC3BE,GAAG,CAAC,SAACb;mBAAMX,KAAKyB,QAAQ,CAACd;WACzBe,IAAI;QACNxB,OAAOqB,UAAUI,OAAO,CAAC;YAAC;YAAQ;YAAS;YAAU;SAAU,CAACD,IAAI;IACrE;IAEAvB,GAAG,yDAAyD;QAC3D,IAAMY,OAAOjB,GAAGkB,WAAW,CAAChB,KAAKiB,IAAI,CAAClB,GAAGmB,MAAM,IAAI;QACnD,IAAMU,SAAS5B,KAAKiB,IAAI,CAACF,MAAM;QAC/BjB,GAAGuB,aAAa,CAACO,QAAQ,aAAa;QACtC,IAAMC,OAAO7B,KAAKiB,IAAI,CAACF,MAAM;QAC7B,IAAI;YACHjB,GAAGgC,WAAW,CAACF,QAAQC;QACxB,EAAE,UAAM;YACP,6EAA6E;YAC7E;QACD;QACA,IAAME,UAAU/B,KAAKiB,IAAI,CAACF,MAAM;QAChC,IAAMiB,WAAW3B,YAAY;YAAC0B;SAAQ,EAAE;YAAEE,gBAAgB;QAAM;QAChE/B,OAAO8B,UAAUE,SAAS,CAACN;QAC3B1B,OAAO8B,UAAUG,GAAG,CAACD,SAAS,CAACL;QAC/B,IAAMO,aAAa/B,YAAY;YAAC0B;SAAQ,EAAE;YAAEE,gBAAgB;QAAK;QACjE/B,OAAOkC,YAAYF,SAAS,CAACN;QAC7B1B,OAAOkC,YAAYF,SAAS,CAACL;IAC9B;IAEA1B,GAAG,+EAA+E;QACjF,IAAMY,OAAOjB,GAAGkB,WAAW,CAAChB,KAAKiB,IAAI,CAAClB,GAAGmB,MAAM,IAAI;QACnD,IAAMmB,OAAOrC,KAAKiB,IAAI,CAACF,MAAM;QAC7BjB,GAAGuB,aAAa,CAACgB,MAAM,WAAW;QAClC,gDAAgD;QAChD,IAAMf,WAAW;YAACe;YAAMA;YAAMrC,KAAKiB,IAAI,CAACF,MAAM;SAAc;QAC5D,IAAMP,MAAMH,YAAYiB;QACxBpB,OAAOM,KAAKmB,OAAO,CAAC;YAACU;SAAK,GAAG,YAAY;IAC1C;IAEAlC,GAAG,2EAA2E;QAC7E,IAAMI,QAAQ;YACb;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACA,CAACU,IAAI,CAAC;QACP,IAAMT,MAAMF,0BAA0BC,OAAO;YAC5C+B,OAAO;YACPC,kBAAkB;YAClBC,mBAAmB;QACpB,GAAGC,WAAW;QACd,sEAAsE;QACtE,IAAMC,iBAAiBlC,IACrBmC,KAAK,CAAC,MACNjC,MAAM,CAAC,SAACkC;mBAAM,aAAaC,IAAI,CAACD;WAAI/B,MAAM;QAC5CX,OAAOwC,gBAAgBI,sBAAsB,CAAC;QAC9C,6BAA6B;QAC7B5C,OAAOM,KAAK0B,SAAS,CAAC;QACtB,2CAA2C;QAC3ChC,OAAO,oCAAoC2C,IAAI,CAACrC,MAAMM,IAAI,CAAC;IAC5D;AACD"}

package/dist/__tests__/lib.test.js

@@ -0,0 +1,247 @@
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import { describe, expect, it } from "vitest";
+import { augmentPatterns, expandGlobs } from "../glob.js";
+import { diffLines, parseAndTransformComments } from "../lib.js";
+var baseOpts = {
+    width: 60,
+    wrapLineComments: true,
+    mergeLineComments: false
+};
+describe("parseAndTransformComments", function() {
+    it("reflows a simple jsdoc and adds period", function() {
+        var input = "/**\n * This function does something\n * important\n */";
+        var res = parseAndTransformComments(input, baseOpts);
+        expect(res.transformed).toContain("does something important.");
+    });
+    it("normalizes NOTE capitalization", function() {
+        var input = "/**\n * note: edge case\n */";
+        var res = parseAndTransformComments(input, baseOpts);
+        expect(/NOTE: edge case/.test(res.transformed)).toBe(true);
+    });
+    it("wraps single line comments", function() {
+        var input = "// this is a very long comment that should be wrapped across multiple lines to satisfy width";
+        var res = parseAndTransformComments(input, baseOpts);
+        expect(res.transformed.split(/\n/).length).toBeGreaterThan(1);
+    });
+    it("merges groups of line comments into jsdoc", function() {
+        var input = [
+            "// first line",
+            "// second line",
+            "// third line",
+            "const x = 1;"
+        ].join("\n");
+        var res = parseAndTransformComments(input, _object_spread_props(_object_spread({}, baseOpts), {
+            mergeLineComments: true
+        }));
+        expect(/\/\*\*/.test(res.transformed)).toBe(true);
+    });
+    it("is idempotent (second pass unchanged)", function() {
+        var input = "/**\n * Example doc that will be normalized\n */";
+        var first = parseAndTransformComments(input, baseOpts).transformed;
+        var second = parseAndTransformComments(first, baseOpts).transformed;
+        expect(diffLines(first, second)).toBe("");
+    });
+    it("preserves code fence blocks", function() {
+        var input = "/**\n * Before\n * ```js\n * const  x=  1;   \n * ```\n * After\n */";
+        var res = parseAndTransformComments(input, baseOpts).transformed;
+        expect(/```js/.test(res)).toBe(true);
+        // ensure spacing inside fence not normalized
+        expect(/const {2}x= {2}1;/.test(res)).toBe(true);
+    });
+    it("does not merge directive or license groups", function() {
+        var input = [
+            "// eslint-disable-next-line",
+            "// second line should prevent merge due to directive",
+            "const y = 2;",
+            "// Copyright 2024 Example",
+            "// another line"
+        ].join("\n");
+        var res = parseAndTransformComments(input, _object_spread_props(_object_spread({}, baseOpts), {
+            mergeLineComments: true
+        }));
+        expect(/eslint-disable/.test(res.transformed)).toBe(true);
+        // Should not have merged into a jsdoc (no /** directly before const)
+        expect(/\/\*\*/.test(res.transformed)).toBe(false);
+    });
+    it("list items are not reflowed into a paragraph", function() {
+        var input = "/**\n * First line explaining.\n * - item one more words here\n * - item two\n */";
+        var res = parseAndTransformComments(input, baseOpts).transformed;
+        // each list item remains on its own line with leading dash
+        var lines = res.split(/\n/).filter(function(l) {
+            return /- item/.test(l);
+        });
+        expect(lines.length).toBe(2);
+    });
+    it("tag lines are preserved", function() {
+        var input = "/**\n * short description\n * @param x value\n * @returns something\n */";
+        var res = parseAndTransformComments(input, baseOpts).transformed;
+        expect(/@param x value/.test(res)).toBe(true);
+        expect(/@returns something/.test(res)).toBe(true);
+    });
+    it("handles heading-like lines with colon and visually indented code & numeric lists", function() {
+        var input = [
+            "/**",
+            " * Overview:",
+            " *   const   x = 1;",
+            " * 1. first",
+            " * 2. second",
+            " *",
+            " * Another paragraph without period",
+            " */"
+        ].join("\n");
+        var out = parseAndTransformComments(input, baseOpts).transformed;
+        // Heading preserved, not merged into previous paragraph
+        expect(out).toMatch(/Overview:/);
+        // Visually indented code line kept as-is (no extra wrapping collapse)
+        expect(out).toMatch(/const\s{3}x = 1;/);
+        // Ensure final blank line before closing preserved (one line ending with ' *')
+        var trailingBlank = /\n \*\n\*\/$/.test(out.replace(/\r/g, ""));
+        expect(trailingBlank).toBe(true);
+        // Numeric list lines preserved
+        expect(out).toMatch(/1\. first/);
+        expect(out).toMatch(/2\. second/);
+        // Trailing paragraph got terminal period
+        expect(out).toMatch(/Another paragraph without period\./);
+    });
+    it("glob expansion matches created files", function() {
+        // Create a truly temporary isolated directory outside source tree
+        var tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), "comments-glob-"));
+        var a = path.join(tmpRoot, "a.ts");
+        var nestedDir = path.join(tmpRoot, "nested");
+        fs.mkdirSync(nestedDir, {
+            recursive: true
+        });
+        var b = path.join(nestedDir, "b.ts");
+        fs.writeFileSync(a, "// file a", "utf8");
+        fs.writeFileSync(b, "// file b", "utf8");
+        var patterns = [
+            "".concat(tmpRoot, "/*.ts")
+        ];
+        var augmented = augmentPatterns(patterns);
+        expect(augmented.some(function(p) {
+            return p.includes("**/*.ts");
+        })).toBe(true);
+        var expanded = expandGlobs(patterns);
+        expect(expanded.sort()).toEqual([
+            a,
+            b
+        ].sort());
+    });
+    // Added test for preserving multi-line // comment groups that should NOT merge when preceded by code.
+    it("does not merge an inline explanatory multi-line // comment group following code", function() {
+        var src = [
+            "function demo() {",
+            "  const x = 1; // keep",
+            "  // first line explains next block",
+            "  // still explaining",
+            "  // final line",
+            "  return x; // done",
+            "}",
+            ""
+        ].join("\n");
+        var out = parseAndTransformComments(src, {
+            mergeLineComments: true,
+            wrapLineComments: true,
+            width: 80
+        }).transformed;
+        expect(out).toContain("  // first line explains next block");
+        expect(out).toContain("  // still explaining");
+        expect(out).toContain("  // final line");
+        expect(out).not.toContain("/**");
+    });
+    it("converts the multi-line explanatory block from lib.ts into a multi-line JSDoc, preserving lines", function() {
+        var snippet = [
+            "// JSDoc block extraction:",
+            "// Previous pattern used a lazy dot-all: ([\\s\\S]*?) which could, under",
+            "// pathological inputs, produce excessive backtracking. We replace it with a",
+            "// tempered pattern that advances linearly by never letting the inner part",
+            "// consume a closing '*/'. This avoids catastrophic behavior while keeping",
+            "// correctness.",
+            "// Pattern explanation:",
+            "//  (^ [\\t ]* )    -> capture indentation at start of line (multiline mode)",
+            "//  /\\*\\*          -> opening delimiter",
+            "//  (              -> capture group 2 body",
+            "//    (?:[^*]      -> any non-* char",
+            "//      |\\*(?!/)   -> or a * not followed by /",
+            "//    )*           -> repeated greedily (cannot cross closing */)",
+            "//  )",
+            "//  \\n?[\\t ]*\\*/   -> optional newline + trailing indent + closing */",
+            "// The greedy repetition is safe because the inner alternatives are mutually",
+            "// exclusive and each consumes at least one char without overlapping on the",
+            "// closing sentinel."
+        ].join("\n");
+        var out = parseAndTransformComments(snippet, {
+            width: 100,
+            wrapLineComments: true,
+            mergeLineComments: true
+        }).transformed;
+        // Should be converted to a JSDoc (first and last lines delimiters)
+        var lines = out.split(/\n/);
+        expect(lines[0].trim()).toBe("/**");
+        expect(lines[lines.length - 1].trim()).toBe("*/");
+        // Ensure representative internal lines are present (now without leading //)
+        expect(out).toContain("* JSDoc block extraction:");
+        expect(out).toContain("* Pattern explanation:");
+        // Arrow lines preserved
+        var arrowLineCount = lines.filter(function(l) {
+            return /->/.test(l);
+        }).length;
+        expect(arrowLineCount).toBeGreaterThanOrEqual(5);
+    });
+});
+
+//# sourceMappingURL=lib.test.js.map

package/dist/__tests__/lib.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/__tests__/lib.test.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\nimport { describe, expect, it } from \"vitest\";\nimport { augmentPatterns, expandGlobs } from \"../glob.js\";\nimport { diffLines, parseAndTransformComments } from \"../lib.js\";\n\nconst baseOpts = {\n\twidth: 60,\n\twrapLineComments: true,\n\tmergeLineComments: false,\n};\n\ndescribe(\"parseAndTransformComments\", () => {\n\tit(\"reflows a simple jsdoc and adds period\", () => {\n\t\tconst input = \"/**\\n * This function does something\\n * important\\n */\";\n\t\tconst res = parseAndTransformComments(input, baseOpts);\n\t\texpect(res.transformed).toContain(\"does something important.\");\n\t});\n\n\tit(\"normalizes NOTE capitalization\", () => {\n\t\tconst input = \"/**\\n * note: edge case\\n */\";\n\t\tconst res = parseAndTransformComments(input, baseOpts);\n\t\texpect(/NOTE: edge case/.test(res.transformed)).toBe(true);\n\t});\n\n\tit(\"wraps single line comments\", () => {\n\t\tconst input =\n\t\t\t\"// this is a very long comment that should be wrapped across multiple lines to satisfy width\";\n\t\tconst res = parseAndTransformComments(input, baseOpts);\n\t\texpect(res.transformed.split(/\\n/).length).toBeGreaterThan(1);\n\t});\n\n\tit(\"merges groups of line comments into jsdoc\", () => {\n\t\tconst input = [\n\t\t\t\"// first line\",\n\t\t\t\"// second line\",\n\t\t\t\"// third line\",\n\t\t\t\"const x = 1;\",\n\t\t].join(\"\\n\");\n\t\tconst res = parseAndTransformComments(input, {\n\t\t\t...baseOpts,\n\t\t\tmergeLineComments: true,\n\t\t});\n\t\texpect(/\\/\\*\\*/.test(res.transformed)).toBe(true);\n\t});\n\n\tit(\"is idempotent (second pass unchanged)\", () => {\n\t\tconst input = \"/**\\n * Example doc that will be normalized\\n */\";\n\t\tconst first = parseAndTransformComments(input, baseOpts).transformed;\n\t\tconst second = parseAndTransformComments(first, baseOpts).transformed;\n\t\texpect(diffLines(first, second)).toBe(\"\");\n\t});\n\n\tit(\"preserves code fence blocks\", () => {\n\t\tconst input =\n\t\t\t\"/**\\n * Before\\n * ```js\\n * const  x=  1;   \\n * ```\\n * After\\n */\";\n\t\tconst res = parseAndTransformComments(input, baseOpts).transformed;\n\t\texpect(/```js/.test(res)).toBe(true);\n\t\t// ensure spacing inside fence not normalized\n\t\texpect(/const {2}x= {2}1;/.test(res)).toBe(true);\n\t});\n\n\tit(\"does not merge directive or license groups\", () => {\n\t\tconst input = [\n\t\t\t\"// eslint-disable-next-line\",\n\t\t\t\"// second line should prevent merge due to directive\",\n\t\t\t\"const y = 2;\",\n\t\t\t\"// Copyright 2024 Example\",\n\t\t\t\"// another line\",\n\t\t].join(\"\\n\");\n\t\tconst res = parseAndTransformComments(input, {\n\t\t\t...baseOpts,\n\t\t\tmergeLineComments: true,\n\t\t});\n\t\texpect(/eslint-disable/.test(res.transformed)).toBe(true);\n\t\t// Should not have merged into a jsdoc (no /** directly before const)\n\t\texpect(/\\/\\*\\*/.test(res.transformed)).toBe(false);\n\t});\n\n\tit(\"list items are not reflowed into a paragraph\", () => {\n\t\tconst input =\n\t\t\t\"/**\\n * First line explaining.\\n * - item one more words here\\n * - item two\\n */\";\n\t\tconst res = parseAndTransformComments(input, baseOpts).transformed;\n\t\t// each list item remains on its own line with leading dash\n\t\tconst lines = res.split(/\\n/).filter((l) => /- item/.test(l));\n\t\texpect(lines.length).toBe(2);\n\t});\n\n\tit(\"tag lines are preserved\", () => {\n\t\tconst input =\n\t\t\t\"/**\\n * short description\\n * @param x value\\n * @returns something\\n */\";\n\t\tconst res = parseAndTransformComments(input, baseOpts).transformed;\n\t\texpect(/@param x value/.test(res)).toBe(true);\n\t\texpect(/@returns something/.test(res)).toBe(true);\n\t});\n\n\tit(\"handles heading-like lines with colon and visually indented code & numeric lists\", () => {\n\t\tconst input = [\n\t\t\t\"/**\",\n\t\t\t\" * Overview:\",\n\t\t\t\" *   const   x = 1;\",\n\t\t\t\" * 1. first\",\n\t\t\t\" * 2. second\",\n\t\t\t\" *\", // blank separation\n\t\t\t\" * Another paragraph without period\",\n\t\t\t\" */\",\n\t\t].join(\"\\n\");\n\t\tconst out = parseAndTransformComments(input, baseOpts).transformed;\n\t\t// Heading preserved, not merged into previous paragraph\n\t\texpect(out).toMatch(/Overview:/);\n\t\t// Visually indented code line kept as-is (no extra wrapping collapse)\n\t\texpect(out).toMatch(/const\\s{3}x = 1;/);\n\t\t// Ensure final blank line before closing preserved (one line ending with ' *')\n\t\tconst trailingBlank = /\\n \\*\\n\\*\\/$/.test(out.replace(/\\r/g, \"\"));\n\t\texpect(trailingBlank).toBe(true);\n\t\t// Numeric list lines preserved\n\t\texpect(out).toMatch(/1\\. first/);\n\t\texpect(out).toMatch(/2\\. second/);\n\t\t// Trailing paragraph got terminal period\n\t\texpect(out).toMatch(/Another paragraph without period\\./);\n\t});\n\n\tit(\"glob expansion matches created files\", () => {\n\t\t// Create a truly temporary isolated directory outside source tree\n\t\tconst tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), \"comments-glob-\"));\n\t\tconst a = path.join(tmpRoot, \"a.ts\");\n\t\tconst nestedDir = path.join(tmpRoot, \"nested\");\n\t\tfs.mkdirSync(nestedDir, { recursive: true });\n\t\tconst b = path.join(nestedDir, \"b.ts\");\n\t\tfs.writeFileSync(a, \"// file a\", \"utf8\");\n\t\tfs.writeFileSync(b, \"// file b\", \"utf8\");\n\t\tconst patterns = [`${tmpRoot}/*.ts`];\n\t\tconst augmented = augmentPatterns(patterns);\n\t\texpect(augmented.some((p) => p.includes(\"**/*.ts\"))).toBe(true);\n\t\tconst expanded = expandGlobs(patterns);\n\t\texpect(expanded.sort()).toEqual([a, b].sort());\n\t});\n\n\t// Added test for preserving multi-line // comment groups that should NOT merge when preceded by code.\n\tit(\"does not merge an inline explanatory multi-line // comment group following code\", () => {\n\t\tconst src = [\n\t\t\t\"function demo() {\",\n\t\t\t\"  const x = 1; // keep\",\n\t\t\t\"  // first line explains next block\",\n\t\t\t\"  // still explaining\",\n\t\t\t\"  // final line\",\n\t\t\t\"  return x; // done\",\n\t\t\t\"}\",\n\t\t\t\"\",\n\t\t].join(\"\\n\");\n\t\tconst out = parseAndTransformComments(src, {\n\t\t\tmergeLineComments: true,\n\t\t\twrapLineComments: true,\n\t\t\twidth: 80,\n\t\t}).transformed;\n\t\texpect(out).toContain(\"  // first line explains next block\");\n\t\texpect(out).toContain(\"  // still explaining\");\n\t\texpect(out).toContain(\"  // final line\");\n\t\texpect(out).not.toContain(\"/**\");\n\t});\n\n\tit(\"converts the multi-line explanatory block from lib.ts into a multi-line JSDoc, preserving lines\", () => {\n\t\tconst snippet = [\n\t\t\t\"// JSDoc block extraction:\",\n\t\t\t\"// Previous pattern used a lazy dot-all: ([\\\\s\\\\S]*?) which could, under\",\n\t\t\t\"// pathological inputs, produce excessive backtracking. We replace it with a\",\n\t\t\t\"// tempered pattern that advances linearly by never letting the inner part\",\n\t\t\t\"// consume a closing '*/'. This avoids catastrophic behavior while keeping\",\n\t\t\t\"// correctness.\",\n\t\t\t\"// Pattern explanation:\",\n\t\t\t\"//  (^ [\\\\t ]* )    -> capture indentation at start of line (multiline mode)\",\n\t\t\t\"//  /\\\\*\\\\*          -> opening delimiter\",\n\t\t\t\"//  (              -> capture group 2 body\",\n\t\t\t\"//    (?:[^*]      -> any non-* char\",\n\t\t\t\"//      |\\\\*(?!/)   -> or a * not followed by /\",\n\t\t\t\"//    )*           -> repeated greedily (cannot cross closing */)\",\n\t\t\t\"//  )\",\n\t\t\t\"//  \\\\n?[\\\\t ]*\\\\*/   -> optional newline + trailing indent + closing */\",\n\t\t\t\"// The greedy repetition is safe because the inner alternatives are mutually\",\n\t\t\t\"// exclusive and each consumes at least one char without overlapping on the\",\n\t\t\t\"// closing sentinel.\",\n\t\t].join(\"\\n\");\n\t\tconst out = parseAndTransformComments(snippet, {\n\t\t\twidth: 100,\n\t\t\twrapLineComments: true,\n\t\t\tmergeLineComments: true,\n\t\t}).transformed;\n\t\t// Should be converted to a JSDoc (first and last lines delimiters)\n\t\tconst lines = out.split(/\\n/);\n\t\texpect(lines[0].trim()).toBe(\"/**\");\n\t\texpect(lines[lines.length - 1].trim()).toBe(\"*/\");\n\t\t// Ensure representative internal lines are present (now without leading //)\n\t\texpect(out).toContain(\"* JSDoc block extraction:\");\n\t\texpect(out).toContain(\"* Pattern explanation:\");\n\t\t// Arrow lines preserved\n\t\tconst arrowLineCount = lines.filter((l) => /->/.test(l)).length;\n\t\texpect(arrowLineCount).toBeGreaterThanOrEqual(5);\n\t});\n});\n"],"names":["fs","os","path","describe","expect","it","augmentPatterns","expandGlobs","diffLines","parseAndTransformComments","baseOpts","width","wrapLineComments","mergeLineComments","input","res","transformed","toContain","test","toBe","split","length","toBeGreaterThan","join","first","second","lines","filter","l","out","toMatch","trailingBlank","replace","tmpRoot","mkdtempSync","tmpdir","a","nestedDir","mkdirSync","recursive","b","writeFileSync","patterns","augmented","some","p","includes","expanded","sort","toEqual","src","not","snippet","trim","arrowLineCount","toBeGreaterThanOrEqual"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAOA,QAAQ,UAAU;AACzB,OAAOC,QAAQ,UAAU;AACzB,OAAOC,UAAU,YAAY;AAC7B,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAS;AAC9C,SAASC,eAAe,EAAEC,WAAW,QAAQ,aAAa;AAC1D,SAASC,SAAS,EAAEC,yBAAyB,QAAQ,YAAY;AAEjE,IAAMC,WAAW;IAChBC,OAAO;IACPC,kBAAkB;IAClBC,mBAAmB;AACpB;AAEAV,SAAS,6BAA6B;IACrCE,GAAG,0CAA0C;QAC5C,IAAMS,QAAQ;QACd,IAAMC,MAAMN,0BAA0BK,OAAOJ;QAC7CN,OAAOW,IAAIC,WAAW,EAAEC,SAAS,CAAC;IACnC;IAEAZ,GAAG,kCAAkC;QACpC,IAAMS,QAAQ;QACd,IAAMC,MAAMN,0BAA0BK,OAAOJ;QAC7CN,OAAO,kBAAkBc,IAAI,CAACH,IAAIC,WAAW,GAAGG,IAAI,CAAC;IACtD;IAEAd,GAAG,8BAA8B;QAChC,IAAMS,QACL;QACD,IAAMC,MAAMN,0BAA0BK,OAAOJ;QAC7CN,OAAOW,IAAIC,WAAW,CAACI,KAAK,CAAC,MAAMC,MAAM,EAAEC,eAAe,CAAC;IAC5D;IAEAjB,GAAG,6CAA6C;QAC/C,IAAMS,QAAQ;YACb;YACA;YACA;YACA;SACA,CAACS,IAAI,CAAC;QACP,IAAMR,MAAMN,0BAA0BK,OAAO,wCACzCJ;YACHG,mBAAmB;;QAEpBT,OAAO,SAASc,IAAI,CAACH,IAAIC,WAAW,GAAGG,IAAI,CAAC;IAC7C;IAEAd,GAAG,yCAAyC;QAC3C,IAAMS,QAAQ;QACd,IAAMU,QAAQf,0BAA0BK,OAAOJ,UAAUM,WAAW;QACpE,IAAMS,SAAShB,0BAA0Be,OAAOd,UAAUM,WAAW;QACrEZ,OAAOI,UAAUgB,OAAOC,SAASN,IAAI,CAAC;IACvC;IAEAd,GAAG,+BAA+B;QACjC,IAAMS,QACL;QACD,IAAMC,MAAMN,0BAA0BK,OAAOJ,UAAUM,WAAW;QAClEZ,OAAO,QAAQc,IAAI,CAACH,MAAMI,IAAI,CAAC;QAC/B,6CAA6C;QAC7Cf,OAAO,oBAAoBc,IAAI,CAACH,MAAMI,IAAI,CAAC;IAC5C;IAEAd,GAAG,8CAA8C;QAChD,IAAMS,QAAQ;YACb;YACA;YACA;YACA;YACA;SACA,CAACS,IAAI,CAAC;QACP,IAAMR,MAAMN,0BAA0BK,OAAO,wCACzCJ;YACHG,mBAAmB;;QAEpBT,OAAO,iBAAiBc,IAAI,CAACH,IAAIC,WAAW,GAAGG,IAAI,CAAC;QACpD,qEAAqE;QACrEf,OAAO,SAASc,IAAI,CAACH,IAAIC,WAAW,GAAGG,IAAI,CAAC;IAC7C;IAEAd,GAAG,gDAAgD;QAClD,IAAMS,QACL;QACD,IAAMC,MAAMN,0BAA0BK,OAAOJ,UAAUM,WAAW;QAClE,2DAA2D;QAC3D,IAAMU,QAAQX,IAAIK,KAAK,CAAC,MAAMO,MAAM,CAAC,SAACC;mBAAM,SAASV,IAAI,CAACU;;QAC1DxB,OAAOsB,MAAML,MAAM,EAAEF,IAAI,CAAC;IAC3B;IAEAd,GAAG,2BAA2B;QAC7B,IAAMS,QACL;QACD,IAAMC,MAAMN,0BAA0BK,OAAOJ,UAAUM,WAAW;QAClEZ,OAAO,iBAAiBc,IAAI,CAACH,MAAMI,IAAI,CAAC;QACxCf,OAAO,qBAAqBc,IAAI,CAACH,MAAMI,IAAI,CAAC;IAC7C;IAEAd,GAAG,oFAAoF;QACtF,IAAMS,QAAQ;YACb;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACA,CAACS,IAAI,CAAC;QACP,IAAMM,MAAMpB,0BAA0BK,OAAOJ,UAAUM,WAAW;QAClE,wDAAwD;QACxDZ,OAAOyB,KAAKC,OAAO,CAAC;QACpB,sEAAsE;QACtE1B,OAAOyB,KAAKC,OAAO,CAAC;QACpB,+EAA+E;QAC/E,IAAMC,gBAAgB,eAAeb,IAAI,CAACW,IAAIG,OAAO,CAAC,OAAO;QAC7D5B,OAAO2B,eAAeZ,IAAI,CAAC;QAC3B,+BAA+B;QAC/Bf,OAAOyB,KAAKC,OAAO,CAAC;QACpB1B,OAAOyB,KAAKC,OAAO,CAAC;QACpB,yCAAyC;QACzC1B,OAAOyB,KAAKC,OAAO,CAAC;IACrB;IAEAzB,GAAG,wCAAwC;QAC1C,kEAAkE;QAClE,IAAM4B,UAAUjC,GAAGkC,WAAW,CAAChC,KAAKqB,IAAI,CAACtB,GAAGkC,MAAM,IAAI;QACtD,IAAMC,IAAIlC,KAAKqB,IAAI,CAACU,SAAS;QAC7B,IAAMI,YAAYnC,KAAKqB,IAAI,CAACU,SAAS;QACrCjC,GAAGsC,SAAS,CAACD,WAAW;YAAEE,WAAW;QAAK;QAC1C,IAAMC,IAAItC,KAAKqB,IAAI,CAACc,WAAW;QAC/BrC,GAAGyC,aAAa,CAACL,GAAG,aAAa;QACjCpC,GAAGyC,aAAa,CAACD,GAAG,aAAa;QACjC,IAAME,WAAW;YAAE,GAAU,OAART,SAAQ;SAAO;QACpC,IAAMU,YAAYrC,gBAAgBoC;QAClCtC,OAAOuC,UAAUC,IAAI,CAAC,SAACC;mBAAMA,EAAEC,QAAQ,CAAC;YAAa3B,IAAI,CAAC;QAC1D,IAAM4B,WAAWxC,YAAYmC;QAC7BtC,OAAO2C,SAASC,IAAI,IAAIC,OAAO,CAAC;YAACb;YAAGI;SAAE,CAACQ,IAAI;IAC5C;IAEA,sGAAsG;IACtG3C,GAAG,mFAAmF;QACrF,IAAM6C,MAAM;YACX;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACA,CAAC3B,IAAI,CAAC;QACP,IAAMM,MAAMpB,0BAA0ByC,KAAK;YAC1CrC,mBAAmB;YACnBD,kBAAkB;YAClBD,OAAO;QACR,GAAGK,WAAW;QACdZ,OAAOyB,KAAKZ,SAAS,CAAC;QACtBb,OAAOyB,KAAKZ,SAAS,CAAC;QACtBb,OAAOyB,KAAKZ,SAAS,CAAC;QACtBb,OAAOyB,KAAKsB,GAAG,CAAClC,SAAS,CAAC;IAC3B;IAEAZ,GAAG,mGAAmG;QACrG,IAAM+C,UAAU;YACf;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACA,CAAC7B,IAAI,CAAC;QACP,IAAMM,MAAMpB,0BAA0B2C,SAAS;YAC9CzC,OAAO;YACPC,kBAAkB;YAClBC,mBAAmB;QACpB,GAAGG,WAAW;QACd,mEAAmE;QACnE,IAAMU,QAAQG,IAAIT,KAAK,CAAC;QACxBhB,OAAOsB,KAAK,CAAC,EAAE,CAAC2B,IAAI,IAAIlC,IAAI,CAAC;QAC7Bf,OAAOsB,KAAK,CAACA,MAAML,MAAM,GAAG,EAAE,CAACgC,IAAI,IAAIlC,IAAI,CAAC;QAC5C,4EAA4E;QAC5Ef,OAAOyB,KAAKZ,SAAS,CAAC;QACtBb,OAAOyB,KAAKZ,SAAS,CAAC;QACtB,wBAAwB;QACxB,IAAMqC,iBAAiB5B,MAAMC,MAAM,CAAC,SAACC;mBAAM,KAAKV,IAAI,CAACU;WAAIP,MAAM;QAC/DjB,OAAOkD,gBAAgBC,sBAAsB,CAAC;IAC/C;AACD"}

package/dist/comments.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/comments.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+/* v8 ignore start */ import fs from "node:fs";
+import path from "node:path";
+import kleur from "kleur";
+import { expandGlobs } from "./glob.js";
+import { diffLines, logger, parseAndTransformComments } from "./lib.js";
+import { config } from "./parse.js";
+function exit(code) {
+    process.exit(code);
+}
+function readFileSafe(file) {
+    try {
+        return fs.readFileSync(file, "utf8");
+    } catch (e) {
+        logger.error("File not found: ".concat(file));
+        return undefined;
+    }
+}
+var width = Number(config.flags.width || 80);
+var wrapLineComments = config.flags.noLineWrap !== true;
+var mergeLineComments = config.flags.mergeLineComments === true;
+var fileArgs = Object.values(config.parameters || {});
+// Expand simple glob patterns (*, **, ?) per PRD.
+if (fileArgs.length > 0) {
+    fileArgs = expandGlobs(fileArgs);
+}
+var files = fileArgs;
+if (!files.length) {
+    var _logger_printErrorsAndExit;
+    (_logger_printErrorsAndExit = logger.printErrorsAndExit) === null || _logger_printErrorsAndExit === void 0 ? void 0 : _logger_printErrorsAndExit.call(logger, [
+        "No matching files found"
+    ], 1);
+}
+var anyChanges = false;
+var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+try {
+    for(var _iterator = files[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+        var file = _step.value;
+        var source = readFileSafe(file);
+        if (source === undefined) {
+            continue;
+        }
+        var result = parseAndTransformComments(source, {
+            width: width,
+            wrapLineComments: wrapLineComments,
+            mergeLineComments: mergeLineComments
+        });
+        if (config.flags.dryRun) {
+            if (result.changed) {
+                anyChanges = true;
+                logger.info("Changes in ".concat(file));
+                var d = diffLines(source, result.transformed);
+                if (d) {
+                    process.stdout.write(kleur.gray("\n".concat(d, "\n\n")));
+                }
+            } else {
+                logger.info("No changes needed in ".concat(file));
+            }
+        } else if (config.flags.stdout) {
+            process.stdout.write(result.transformed);
+        } else if (result.changed) {
+            fs.writeFileSync(file, result.transformed, "utf8");
+            logger.info("Reflowed ".concat(path.basename(file)).concat(mergeLineComments ? " merged" : "").concat(wrapLineComments ? " wrapped" : ""));
+        } else {
+            process.stdout.write(kleur.gray("Unchanged ".concat(file, "\n")));
+        }
+    }
+} catch (err) {
+    _didIteratorError = true;
+    _iteratorError = err;
+} finally{
+    try {
+        if (!_iteratorNormalCompletion && _iterator.return != null) {
+            _iterator.return();
+        }
+    } finally{
+        if (_didIteratorError) {
+            throw _iteratorError;
+        }
+    }
+}
+if (config.flags.dryRun) {
+    exit(anyChanges ? 1 : 0);
+} /* v8 ignore stop */ 
+
+//# sourceMappingURL=comments.js.map

package/dist/comments.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/comments.ts"],"sourcesContent":["#!/usr/bin/env node\n/* v8 ignore start */\nimport fs from \"node:fs\";\nimport path from \"node:path\";\nimport kleur from \"kleur\";\nimport { expandGlobs } from \"./glob.js\";\nimport { diffLines, logger, parseAndTransformComments } from \"./lib.js\";\nimport { config } from \"./parse.js\";\n\nfunction exit(code: number) {\n\tprocess.exit(code);\n}\n\nfunction readFileSafe(file: string): string | undefined {\n\ttry {\n\t\treturn fs.readFileSync(file, \"utf8\");\n\t} catch {\n\t\tlogger.error(`File not found: ${file}`);\n\t\treturn undefined;\n\t}\n}\n\nconst width = Number(config.flags.width || 80);\nconst wrapLineComments = config.flags.noLineWrap !== true;\nconst mergeLineComments = config.flags.mergeLineComments === true;\n\nlet fileArgs: string[] = Object.values(config.parameters || {});\n// Expand simple glob patterns (*, **, ?) per PRD.\nif (fileArgs.length > 0) {\n\tfileArgs = expandGlobs(fileArgs);\n}\nconst files: string[] = fileArgs;\nif (!files.length) {\n\tlogger.printErrorsAndExit?.([\"No matching files found\"], 1);\n}\n\nlet anyChanges = false;\n\nfor (const file of files) {\n\tconst source = readFileSafe(file);\n\tif (source === undefined) {\n\t\tcontinue;\n\t}\n\tconst result = parseAndTransformComments(source, {\n\t\twidth,\n\t\twrapLineComments,\n\t\tmergeLineComments,\n\t});\n\tif (config.flags.dryRun) {\n\t\tif (result.changed) {\n\t\t\tanyChanges = true;\n\t\t\tlogger.info(`Changes in ${file}`);\n\t\t\tconst d = diffLines(source, result.transformed);\n\t\t\tif (d) {\n\t\t\t\tprocess.stdout.write(kleur.gray(`\\n${d}\\n\\n`));\n\t\t\t}\n\t\t} else {\n\t\t\tlogger.info(`No changes needed in ${file}`);\n\t\t}\n\t} else if (config.flags.stdout) {\n\t\tprocess.stdout.write(result.transformed);\n\t} else if (result.changed) {\n\t\tfs.writeFileSync(file, result.transformed, \"utf8\");\n\t\tlogger.info(\n\t\t\t`Reflowed ${path.basename(file)}${mergeLineComments ? \" merged\" : \"\"}${wrapLineComments ? \" wrapped\" : \"\"}`,\n\t\t);\n\t} else {\n\t\tprocess.stdout.write(kleur.gray(`Unchanged ${file}\\n`));\n\t}\n}\n\nif (config.flags.dryRun) {\n\texit(anyChanges ? 1 : 0);\n}\n/* v8 ignore stop */\n"],"names":["fs","path","kleur","expandGlobs","diffLines","logger","parseAndTransformComments","config","exit","code","process","readFileSafe","file","readFileSync","error","undefined","width","Number","flags","wrapLineComments","noLineWrap","mergeLineComments","fileArgs","Object","values","parameters","length","files","printErrorsAndExit","anyChanges","source","result","dryRun","changed","info","d","transformed","stdout","write","gray","writeFileSync","basename"],"mappings":";AACA,mBAAmB,GACnB,OAAOA,QAAQ,UAAU;AACzB,OAAOC,UAAU,YAAY;AAC7B,OAAOC,WAAW,QAAQ;AAC1B,SAASC,WAAW,QAAQ,YAAY;AACxC,SAASC,SAAS,EAAEC,MAAM,EAAEC,yBAAyB,QAAQ,WAAW;AACxE,SAASC,MAAM,QAAQ,aAAa;AAEpC,SAASC,KAAKC,IAAY;IACzBC,QAAQF,IAAI,CAACC;AACd;AAEA,SAASE,aAAaC,IAAY;IACjC,IAAI;QACH,OAAOZ,GAAGa,YAAY,CAACD,MAAM;IAC9B,EAAE,UAAM;QACPP,OAAOS,KAAK,CAAC,AAAC,mBAAuB,OAALF;QAChC,OAAOG;IACR;AACD;AAEA,IAAMC,QAAQC,OAAOV,OAAOW,KAAK,CAACF,KAAK,IAAI;AAC3C,IAAMG,mBAAmBZ,OAAOW,KAAK,CAACE,UAAU,KAAK;AACrD,IAAMC,oBAAoBd,OAAOW,KAAK,CAACG,iBAAiB,KAAK;AAE7D,IAAIC,WAAqBC,OAAOC,MAAM,CAACjB,OAAOkB,UAAU,IAAI,CAAC;AAC7D,kDAAkD;AAClD,IAAIH,SAASI,MAAM,GAAG,GAAG;IACxBJ,WAAWnB,YAAYmB;AACxB;AACA,IAAMK,QAAkBL;AACxB,IAAI,CAACK,MAAMD,MAAM,EAAE;QAClBrB;KAAAA,6BAAAA,OAAOuB,kBAAkB,cAAzBvB,iDAAAA,gCAAAA,QAA4B;QAAC;KAA0B,EAAE;AAC1D;AAEA,IAAIwB,aAAa;IAEZ,kCAAA,2BAAA;;IAAL,QAAK,YAAcF,0BAAd,SAAA,6BAAA,QAAA,yBAAA,iCAAqB;QAArB,IAAMf,OAAN;QACJ,IAAMkB,SAASnB,aAAaC;QAC5B,IAAIkB,WAAWf,WAAW;YACzB;QACD;QACA,IAAMgB,SAASzB,0BAA0BwB,QAAQ;YAChDd,OAAAA;YACAG,kBAAAA;YACAE,mBAAAA;QACD;QACA,IAAId,OAAOW,KAAK,CAACc,MAAM,EAAE;YACxB,IAAID,OAAOE,OAAO,EAAE;gBACnBJ,aAAa;gBACbxB,OAAO6B,IAAI,CAAC,AAAC,cAAkB,OAALtB;gBAC1B,IAAMuB,IAAI/B,UAAU0B,QAAQC,OAAOK,WAAW;gBAC9C,IAAID,GAAG;oBACNzB,QAAQ2B,MAAM,CAACC,KAAK,CAACpC,MAAMqC,IAAI,CAAC,AAAC,KAAM,OAAFJ,GAAE;gBACxC;YACD,OAAO;gBACN9B,OAAO6B,IAAI,CAAC,AAAC,wBAA4B,OAALtB;YACrC;QACD,OAAO,IAAIL,OAAOW,KAAK,CAACmB,MAAM,EAAE;YAC/B3B,QAAQ2B,MAAM,CAACC,KAAK,CAACP,OAAOK,WAAW;QACxC,OAAO,IAAIL,OAAOE,OAAO,EAAE;YAC1BjC,GAAGwC,aAAa,CAAC5B,MAAMmB,OAAOK,WAAW,EAAE;YAC3C/B,OAAO6B,IAAI,CACV,AAAC,YAAiCb,OAAtBpB,KAAKwC,QAAQ,CAAC7B,OAA6CO,OAArCE,oBAAoB,YAAY,IAAwC,OAAnCF,mBAAmB,aAAa;QAEzG,OAAO;YACNT,QAAQ2B,MAAM,CAACC,KAAK,CAACpC,MAAMqC,IAAI,CAAC,AAAC,aAAiB,OAAL3B,MAAK;QACnD;IACD;;IA/BK;IAAA;;;aAAA,6BAAA;YAAA;;;YAAA;kBAAA;;;;AAiCL,IAAIL,OAAOW,KAAK,CAACc,MAAM,EAAE;IACxBxB,KAAKqB,aAAa,IAAI;AACvB,EACA,kBAAkB"}

package/dist/defaults.d.ts

@@ -0,0 +1,5 @@
+export declare const defaultFlags: {
+    width: number;
+    wrapLineComments: boolean;
+    mergeLineComments: boolean;
+};

package/dist/defaults.js

@@ -0,0 +1,7 @@
+/* v8 ignore start */ export var defaultFlags = {
+    width: 80,
+    wrapLineComments: true,
+    mergeLineComments: false
+}; /* v8 ignore stop */ 
+
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["/* v8 ignore start */\nexport const defaultFlags = {\n\twidth: 80,\n\twrapLineComments: true,\n\tmergeLineComments: false,\n};\n/* v8 ignore stop */\n"],"names":["defaultFlags","width","wrapLineComments","mergeLineComments"],"mappings":"AAAA,mBAAmB,GACnB,OAAO,IAAMA,eAAe;IAC3BC,OAAO;IACPC,kBAAkB;IAClBC,mBAAmB;AACpB,EAAE,CACF,kBAAkB"}

package/dist/glob.d.ts

@@ -0,0 +1,5 @@
+export interface GlobOptions {
+    followSymlinks?: boolean;
+}
+export declare function augmentPatterns(patterns: string[]): string[];
+export declare function expandGlobs(patterns: string[], options?: GlobOptions): string[];