@sister.software/oxlint-config 10.0.0 → 11.0.0

package/out/section-marker-plugin.js

@@ -0,0 +1,234 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ * @file Four rules over the comments people use to carve a file into sections. They form one
+ *   escalation ladder, and each rung is a smaller file than the last:
+ *
+ *   1. `prefer-mark-comment` — a `----` banner becomes `// MARK: <label>` (autofixed). A banner is
+ *      three lines of decoration to carry one label.
+ *   2. `concise-section-marker` — a marker's label is a label, not a paragraph. Past the limit, the
+ *      detail belongs in the documented symbol's JSDoc or in the file's own `@file` block.
+ *   3. `prefer-region-over-marks` — past one marker, a file has sections, and sections have ENDS.
+ *      Regions fold, so a reader can collapse what they are not reading.
+ *   4. `max-regions` — past ten regions, the sections want to be files.
+ *
+ *   Rules 3 and 4 are advisory: where a section ends, and whether it should move, are judgment calls
+ *   no fixer can make. Rules 1 and 2 are not — the first has one correct rewrite, the second has a
+ *   measurable limit.
+ */
+/**
+ * A run of at least this many dashes reads as decoration rather than as prose.
+ */
+const MIN_BANNER_DASHES = 10;
+/**
+ * Default ceiling for a marker's label, in characters.
+ */
+const DEFAULT_MAX_BODY_LENGTH = 60;
+/**
+ * Default region ceiling. The rule fires past it, so the eleventh region is the one that trips it.
+ *
+ * Deliberately high. A file with four well-named regions is usually fine — data plus the operations on it, where
+ * splitting would separate a type from its helpers. This is a runaway detector, not a style nudge: past ten sections a
+ * file is doing too many jobs by any reading.
+ */
+const DEFAULT_MAX_REGIONS = 10;
+/**
+ * A line that is nothing but a comment marker and a rule of dashes.
+ */
+const BANNER_SEPARATOR = new RegExp(String.raw `^[ \t]*//[ \t]*-{${MIN_BANNER_DASHES},}[ \t]*$`);
+/**
+ * `// MARK: label`, with the leading dash Xcode allows (`// MARK: - label`) folded away.
+ */
+const MARK_COMMENT = /^[ \t]*\/\/[ \t]*MARK:[ \t]*-?[ \t]*(.*)$/;
+/**
+ * `//#region label` — the space after `//` is optional, which is how most editors emit it.
+ */
+const REGION_COMMENT = /^[ \t]*\/\/[ \t]*#region\b[ \t]*(.*)$/;
+/**
+ * Strip a line comment's `//` and the space that conventionally follows it.
+ */
+function commentBody(line) {
+    return line
+        .trim()
+        .replace(/^\/\/[ \t]?/, "")
+        .trim();
+}
+/**
+ * Scan for banner blocks: a separator line, one or more comment lines, then another separator. Blocks are matched on
+ * raw lines rather than on the comment list because a banner is a visual construct — what makes it one is that the
+ * lines are adjacent, which the AST does not model.
+ */
+function findBanners(lines) {
+    const banners = [];
+    let i = 0;
+    while (i < lines.length) {
+        if (!BANNER_SEPARATOR.test(lines[i])) {
+            i++;
+            continue;
+        }
+        let end = i + 1;
+        const body = [];
+        while (end < lines.length && lines[end].trim().startsWith("//") && !BANNER_SEPARATOR.test(lines[end])) {
+            body.push(commentBody(lines[end]));
+            end++;
+        }
+        if (body.length && end < lines.length && BANNER_SEPARATOR.test(lines[end])) {
+            banners.push({ startLine: i, endLine: end, body, indent: /^[ \t]*/.exec(lines[i])[0] });
+            i = end + 1;
+            continue;
+        }
+        i = end;
+    }
+    return banners;
+}
+/**
+ * Byte offset of the first character of a zero-based line.
+ */
+function offsetOfLine(lines, line) {
+    let offset = 0;
+    for (let i = 0; i < line; i++) {
+        offset += lines[i].length + 1;
+    }
+    return offset;
+}
+/**
+ * Every line comment in the file, paired with its label under `pattern`.
+ */
+function markersMatching(sourceCode, text, pattern) {
+    const found = [];
+    for (const comment of sourceCode.getAllComments()) {
+        if (comment.type !== "Line")
+            continue;
+        const match = pattern.exec(text.slice(comment.range[0], comment.range[1]));
+        if (match) {
+            found.push({ comment, label: match[1].trim() });
+        }
+    }
+    return found;
+}
+/**
+ * Shared preamble: the source text and its lines, which every rule here walks.
+ */
+function read(context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode();
+    const text = sourceCode.getText();
+    return { sourceCode, text, lines: text.split("\n") };
+}
+export const preferMarkCommentRule = {
+    meta: {
+        name: "prefer-mark-comment",
+        type: "suggestion",
+        fixable: "code",
+        schema: [{ type: "object", additionalProperties: true }],
+    },
+    create(context) {
+        const { text, lines } = read(context);
+        return {
+            Program() {
+                for (const banner of findBanners(lines)) {
+                    const start = offsetOfLine(lines, banner.startLine);
+                    const end = offsetOfLine(lines, banner.endLine) + lines[banner.endLine].length;
+                    const node = { type: "Line", range: [start, end] };
+                    // A banner wrapping real prose is a comment someone wrote, not decoration around a
+                    // label. Collapsing it would delete the prose, so say what to do and leave it alone.
+                    if (banner.body.length > 1) {
+                        context.report({
+                            node,
+                            message: "Banner comment: keep the prose in a JSDoc block on what it describes, and leave a `// MARK: <label>` here.",
+                        });
+                        continue;
+                    }
+                    const label = banner.body[0];
+                    context.report({
+                        node,
+                        message: "Banner comment: use `// MARK: <label>`.",
+                        fix(fixer) {
+                            // The marker wants a blank line on each side. Add one only where the source is
+                            // missing it, so a correctly-spaced banner does not gain stray lines.
+                            const before = text.slice(0, start).endsWith("\n\n") || start === 0 ? "" : "\n";
+                            const after = text.slice(end).startsWith("\n\n") ? "" : "\n";
+                            return fixer.replaceTextRange([start, end], `${before}${banner.indent}// MARK: ${label}${after}`);
+                        },
+                    });
+                }
+            },
+        };
+    },
+};
+export const conciseSectionMarkerRule = {
+    meta: {
+        name: "concise-section-marker",
+        type: "suggestion",
+        schema: [{ type: "object", additionalProperties: true }],
+    },
+    create(context) {
+        const { sourceCode, text } = read(context);
+        const options = (context.options[0] ?? {});
+        const limit = options.maxBodyLength ?? DEFAULT_MAX_BODY_LENGTH;
+        return {
+            Program() {
+                const markers = [
+                    ...markersMatching(sourceCode, text, MARK_COMMENT).map((m) => ({ ...m, kind: "MARK" })),
+                    ...markersMatching(sourceCode, text, REGION_COMMENT).map((m) => ({ ...m, kind: "#region" })),
+                ];
+                for (const { comment, label, kind } of markers) {
+                    if (label.length <= limit)
+                        continue;
+                    context.report({
+                        node: { type: "Line", range: comment.range },
+                        message: `${kind} label is ${label.length} characters (max ${limit}) — shorten it, move the detail into ` +
+                            "the JSDoc of what it describes, or split the file and put it in a `@file` block.",
+                    });
+                }
+            },
+        };
+    },
+};
+export const preferRegionOverMarksRule = {
+    meta: {
+        name: "prefer-region-over-marks",
+        type: "suggestion",
+        schema: [{ type: "object", additionalProperties: true }],
+    },
+    create(context) {
+        const { sourceCode, text } = read(context);
+        return {
+            Program() {
+                const marks = markersMatching(sourceCode, text, MARK_COMMENT);
+                if (marks.length < 2)
+                    return;
+                context.report({
+                    node: { type: "Line", range: marks[0].comment.range },
+                    message: `${marks.length} MARK comments in one file — give each section an END with ` +
+                        "`//#region <label>` / `//#endregion`, so a reader can fold what they are not reading.",
+                });
+            },
+        };
+    },
+};
+export const maxRegionsRule = {
+    meta: {
+        name: "max-regions",
+        type: "suggestion",
+        schema: [{ type: "object", additionalProperties: true }],
+    },
+    create(context) {
+        const { sourceCode, text } = read(context);
+        const options = (context.options[0] ?? {});
+        const limit = options.max ?? DEFAULT_MAX_REGIONS;
+        return {
+            Program() {
+                const regions = markersMatching(sourceCode, text, REGION_COMMENT);
+                if (regions.length <= limit)
+                    return;
+                context.report({
+                    node: { type: "Line", range: regions[0].comment.range },
+                    message: `${regions.length} regions in one file (max ${limit}) — a file with this many sections is ` +
+                        "several files. Split it, and let each one's `@file` block say what it is.",
+                });
+            },
+        };
+    },
+};
+//# sourceMappingURL=section-marker-plugin.js.map

