@sister.software/oxlint-config 10.0.0 → 11.0.0

package/README.md

@@ -40,14 +40,19 @@ export default createOxlintConfig({
 | `react`                  | `false`                   | Enable oxlint's React plugin.                               |
 | `headers`                | `true`                    | Enforce file headers (error severity, auto-fixed).          |
 | `padding`                | `true`                    | Blank line before `return`/block-like statements.           |
+| `consolePadding`         | `true`                    | Blank line on each side of a `console.*` call.               |
+| `multilineStatementPadding` | `true`                 | Blank line on each side of a multi-line statement.           |
 | `braces`                 | `true`                    | Braces around single-statement bodies.                      |
 | `restrictProcessGlobals` | `false`                   | Forbid direct `process.env` / `process.argv` access.        |
 | `limits`                 | calibrated defaults       | Override individual legibility ceilings.                    |
 | `testFilePatterns`       | `**/*.test.ts`, …         | Globs where the size and constant rules switch off.         |
 | `generatedFilePatterns`  | `**/*.gen.ts`, …          | Globs where only the size ceilings switch off.              |
+| `untypedFilePatterns`    | `**/*.js`, `**/*.mjs`, …  | Globs where the multi-line JSDoc requirement switches off.  |
 | `unnamedThresholds`      | `false`                   | Flag numeric literals used as comparison thresholds.        |
 | `constantDocs`           | `false`                   | Require JSDoc on exported / `SCREAMING_CASE` constants.     |
 | `lengthTruthiness`       | `true`                    | Rewrite explicit length comparisons to truthiness.          |
+| `multilineJSDoc`         | `true`                    | Require JSDoc blocks to span multiple lines.                |
+| `sectionMarkers`         | `true`                    | Enforce the banner → MARK → region → split ladder.          |
 | `ignorePatterns`         | build output, `.yarn`     | Replace the default ignore list.                            |
 | `overrides`              | `{}`                      | Extra config merged last (escape hatch).                    |
 
@@ -85,6 +90,97 @@ A bundled oxlint JS plugin (`sister-software/require-file-header`) reports and a
 `@copyright`/`@license`/`@author` header, preserving any other JSDoc tags already in the leading
 comment block. Run `oxlint --fix` to stamp headers.
 
+### Statement padding
+
+`padding-lines` (warn, autofixed) puts a blank line before the statements that end a path or a step —
+`return`, `continue`, `break`, a bare `x++`/`x--` — and before block-like statements. An `interface`,
+`type`, `enum` or `namespace` with a body counts as block-like: same braces, same weight on the page.
+
+`multiline-statement-padding` (warn, autofixed) puts one on each side of a statement that spans lines,
+so a reader sees where it starts and stops without matching brackets:
+
+```ts
+const canonical = {          const canonical = {
+	raw,                            raw,
+	source,                         source,
+}                     →      }
+const aligned = align()
+                             const aligned = align()
+```
+
+An exported declaration is padded exactly like the unexported form — both rules look through the
+`export` wrapper.
+
+Neither edge is required at a block boundary, where the brace already separates. `console.*` calls are
+left to the rule below, which groups consecutive ones — this one would split a run that happens to
+contain a tall call, and a run of output is one thing.
+
+### Console padding
+
+`console-padding` (warn, autofixed) puts a blank line on each side of a `console.*` call, so the lines
+that produce output stand apart from the lines that compute it:
+
+```ts
+const total = sum(stats)
+console.log(`${total} shards`)      const total = sum(stats)
+const headers = ["source"]
+console.log(headers)          →     console.log(`${total} shards`)
+
+                                    const headers = ["source"]
+
+                                    console.log(headers)
+```
+
+A RUN of calls is one group — no blank lines inside it, one before the first and one after the last,
+because consecutive calls are one block of output. Neither edge is required where a block boundary
+already separates them: nothing before a call that opens a block, nothing after one that closes it.
+
+### Section markers
+
+Four rules over the comments people use to carve a file into sections. They form one ladder, and each
+rung is a smaller file than the last:
+
+```ts
+// ---------------------------------------------------------------
+// Second section                     →  // MARK: Second section
+// ---------------------------------------------------------------
+```
+
+1. **`prefer-mark-comment`** (error, autofixed) — a `----` banner is three lines of decoration
+   carrying one label. It becomes `// MARK: <label>`, with a blank line on each side. A banner
+   wrapping more than one line of prose is reported but never collapsed — that prose is content.
+2. **`concise-section-marker`** (error) — a marker's label is a label, not a paragraph. Past
+   `maxBodyLength` (60), the detail belongs in the JSDoc of what it describes, or the file wants
+   splitting and an `@file` block.
+3. **`prefer-region-over-marks`** (warn) — past one marker, a file has sections, and sections have
+   ENDS. `//#region` / `//#endregion` fold, so a reader can collapse what they are not reading.
+4. **`max-regions`** (warn) — past `maxRegions` (10), the sections want to be files. Deliberately
+   high: four well-named regions are usually fine, and splitting can separate a type from its
+   helpers. This is a runaway detector, not a style nudge.
+
+Rungs 3 and 4 warn rather than error: where a section ends, and whether it should move, are judgment
+calls no fixer gets to make. Both switch off in test files, where the suite's shape is dictated by the
+code under test.
+
+```ts
+createOxlintConfig({ sectionMarkers: { maxBodyLength: 80, maxRegions: 6 } })
+```
+
+### Multi-line JSDoc
+
+`multiline-jsdoc` (error, autofixed) expands a one-line block:
+
+```ts
+/** The answer. */          →     /**
+                                   * The answer.
+                                   */
+```
+
+A one-line block reads as an aside; the multi-line form reads as documentation, and it leaves
+somewhere to put the second sentence. Only blocks that lead their line are rewritten — one sharing a
+line with code is a type cast, and expanding it changes what the line means. Off for
+`untypedFilePatterns`, where a JSDoc block often IS the type annotation.
+
 ### Legibility tiers
 
 v10 turns on four tiers of upstream rules by default:

package/out/browser-globals.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file The browser globals whose bare use is ambiguous, and the rule entry built from them. A list
+ *   this long is reference data — it belongs beside the code that consumes it, not inside the file
+ *   that assembles the platform-layering overrides.
+ */
+/**
+ * Browser globals whose bare use is ambiguous (they collide with common identifiers). Browser- and node-runtime files
+ * warn on these, nudging toward an explicit `window.` access.
+ */
+export declare const BROWSER_GLOBALS: readonly ["addEventListener", "blur", "close", "closed", "confirm", "defaultStatus", "defaultstatus", "event", "external", "find", "focus", "frameElement", "frames", "history", "innerHeight", "innerWidth", "length", "location", "locationbar", "menubar", "moveBy", "moveTo", "name", "onblur", "onerror", "onfocus", "onload", "onresize", "onunload", "open", "opener", "opera", "outerHeight", "outerWidth", "pageXOffset", "pageYOffset", "parent", "print", "removeEventListener", "resizeBy", "resizeTo", "screen", "screenLeft", "screenTop", "screenX", "screenY", "scroll", "scrollbars", "scrollBy", "scrollTo", "scrollX", "scrollY", "self", "status", "statusbar", "stop", "toolbar", "top"];
+export declare function restrictedBrowserGlobalsRule(): unknown;
+//# sourceMappingURL=browser-globals.d.ts.map

package/out/browser-globals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-globals.d.ts","sourceRoot":"","sources":["../src/browser-globals.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,eAAO,MAAM,eAAe,+qBA2DlB,CAAA;AAEV,wBAAgB,4BAA4B,IAAI,OAAO,CAEtD"}

package/out/browser-globals.js

@@ -0,0 +1,76 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file The browser globals whose bare use is ambiguous, and the rule entry built from them. A list
+ *   this long is reference data — it belongs beside the code that consumes it, not inside the file
+ *   that assembles the platform-layering overrides.
+ */
+/**
+ * Browser globals whose bare use is ambiguous (they collide with common identifiers). Browser- and node-runtime files
+ * warn on these, nudging toward an explicit `window.` access.
+ */
+export const BROWSER_GLOBALS = [
+    "addEventListener",
+    "blur",
+    "close",
+    "closed",
+    "confirm",
+    "defaultStatus",
+    "defaultstatus",
+    "event",
+    "external",
+    "find",
+    "focus",
+    "frameElement",
+    "frames",
+    "history",
+    "innerHeight",
+    "innerWidth",
+    "length",
+    "location",
+    "locationbar",
+    "menubar",
+    "moveBy",
+    "moveTo",
+    "name",
+    "onblur",
+    "onerror",
+    "onfocus",
+    "onload",
+    "onresize",
+    "onunload",
+    "open",
+    "opener",
+    "opera",
+    "outerHeight",
+    "outerWidth",
+    "pageXOffset",
+    "pageYOffset",
+    "parent",
+    "print",
+    "removeEventListener",
+    "resizeBy",
+    "resizeTo",
+    "screen",
+    "screenLeft",
+    "screenTop",
+    "screenX",
+    "screenY",
+    "scroll",
+    "scrollbars",
+    "scrollBy",
+    "scrollTo",
+    "scrollX",
+    "scrollY",
+    "self",
+    "status",
+    "statusbar",
+    "stop",
+    "toolbar",
+    "top",
+];
+export function restrictedBrowserGlobalsRule() {
+    return ["warn", ...BROWSER_GLOBALS.map((name) => ({ name, message: `Ambiguous: did you mean \`window.${name}\`?` }))];
+}
+//# sourceMappingURL=browser-globals.js.map

package/out/browser-globals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-globals.js","sourceRoot":"","sources":["../src/browser-globals.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,kBAAkB;IAClB,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,eAAe;IACf,eAAe;IACf,OAAO;IACP,UAAU;IACV,MAAM;IACN,OAAO;IACP,cAAc;IACd,QAAQ;IACR,SAAS;IACT,aAAa;IACb,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,aAAa;IACb,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,SAAS;IACT,SAAS;IACT,QAAQ;IACR,UAAU;IACV,UAAU;IACV,MAAM;IACN,QAAQ;IACR,OAAO;IACP,aAAa;IACb,YAAY;IACZ,aAAa;IACb,aAAa;IACb,QAAQ;IACR,OAAO;IACP,qBAAqB;IACrB,UAAU;IACV,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,WAAW;IACX,SAAS;IACT,SAAS;IACT,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,UAAU;IACV,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,WAAW;IACX,MAAM;IACN,SAAS;IACT,KAAK;CACI,CAAA;AAEV,MAAM,UAAU,4BAA4B;IAC3C,OAAO,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,oCAAoC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;AACtH,CAAC"}

package/out/console-padding-plugin.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file The `sister-software/console-padding` rule: a `console.*` call gets a blank line on each
+ *   side, so the lines that produce output stand apart from the lines that compute it. Scanning a
+ *   long procedural script for "what does this print" then works visually.
+ *
+ *   A RUN of console calls is one group — no blank lines inside it, one before the first and one
+ *   after the last, because consecutive calls are one block of output. Neither edge is required
+ *   where the block boundary already provides the separation: nothing is needed before a call that
+ *   opens a block, or after one that closes it.
+ */
+import type { Rule } from "./plugin-types.js";
+export declare const consolePaddingRule: Rule;
+//# sourceMappingURL=console-padding-plugin.d.ts.map

package/out/console-padding-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console-padding-plugin.d.ts","sourceRoot":"","sources":["../src/console-padding-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,KAAK,EAAW,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAsBtD,eAAO,MAAM,kBAAkB,EAAE,IAsChC,CAAA"}

package/out/console-padding-plugin.js

@@ -0,0 +1,68 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file The `sister-software/console-padding` rule: a `console.*` call gets a blank line on each
+ *   side, so the lines that produce output stand apart from the lines that compute it. Scanning a
+ *   long procedural script for "what does this print" then works visually.
+ *
+ *   A RUN of console calls is one group — no blank lines inside it, one before the first and one
+ *   after the last, because consecutive calls are one block of output. Neither edge is required
+ *   where the block boundary already provides the separation: nothing is needed before a call that
+ *   opens a block, or after one that closes it.
+ */
+import { createPaddingHelpers } from "./padding-utils.js";
+/**
+ * The object whose method calls this rule treats as output.
+ */
+const CONSOLE_OBJECT = "console";
+/**
+ * Is this statement a bare `console.<method>(…)` call?
+ */
+function isConsoleStatement(node) {
+    if (node?.type !== "ExpressionStatement")
+        return false;
+    const call = node.expression;
+    if (call?.type !== "CallExpression")
+        return false;
+    const callee = call.callee;
+    return (callee?.type === "MemberExpression" && callee.object?.type === "Identifier" && callee.object.name === CONSOLE_OBJECT);
+}
+export const consolePaddingRule = {
+    meta: {
+        name: "console-padding",
+        type: "layout",
+        fixable: "whitespace",
+        schema: [{ type: "object", additionalProperties: true }],
+    },
+    create(context) {
+        const sourceCode = context.sourceCode ?? context.getSourceCode();
+        const text = sourceCode.getText();
+        const { requirePadding } = createPaddingHelpers(context);
+        return {
+            ExpressionStatement(node) {
+                if (!isConsoleStatement(node))
+                    return;
+                const parent = node.parent;
+                // Only statements in a statement list have neighbours to pad against.
+                if (!parent || !Array.isArray(parent.body))
+                    return;
+                const body = parent.body;
+                const index = body.indexOf(node);
+                if (index === -1)
+                    return;
+                const previous = body[index - 1];
+                const next = body[index + 1];
+                // Nothing before a call that opens the block, and nothing between calls in one run.
+                if (previous && !isConsoleStatement(previous)) {
+                    requirePadding(previous, node, node, "Expected a blank line before this console call.");
+                }
+                // Nothing after a call that closes the block — the brace already separates it.
+                if (next && !isConsoleStatement(next)) {
+                    requirePadding(node, next, node, "Expected a blank line after this console call.");
+                }
+            },
+        };
+    },
+};
+//# sourceMappingURL=console-padding-plugin.js.map

package/out/console-padding-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"console-padding-plugin.js","sourceRoot":"","sources":["../src/console-padding-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AAGzD;;GAEG;AACH,MAAM,cAAc,GAAG,SAAS,CAAA;AAEhC;;GAEG;AACH,SAAS,kBAAkB,CAAC,IAAyB;IACpD,IAAI,IAAI,EAAE,IAAI,KAAK,qBAAqB;QAAE,OAAO,KAAK,CAAA;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAA;IAE5B,IAAI,IAAI,EAAE,IAAI,KAAK,gBAAgB;QAAE,OAAO,KAAK,CAAA;IACjD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;IAE1B,OAAO,CACN,MAAM,EAAE,IAAI,KAAK,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,KAAK,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,cAAc,CACpH,CAAA;AACF,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAS;IACvC,IAAI,EAAE;QACL,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,YAAY;QACrB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;QACjE,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;QACjC,MAAM,EAAE,cAAc,EAAE,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAA;QAExD,OAAO;YACN,mBAAmB,CAAC,IAAa;gBAChC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;oBAAE,OAAM;gBACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;gBAE1B,sEAAsE;gBACtE,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;oBAAE,OAAM;gBAClD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;gBACxB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBAEhC,IAAI,KAAK,KAAK,CAAC,CAAC;oBAAE,OAAM;gBACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;gBAChC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;gBAE5B,oFAAoF;gBACpF,IAAI,QAAQ,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC/C,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,iDAAiD,CAAC,CAAA;gBACxF,CAAC;gBAED,+EAA+E;gBAC/E,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;oBACvC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,gDAAgD,CAAC,CAAA;gBACnF,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA"}

package/out/constant-doc-plugin.d.ts

@@ -9,11 +9,17 @@
  *   this rule without extracting a constant per row.
  */
 import type { Rule } from "./plugin-types.js";
-/** Which module-level constants the rule applies to. */
+/**
+ * Which module-level constants the rule applies to.
+ */
 export type ConstantDocScope = "exported" | "screaming" | "exported-or-screaming";
-/** Options accepted by {@link requireConstantDocRule}. */
+/**
+ * Options accepted by {@link requireConstantDocRule}.
+ */
 export interface ConstantDocOptions {
-    /** Defaults to `"exported-or-screaming"`. */
+    /**
+     * Defaults to `"exported-or-screaming"`.
+     */
     scope?: ConstantDocScope;
     /**
      * Export names a framework requires and gives meaning to, which a JSDoc block cannot improve on — Pastel's

package/out/constant-doc-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constant-doc-plugin.d.ts","sourceRoot":"","sources":["../src/constant-doc-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAQ7C,wDAAwD;AACxD,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,uBAAuB,CAAA;AAEjF,0DAA0D;AAC1D,MAAM,WAAW,kBAAkB;IAClC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,eAAO,MAAM,sBAAsB,EAAE,IA8EpC,CAAA;AAED,eAAe,sBAAsB,CAAA"}
+{"version":3,"file":"constant-doc-plugin.d.ts","sourceRoot":"","sources":["../src/constant-doc-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAY7C;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,uBAAuB,CAAA;AAEjF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,eAAO,MAAM,sBAAsB,EAAE,IA8EpC,CAAA;AAED,eAAe,sBAAsB,CAAA"}

package/out/constant-doc-plugin.js

@@ -8,9 +8,13 @@
  *   documented table also answers for every number inside it, which is why data-heavy files satisfy
  *   this rule without extracting a constant per row.
  */
-/** Names in SCREAMING_SNAKE_CASE, the convention for a tuning knob. */
+/**
+ * Names in SCREAMING_SNAKE_CASE, the convention for a tuning knob.
+ */
 const SCREAMING_CASE = /^[A-Z][A-Z0-9_]*$/;
-/** Initializers that make the binding a function rather than a constant value. */
+/**
+ * Initializers that make the binding a function rather than a constant value.
+ */
 const FUNCTION_INITIALIZERS = new Set(["ArrowFunctionExpression", "FunctionExpression"]);
 export const requireConstantDocRule = {
     meta: {

package/out/constant-doc-plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"constant-doc-plugin.js","sourceRoot":"","sources":["../src/constant-doc-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,uEAAuE;AACvE,MAAM,cAAc,GAAG,mBAAmB,CAAA;AAE1C,kFAAkF;AAClF,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,CAAC,CAAA;AAgBxF,MAAM,CAAC,MAAM,sBAAsB,GAAS;IAC3C,IAAI,EAAE;QACL,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAuB,CAAA;QAChE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,uBAAuB,CAAA;QACtD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAChD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;QACjE,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;QACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAA;QAE5C;;;;;;WAMG;QACH,SAAS,cAAc,CAAC,KAAa;YACpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAChC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;oBAAE,SAAQ;gBAEtC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,SAAQ;gBAExE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;gBAE/C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC;oBAAE,OAAO,IAAI,CAAA;YAC3E,CAAC;YAED,OAAO,KAAK,CAAA;QACb,CAAC;QAED,SAAS,OAAO,CAAC,QAAiB,EAAE,SAAkB;YACrD,IAAI,KAAK,KAAK,UAAU;gBAAE,OAAO,QAAQ,CAAA;YAEzC,IAAI,KAAK,KAAK,WAAW;gBAAE,OAAO,SAAS,CAAA;YAE3C,OAAO,QAAQ,IAAI,SAAS,CAAA;QAC7B,CAAC;QAED,OAAO;YACN,mBAAmB,CAAC,IAAI;gBACvB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;oBAAE,OAAM;gBAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,wBAAwB,CAAA;gBAC/D,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAO,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEhD,uFAAuF;gBACvF,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,KAAK,SAAS;oBAAE,OAAM;gBAEhD,IAAI,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAAE,OAAM;gBAE9C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC;oBAClD,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,CAAA;oBAExB,IAAI,EAAE,EAAE,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC,IAAI;wBAAE,SAAQ;oBAEnD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC;wBAAE,SAAQ;oBAEtC,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAA;oBAEnC,IAAI,WAAW,IAAI,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;wBAAE,SAAQ;oBAExE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;wBAAE,SAAQ;oBAE9D,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,UAAU;wBAChB,OAAO,EACN,KAAK,EAAE,CAAC,IAAI,SAAS,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,4BAA4B;4BAC3F,iEAAiE;qBAClE,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,eAAe,sBAAsB,CAAA"}
+{"version":3,"file":"constant-doc-plugin.js","sourceRoot":"","sources":["../src/constant-doc-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH;;GAEG;AACH,MAAM,cAAc,GAAG,mBAAmB,CAAA;AAE1C;;GAEG;AACH,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,yBAAyB,EAAE,oBAAoB,CAAC,CAAC,CAAA;AAsBxF,MAAM,CAAC,MAAM,sBAAsB,GAAS;IAC3C,IAAI,EAAE;QACL,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAuB,CAAA;QAChE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,uBAAuB,CAAA;QACtD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAChD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;QACjE,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;QACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAA;QAE5C;;;;;;WAMG;QACH,SAAS,cAAc,CAAC,KAAa;YACpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAChC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;oBAAE,SAAQ;gBAEtC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,SAAQ;gBAExE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;gBAE/C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC;oBAAE,OAAO,IAAI,CAAA;YAC3E,CAAC;YAED,OAAO,KAAK,CAAA;QACb,CAAC;QAED,SAAS,OAAO,CAAC,QAAiB,EAAE,SAAkB;YACrD,IAAI,KAAK,KAAK,UAAU;gBAAE,OAAO,QAAQ,CAAA;YAEzC,IAAI,KAAK,KAAK,WAAW;gBAAE,OAAO,SAAS,CAAA;YAE3C,OAAO,QAAQ,IAAI,SAAS,CAAA;QAC7B,CAAC;QAED,OAAO;YACN,mBAAmB,CAAC,IAAI;gBACvB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;oBAAE,OAAM;gBAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,wBAAwB,CAAA;gBAC/D,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAO,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEhD,uFAAuF;gBACvF,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,KAAK,SAAS;oBAAE,OAAM;gBAEhD,IAAI,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAAE,OAAM;gBAE9C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,EAAE,CAAC;oBAClD,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,CAAA;oBAExB,IAAI,EAAE,EAAE,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC,IAAI;wBAAE,SAAQ;oBAEnD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC;wBAAE,SAAQ;oBAEtC,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAA;oBAEnC,IAAI,WAAW,IAAI,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;wBAAE,SAAQ;oBAExE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;wBAAE,SAAQ;oBAE9D,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,UAAU;wBAChB,OAAO,EACN,KAAK,EAAE,CAAC,IAAI,SAAS,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,4BAA4B;4BAC3F,iEAAiE;qBAClE,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,eAAe,sBAAsB,CAAA"}

package/out/headers-plugin.d.ts

@@ -7,14 +7,18 @@
  *   while preserving any other JSDoc tags already present in the leading comment block.
  */
 import type { Plugin, Rule } from "./plugin-types.js";
-/** Options accepted by the header rule. */
+/**
+ * Options accepted by the header rule.
+ */
 export interface HeaderRuleOptions {
     copyrightHolder?: string;
     spdxLicenseIdentifier?: string;
     author?: string;
 }
 export declare const headerRule: Rule;
-/** The Sister Software oxlint header plugin. Registers the `sister-software/require-file-header` rule. */
+/**
+ * The Sister Software oxlint header plugin. Registers the `sister-software/require-file-header` rule.
+ */
 declare const headerPlugin: Plugin;
 export default headerPlugin;
 //# sourceMappingURL=headers-plugin.d.ts.map

package/out/headers-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"headers-plugin.d.ts","sourceRoot":"","sources":["../src/headers-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAW,MAAM,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE9D,2CAA2C;AAC3C,MAAM,WAAW,iBAAiB;IACjC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAeD,eAAO,MAAM,UAAU,EAAE,IAiExB,CAAA;AAED,0GAA0G;AAC1G,QAAA,MAAM,YAAY,EAAE,MAGnB,CAAA;AAED,eAAe,YAAY,CAAA"}
+{"version":3,"file":"headers-plugin.d.ts","sourceRoot":"","sources":["../src/headers-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAW,MAAM,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAeD,eAAO,MAAM,UAAU,EAAE,IAiExB,CAAA;AAED;;GAEG;AACH,QAAA,MAAM,YAAY,EAAE,MAGnB,CAAA;AAED,eAAe,YAAY,CAAA"}

package/out/headers-plugin.js

@@ -76,7 +76,9 @@ export const headerRule = {
         };
     },
 };
-/** The Sister Software oxlint header plugin. Registers the `sister-software/require-file-header` rule. */
+/**
+ * The Sister Software oxlint header plugin. Registers the `sister-software/require-file-header` rule.
+ */
 const headerPlugin = {
     meta: { name: "sister-software" },
     rules: { "require-file-header": headerRule },

package/out/headers-plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"headers-plugin.js","sourceRoot":"","sources":["../src/headers-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAWH,MAAM,kBAAkB,GAAG,gCAAgC,CAAA;AAE3D;;;GAGG;AACH,SAAS,eAAe,CAAC,OAAgB;IACxC,OAAO,OAAO,CAAC,KAAK;SAClB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SACjE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAS;IAC/B,IAAI,EAAE;QACL,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,MAAM;QACf,0FAA0F;QAC1F,wDAAwD;QACxD,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAsB,CAAA;QAC/D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,iBAAiB,CAAA;QACpE,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,IAAI,YAAY,CAAA;QAC3E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,sBAAsB,CAAA;QACvD,MAAM,WAAW,GAAG,CAAC,cAAc,eAAe,EAAE,EAAE,YAAY,qBAAqB,EAAE,EAAE,WAAW,MAAM,EAAE,CAAC,CAAA;QAE/G,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;QAEjE,SAAS,UAAU,CAAC,cAAwB;YAC3C,OAAO,OAAO,GAAG,CAAC,GAAG,WAAW,EAAE,GAAG,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;QACtG,CAAC;QAED,OAAO;YACN,OAAO,CAAC,IAAI;gBACX,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;gBACjC,kFAAkF;gBAClF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBAEpD,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAA;gBAC5C,wFAAwF;gBACxF,uFAAuF;gBACvF,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAA;gBACvE,MAAM,OAAO,GAAG,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAA;gBAE/G,IAAI,OAAO,EAAE,CAAC;oBACb,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;oBACzC,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;oBAEtE,IAAI,CAAC,OAAO,CAAC,MAAM;wBAAE,OAAM;oBAE3B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;oBAC3E,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;oBAEnC,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,OAAO,EAAE,qCAAqC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBAClE,GAAG,CAAC,KAAK;4BACR,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;wBACpD,CAAC;qBACD,CAAC,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACP,MAAM,KAAK,GAAG,UAAU,CAAC,EAAE,CAAC,CAAA;oBAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAA;oBAE/B,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,OAAO,EAAE,oDAAoD;wBAC7D,GAAG,CAAC,KAAK;4BACR,OAAO,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,CAAA;wBACzE,CAAC;qBACD,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,0GAA0G;AAC1G,MAAM,YAAY,GAAW;IAC5B,IAAI,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACjC,KAAK,EAAE,EAAE,qBAAqB,EAAE,UAAU,EAAE;CAC5C,CAAA;AAED,eAAe,YAAY,CAAA"}
+{"version":3,"file":"headers-plugin.js","sourceRoot":"","sources":["../src/headers-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAaH,MAAM,kBAAkB,GAAG,gCAAgC,CAAA;AAE3D;;;GAGG;AACH,SAAS,eAAe,CAAC,OAAgB;IACxC,OAAO,OAAO,CAAC,KAAK;SAClB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SACjE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAS;IAC/B,IAAI,EAAE;QACL,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,MAAM;QACf,0FAA0F;QAC1F,wDAAwD;QACxD,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAsB,CAAA;QAC/D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,iBAAiB,CAAA;QACpE,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,IAAI,YAAY,CAAA;QAC3E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,sBAAsB,CAAA;QACvD,MAAM,WAAW,GAAG,CAAC,cAAc,eAAe,EAAE,EAAE,YAAY,qBAAqB,EAAE,EAAE,WAAW,MAAM,EAAE,CAAC,CAAA;QAE/G,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;QAEjE,SAAS,UAAU,CAAC,cAAwB;YAC3C,OAAO,OAAO,GAAG,CAAC,GAAG,WAAW,EAAE,GAAG,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;QACtG,CAAC;QAED,OAAO;YACN,OAAO,CAAC,IAAI;gBACX,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;gBACjC,kFAAkF;gBAClF,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;gBAEpD,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAA;gBAC5C,wFAAwF;gBACxF,uFAAuF;gBACvF,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAA;gBACvE,MAAM,OAAO,GAAG,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAA;gBAE/G,IAAI,OAAO,EAAE,CAAC;oBACb,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;oBACzC,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;oBAEtE,IAAI,CAAC,OAAO,CAAC,MAAM;wBAAE,OAAM;oBAE3B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;oBAC3E,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;oBAEnC,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,OAAO,EAAE,qCAAqC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBAClE,GAAG,CAAC,KAAK;4BACR,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;wBACpD,CAAC;qBACD,CAAC,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACP,MAAM,KAAK,GAAG,UAAU,CAAC,EAAE,CAAC,CAAA;oBAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAA;oBAE/B,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,OAAO,EAAE,oDAAoD;wBAC7D,GAAG,CAAC,KAAK;4BACR,OAAO,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,CAAA;wBACzE,CAAC;qBACD,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED;;GAEG;AACH,MAAM,YAAY,GAAW;IAC5B,IAAI,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE;IACjC,KAAK,EAAE,EAAE,qBAAqB,EAAE,UAAU,EAAE;CAC5C,CAAA;AAED,eAAe,YAAY,CAAA"}

package/out/index.d.ts

@@ -5,25 +5,45 @@
  * @file oxlint configuration factory for Sister Software projects.
  */
 export * from "./restrictions.js";
-/** An oxlint configuration object, as consumed by `oxlint.config.ts` / `.oxlintrc.json`. */
+/**
+ * An oxlint configuration object, as consumed by `oxlint.config.ts` / `.oxlintrc.json`.
+ */
 export type OxlintConfig = Record<string, unknown>;
-/** Numeric ceilings for the legibility-guardrail rules. Each is a hard ceiling, not a target. */
+/**
+ * Numeric ceilings for the legibility-guardrail rules. Each is a hard ceiling, not a target.
+ */
 export interface OxlintConfigLimits {
-    /** Maximum block nesting depth. */
+    /**
+     * Maximum block nesting depth.
+     */
     maxDepth: number;
-    /** Maximum parameters on a single function. */
+    /**
+     * Maximum parameters on a single function.
+     */
     maxParams: number;
-    /** Maximum statements in a single function body. */
+    /**
+     * Maximum statements in a single function body.
+     */
     maxStatements: number;
-    /** Maximum lines in a single function body, blank lines and comments excluded. */
+    /**
+     * Maximum lines in a single function body, blank lines and comments excluded.
+     */
     maxLinesPerFunction: number;
-    /** Maximum lines in a single file, blank lines and comments excluded. */
+    /**
+     * Maximum lines in a single file, blank lines and comments excluded.
+     */
     maxLines: number;
-    /** Maximum nested callback depth. */
+    /**
+     * Maximum nested callback depth.
+     */
     maxNestedCallbacks: number;
-    /** Maximum nested call-expression depth, e.g. `a(b(c(d())))`. */
+    /**
+     * Maximum nested call-expression depth, e.g. `a(b(c(d())))`.
+     */
     maxNestedCalls: number;
-    /** Maximum cyclomatic complexity of a single function. */
+    /**
+     * Maximum cyclomatic complexity of a single function.
+     */
     complexity: number;
 }
 /**
@@ -45,7 +65,9 @@ export interface OxlintConfigLimits {
  * toward the knee makes them do more of that job.
  */
 export declare const DefaultLimits: OxlintConfigLimits;
-/** Globs treated as test files, where the size and named-constant rules are switched off. */
+/**
+ * Globs treated as test files, where the size and named-constant rules are switched off.
+ */
 export declare const DefaultTestFilePatterns: string[];
 /**
  * Globs whose contents are emitted by a generator, not written by hand. The size ceilings are meaningless there — the
@@ -53,23 +75,55 @@ export declare const DefaultTestFilePatterns: string[];
  * applies, because generated code ships.
  */
 export declare const DefaultGeneratedFilePatterns: string[];
-/** Options for {@link createOxlintConfig}. */
+/**
+ * Globs for files JavaScript checks at runtime rather than TypeScript checking ahead of it. A JSDoc block there often
+ * IS the type annotation, and a one-line `@type` cast is the idiomatic form — so the multi-line requirement, which
+ * exists to make prose read as documentation, does not apply.
+ */
+export declare const DefaultUntypedFilePatterns: string[];
+/**
+ * Options for {@link createOxlintConfig}.
+ */
 export interface OxlintConfigOptions {
-    /** The package namespace whose runtime boundaries are enforced, e.g. `@sister.software`. */
+    /**
+     * The package namespace whose runtime boundaries are enforced, e.g. `@sister.software`.
+     */
     packageNamespace?: string;
-    /** The copyright holder stamped into file headers. */
+    /**
+     * The copyright holder stamped into file headers.
+     */
     copyrightHolder?: string;
-    /** The SPDX license identifier stamped into file headers. */
+    /**
+     * The SPDX license identifier stamped into file headers.
+     */
     spdxLicenseIdentifier?: string;
-    /** The author stamped into file headers. */
+    /**
+     * The author stamped into file headers.
+     */
     author?: string;
-    /** Enable oxlint's React plugin (off by default). */
+    /**
+     * Enable oxlint's React plugin (off by default).
+     */
     react?: boolean;
-    /** Enforce file headers via the bundled JS plugin (on by default). */
+    /**
+     * Enforce file headers via the bundled JS plugin (on by default).
+     */
     headers?: boolean;
-    /** Require a blank line before `return`/block-like statements (on by default). */
+    /**
+     * Require a blank line before `return`/block-like statements (on by default).
+     */
     padding?: boolean;
-    /** Require braces around single-statement work bodies (bare `return` exempt; on by default). */
+    /**
+     * Blank line on each side of a `console.*` call, with runs of them grouped (on by default).
+     */
+    consolePadding?: boolean;
+    /**
+     * Blank line on each side of a statement that spans lines (on by default).
+     */
+    multilineStatementPadding?: boolean;
+    /**
+     * Require braces around single-statement work bodies (bare `return` exempt; on by default).
+     */
     braces?: boolean;
     /**
      * Forbid direct `process.env` / `process.argv` access (off by default). Turn on once the project funnels those reads
@@ -91,20 +145,50 @@ export interface OxlintConfigOptions {
     constantDocs?: boolean | {
         scope?: "exported" | "screaming" | "exported-or-screaming";
     };
-    /** Rewrite explicit length comparisons to truthiness in boolean positions (on by default). */
+    /**
+     * Rewrite explicit length comparisons to truthiness in boolean positions (on by default).
+     */
     lengthTruthiness?: boolean;
-    /** Override individual legibility ceilings. Unspecified keys keep their calibrated default. */
+    /**
+     * Require JSDoc blocks to span multiple lines (on by default). Off for untyped files.
+     */
+    multilineJSDoc?: boolean;
+    /**
+     * Enforce the section-marker ladder — `----` banners become `// MARK:`, long labels are flagged, and a file with many
+     * markers is nudged toward regions and then toward being several files (on by default).
+     */
+    sectionMarkers?: boolean | {
+        maxBodyLength?: number;
+        maxRegions?: number;
+    };
+    /**
+     * Override individual legibility ceilings. Unspecified keys keep their calibrated default.
+     */
     limits?: Partial<OxlintConfigLimits>;
-    /** Replace the globs treated as test files. */
+    /**
+     * Replace the globs treated as test files.
+     */
     testFilePatterns?: string[];
-    /** Replace the globs treated as generated files, where only the size ceilings are switched off. */
+    /**
+     * Replace the globs treated as generated files, where only the size ceilings are switched off.
+     */
     generatedFilePatterns?: string[];
-    /** Override the default ignore patterns. */
+    /**
+     * Replace the globs treated as untyped, where the multi-line JSDoc requirement switches off.
+     */
+    untypedFilePatterns?: string[];
+    /**
+     * Override the default ignore patterns.
+     */
     ignorePatterns?: string[];
-    /** Extra config deep-merged last; an escape hatch for per-repo tweaks. */
+    /**
+     * Extra config deep-merged last; an escape hatch for per-repo tweaks.
+     */
     overrides?: OxlintConfig;
 }
-/** Default ignore patterns for generated/build output and vendored tooling. */
+/**
+ * Default ignore patterns for generated/build output and vendored tooling.
+ */
 export declare const DefaultIgnorePatterns: string[];
 /**
  * Builds the complete oxlint configuration for a Sister Software package.

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,cAAc,mBAAmB,CAAA;AAEjC,4FAA4F;AAC5F,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAElD,iGAAiG;AACjG,MAAM,WAAW,kBAAkB;IAClC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,oDAAoD;IACpD,aAAa,EAAE,MAAM,CAAA;IACrB,kFAAkF;IAClF,mBAAmB,EAAE,MAAM,CAAA;IAC3B,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAA;IACtB,0DAA0D;IAC1D,UAAU,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,EAAE,kBAS3B,CAAA;AAED,6FAA6F;AAC7F,eAAO,MAAM,uBAAuB,UAWnC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,UAA0E,CAAA;AAEnH,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IACnC,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,sDAAsD;IACtD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,6DAA6D;IAC7D,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,kFAAkF;IAClF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,gGAAgG;IAChG,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IACvE;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,uBAAuB,CAAA;KAAE,CAAA;IACvF,8FAA8F;IAC9F,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,+FAA+F;IAC/F,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpC,+CAA+C;IAC/C,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,mGAAmG;IACnG,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;IAChC,4CAA4C;IAC5C,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,YAAY,CAAA;CACxB;AAED,+EAA+E;AAC/E,eAAO,MAAM,qBAAqB,UAUjC,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,GAAG,YAAY,CAuUlF;AAED,eAAe,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,cAAc,mBAAmB,CAAA;AAEjC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAElD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,EAAE,kBAS3B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,UAWnC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,UAA0E,CAAA;AAEnH;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,UAAkD,CAAA;AAEzF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IACvE;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,uBAAuB,CAAA;KAAE,CAAA;IACvF;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1E;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;IAChC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,UAUjC,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,GAAG,YAAY,CA8XlF;AAED,eAAe,kBAAkB,CAAA"}