package/out/section-marker-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"section-marker-plugin.js","sourceRoot":"","sources":["../src/section-marker-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH;;GAEG;AACH,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAE5B;;GAEG;AACH,MAAM,uBAAuB,GAAG,EAAE,CAAA;AAElC;;;;;;GAMG;AACH,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAE9B;;GAEG;AACH,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,oBAAoB,iBAAiB,WAAW,CAAC,CAAA;AAE/F;;GAEG;AACH,MAAM,YAAY,GAAG,2CAA2C,CAAA;AAEhE;;GAEG;AACH,MAAM,cAAc,GAAG,uCAAuC,CAAA;AAwB9D;;GAEG;AACH,SAAS,WAAW,CAAC,IAAY;IAChC,OAAO,IAAI;SACT,IAAI,EAAE;SACN,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;SAC1B,IAAI,EAAE,CAAA;AACT,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,KAAe;IACnC,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,IAAI,CAAC,GAAG,CAAC,CAAA;IAET,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;YACvC,CAAC,EAAE,CAAA;YAEH,SAAQ;QACT,CAAC;QAED,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;QACf,MAAM,IAAI,GAAa,EAAE,CAAA;QAEzB,OAAO,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAE,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,EAAE,CAAC;YACzG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,CAAC,CAAA;YAEnC,GAAG,EAAE,CAAA;QACN,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,EAAE,CAAC;YAC7E,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YACzF,CAAC,GAAG,GAAG,GAAG,CAAC,CAAA;YAEX,SAAQ;QACT,CAAC;QAED,CAAC,GAAG,GAAG,CAAA;IACR,CAAC;IAED,OAAO,OAAO,CAAA;AACf,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAe,EAAE,IAAY;IAClD,IAAI,MAAM,GAAG,CAAC,CAAA;IAEd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,OAAO,MAAM,CAAA;AACd,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CACvB,UAAsB,EACtB,IAAY,EACZ,OAAe;IAEf,MAAM,KAAK,GAA+C,EAAE,CAAA;IAE5D,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC;QACnD,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM;YAAE,SAAQ;QACrC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAE1E,IAAI,KAAK,EAAE,CAAC;YACX,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACjD,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAA;AACb,CAAC;AAED;;GAEG;AACH,SAAS,IAAI,CAAC,OAAoB;IACjC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAc,EAAE,CAAA;IACjE,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAA;IAEjC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAA;AACrD,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAS;IAC1C,IAAI,EAAE;QACL,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;QAErC,OAAO;YACN,OAAO;gBACN,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzC,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;oBACnD,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC,MAAM,CAAA;oBAC/E,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,CAAqB,EAAE,CAAA;oBAEtE,mFAAmF;oBACnF,qFAAqF;oBACrF,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC5B,OAAO,CAAC,MAAM,CAAC;4BACd,IAAI;4BACJ,OAAO,EACN,4GAA4G;yBAC7G,CAAC,CAAA;wBAEF,SAAQ;oBACT,CAAC;oBAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAE,CAAA;oBAE7B,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,OAAO,EAAE,yCAAyC;wBAClD,GAAG,CAAC,KAAK;4BACR,+EAA+E;4BAC/E,sEAAsE;4BACtE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;4BAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;4BAE5D,OAAO,KAAK,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,YAAY,KAAK,GAAG,KAAK,EAAE,CAAC,CAAA;wBAClG,CAAC;qBACD,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAS;IAC7C,IAAI,EAAE;QACL,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;QAC1C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAA+B,CAAA;QACxE,MAAM,KAAK,GAAG,OAAO,CAAC,aAAa,IAAI,uBAAuB,CAAA;QAE9D,OAAO;YACN,OAAO;gBACN,MAAM,OAAO,GAAG;oBACf,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;oBACvF,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;iBAC5F,CAAA;gBAED,KAAK,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;oBAChD,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK;wBAAE,SAAQ;oBAEnC,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE;wBAC5C,OAAO,EACN,GAAG,IAAI,aAAa,KAAK,CAAC,MAAM,oBAAoB,KAAK,uCAAuC;4BAChG,kFAAkF;qBACnF,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAS;IAC9C,IAAI,EAAE;QACL,IAAI,EAAE,0BAA0B;QAChC,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;QAE1C,OAAO;YACN,OAAO;gBACN,MAAM,KAAK,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;gBAE7D,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;oBAAE,OAAM;gBAE5B,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,KAAK,EAAE;oBACtD,OAAO,EACN,GAAG,KAAK,CAAC,MAAM,6DAA6D;wBAC5E,uFAAuF;iBACxF,CAAC,CAAA;YACH,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAS;IACnC,IAAI,EAAE;QACL,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KACxD;IACD,MAAM,CAAC,OAAO;QACb,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;QAC1C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAqB,CAAA;QAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,IAAI,mBAAmB,CAAA;QAEhD,OAAO;YACN,OAAO;gBACN,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,EAAE,cAAc,CAAC,CAAA;gBAEjE,IAAI,OAAO,CAAC,MAAM,IAAI,KAAK;oBAAE,OAAM;gBAEnC,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,KAAK,EAAE;oBACxD,OAAO,EACN,GAAG,OAAO,CAAC,MAAM,6BAA6B,KAAK,wCAAwC;wBAC3F,2EAA2E;iBAC5E,CAAC,CAAA;YACH,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA"}

package/out/threshold-plugin.d.ts

@@ -9,11 +9,17 @@
  *   `no-magic-numbers`, which cannot express it.
  */
 import type { Rule } from "./plugin-types.js";
-/** Options accepted by {@link noUnnamedThresholdRule}. */
+/**
+ * Options accepted by {@link noUnnamedThresholdRule}.
+ */
 export interface ThresholdOptions {
-    /** Values that may appear unnamed. Replaces the default list rather than extending it. */
+    /**
+     * Values that may appear unnamed. Replaces the default list rather than extending it.
+     */
     ignore?: number[];
-    /** Exempt radix-prefixed literals, which already read as codepoints or bit masks. */
+    /**
+     * Exempt radix-prefixed literals, which already read as codepoints or bit masks.
+     */
     allowHex?: boolean;
 }
 export declare const noUnnamedThresholdRule: Rule;

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

@@ -1 +1 @@
-{"version":3,"file":"threshold-plugin.d.ts","sourceRoot":"","sources":["../src/threshold-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAW,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAWtD,0DAA0D;AAC1D,MAAM,WAAW,gBAAgB;IAChC,0FAA0F;IAC1F,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,eAAO,MAAM,sBAAsB,EAAE,IA4DpC,CAAA;AAED,eAAe,sBAAsB,CAAA"}
+{"version":3,"file":"threshold-plugin.d.ts","sourceRoot":"","sources":["../src/threshold-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAW,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAiBtD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,eAAO,MAAM,sBAAsB,EAAE,IA4DpC,CAAA;AAED,eAAe,sBAAsB,CAAA"}

package/out/threshold-plugin.js

@@ -8,11 +8,17 @@
  *   table is data rather than a tuning knob. That distinction is why this exists instead of
  *   `no-magic-numbers`, which cannot express it.
  */
-/** Operators whose operands read as thresholds. */
+/**
+ * Operators whose operands read as thresholds.
+ */
 const COMPARISON_OPERATORS = new Set(["<", ">", "<=", ">=", "===", "!==", "==", "!="]);
-/** Numbers so conventional that naming them costs more clarity than it buys. */
+/**
+ * Numbers so conventional that naming them costs more clarity than it buys.
+ */
 const DEFAULT_IGNORE = [-1, 0, 1, 2, 0.5, 10, 100, 1000];
-/** Radix-prefixed literals: `0x1f`, `0b1010`, `0o777`. */
+/**
+ * Radix-prefixed literals: `0x1f`, `0b1010`, `0o777`.
+ */
 const RADIX_PREFIXED = /^0[xXbBoO]/;
 export const noUnnamedThresholdRule = {
     meta: {

package/out/threshold-plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"threshold-plugin.js","sourceRoot":"","sources":["../src/threshold-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,mDAAmD;AACnD,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAEtF,gFAAgF;AAChF,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;AAExD,0DAA0D;AAC1D,MAAM,cAAc,GAAG,YAAY,CAAA;AAUnC,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,CAAqB,CAAA;QAC9D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAA;QAEzC,SAAS,KAAK,CAAC,OAA4B;YAC1C,IAAI,CAAC,OAAO;gBAAE,OAAM;YAEpB,IAAI,OAAO,GAAG,OAAO,CAAA;YACrB,IAAI,IAAI,GAAG,CAAC,CAAA;YAEZ,8DAA8D;YAC9D,IAAI,OAAO,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACxC,IAAI,OAAO,CAAC,QAAQ,KAAK,GAAG,IAAI,OAAO,CAAC,QAAQ,KAAK,GAAG;oBAAE,OAAM;gBAEhE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAAE,OAAM;gBAE7B,IAAI,GAAG,OAAO,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;gBACxC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAA;YAC3B,CAAC;YAED,2FAA2F;YAC3F,gCAAgC;YAChC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB;gBAAE,OAAM;YAE3E,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;gBAAE,OAAM;YAE7C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEhD,6EAA6E;YAC7E,IAAI,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAM;YAEhD,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAM;YAE5C,sFAAsF;YACtF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;YAE3C,OAAO,CAAC,MAAM,CAAC;gBACd,IAAI,EAAE,OAAO;gBACb,OAAO,EACN,uBAAuB,KAAK,sEAAsE;oBAClG,8CAA8C;aAC/C,CAAC,CAAA;QACH,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAAE,OAAM;gBAEtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAChB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClB,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,eAAe,sBAAsB,CAAA"}
+{"version":3,"file":"threshold-plugin.js","sourceRoot":"","sources":["../src/threshold-plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH;;GAEG;AACH,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAEtF;;GAEG;AACH,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;AAExD;;GAEG;AACH,MAAM,cAAc,GAAG,YAAY,CAAA;AAgBnC,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,CAAqB,CAAA;QAC9D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAA;QAEzC,SAAS,KAAK,CAAC,OAA4B;YAC1C,IAAI,CAAC,OAAO;gBAAE,OAAM;YAEpB,IAAI,OAAO,GAAG,OAAO,CAAA;YACrB,IAAI,IAAI,GAAG,CAAC,CAAA;YAEZ,8DAA8D;YAC9D,IAAI,OAAO,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACxC,IAAI,OAAO,CAAC,QAAQ,KAAK,GAAG,IAAI,OAAO,CAAC,QAAQ,KAAK,GAAG;oBAAE,OAAM;gBAEhE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAAE,OAAM;gBAE7B,IAAI,GAAG,OAAO,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;gBACxC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAA;YAC3B,CAAC;YAED,2FAA2F;YAC3F,gCAAgC;YAChC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB;gBAAE,OAAM;YAE3E,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;gBAAE,OAAM;YAE7C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEhD,6EAA6E;YAC7E,IAAI,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAM;YAEhD,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAM;YAE5C,sFAAsF;YACtF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;YAE3C,OAAO,CAAC,MAAM,CAAC;gBACd,IAAI,EAAE,OAAO;gBACb,OAAO,EACN,uBAAuB,KAAK,sEAAsE;oBAClG,8CAA8C;aAC/C,CAAC,CAAA;QACH,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAAE,OAAM;gBAEtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAChB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClB,CAAC;SACD,CAAA;IACF,CAAC;CACD,CAAA;AAED,eAAe,sBAAsB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@sister.software/oxlint-config",
- "version": "10.0.0",
+ "version": "11.0.0",
  "description": "Sister Software's oxlint config",
  "license": "AGPL-3.0",
  "author": "teffen@sister.software",

package/src/browser-globals.ts

@@ -0,0 +1,77 @@
+/**
+ * @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",
+] as const
+
+export function restrictedBrowserGlobalsRule(): unknown {
+	return ["warn", ...BROWSER_GLOBALS.map((name) => ({ name, message: `Ambiguous: did you mean \`window.${name}\`?` }))]
+}

package/src/console-padding-plugin.ts

@@ -0,0 +1,76 @@
+/**
+ * @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"
+import type { AstNode, Rule } from "./plugin-types.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: AstNode | undefined): boolean {
+	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: Rule = {
+	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: AstNode) {
+				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.")
+				}
+			},
+		}
+	},
+}

package/src/constant-doc-plugin.ts

@@ -11,18 +11,28 @@
 
 import type { Rule } from "./plugin-types.js"
 
-/** 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"])
 
-/** 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/src/headers-plugin.ts

@@ -9,7 +9,9 @@
 
 import type { Comment, 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
@@ -96,7 +98,9 @@ export 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.
+ */
 const headerPlugin: Plugin = {
 	meta: { name: "sister-software" },
 	rules: { "require-file-header": headerRule },