@thethracian/oxlint-config 0.2.1 → 0.3.0

package/dist/rules/require-file-doc.js

@@ -1,3 +1,6 @@
+/* -------------------------------------------------------------------------- */
+/*    File-level documentation requirement helper for custom Oxlint rules.    */
+/* -------------------------------------------------------------------------- */
 // Character code constants
 const CH_HASH = 35;
 const CH_SLASH = 47;
@@ -5,101 +8,147 @@ const CH_SPACE = 32;
 const CH_NEWLINE = 10;
 const CH_RETURN = 13;
 const CH_TAB = 9;
+const CH_ASTERISK = 42;
+const JSDOC_PREFIX_LENGTH = 3;
+const LINE_MARKER_LOOKAHEAD = 20;
+const BLOCK_MARKER_LOOKAHEAD = 15;
 // Pre-computed search strings
-const JSDOC_START = '/**';
 const JSDOC_END = '*/';
-/**
- * Extract the JSDoc file header comment from source text.
- * Skips leading shebang lines and whitespace.
- * Returns the full JSDoc block or null.
- */
-export function extractDocHeader(source) {
-    const len = source.length;
+const DIVIDER_PREFIX = '/* ';
+const DIVIDER_SUFFIX = ' */';
+const DIVIDER_LENGTH = 80;
+const DIVIDER_RULE = '/* -------------------------------------------------------------------------- */';
+const isWhitespace = (code) => code === CH_SPACE || code === CH_NEWLINE || code === CH_RETURN || code === CH_TAB;
+const skipShebangLines = (source, emptyResult) => {
     let pos = 0;
-    // Skip shebang lines
-    while (pos < len && source.charCodeAt(pos) === CH_HASH) {
-        pos = source.indexOf('\n', pos);
-        if (pos === -1) {
-            return null;
+    while (pos < source.length && source.charCodeAt(pos) === CH_HASH) {
+        const nextLine = source.indexOf('\n', pos);
+        if (nextLine === -1) {
+            return emptyResult;
         }
+        pos = nextLine + 1;
+    }
+    return pos;
+};
+const skipLeadingWhitespace = (source, start) => {
+    let pos = start;
+    while (pos < source.length && isWhitespace(source.charCodeAt(pos))) {
         pos++;
     }
-    // Skip leading whitespace
-    while (pos < len) {
-        const ch = source.charCodeAt(pos);
-        if (ch !== CH_SPACE && ch !== CH_NEWLINE && ch !== CH_RETURN && ch !== CH_TAB) {
-            break;
+    return pos;
+};
+const leadingContentPosition = (source, emptyResult) => skipLeadingWhitespace(source, skipShebangLines(source, emptyResult));
+const hasJSDocStartAt = (source, pos) => pos + 2 < source.length &&
+    source.charCodeAt(pos) === CH_SLASH &&
+    source.charCodeAt(pos + 1) === CH_ASTERISK &&
+    source.charCodeAt(pos + 2) === CH_ASTERISK;
+const lineEndAt = (source, start) => {
+    const newline = source.indexOf('\n', start);
+    if (newline === -1) {
+        return source.length;
+    }
+    return newline;
+};
+const nextLineStartAt = (source, start) => {
+    const newline = source.indexOf('\n', start);
+    if (newline === -1) {
+        return source.length;
+    }
+    return newline + 1;
+};
+const isDividerTextLine = (line) => line.length === DIVIDER_LENGTH &&
+    line.startsWith(DIVIDER_PREFIX) &&
+    line.endsWith(DIVIDER_SUFFIX);
+const isDividerRuleLine = (line) => line === DIVIDER_RULE;
+const nextDividerEnd = (source, start) => {
+    let cursor = nextLineStartAt(source, start);
+    while (cursor < source.length) {
+        const end = lineEndAt(source, cursor);
+        if (isDividerRuleLine(source.slice(cursor, end))) {
+            return end;
         }
-        pos++;
+        cursor = nextLineStartAt(source, cursor);
+    }
+    return undefined;
+};
+const dividerHeaderEnd = (source, pos) => {
+    const firstEnd = lineEndAt(source, pos);
+    if (!isDividerRuleLine(source.slice(pos, firstEnd))) {
+        return undefined;
     }
-    if (pos >= len) {
-        return null;
+    const closingDividerEnd = nextDividerEnd(source, firstEnd);
+    if (closingDividerEnd !== undefined) {
+        const body = source.slice(nextLineStartAt(source, firstEnd), closingDividerEnd);
+        if (body.split('\n').every(isDividerTextLine)) {
+            return closingDividerEnd;
+        }
+    }
+    return undefined;
+};
+const boundedEnd = (source, pos, lookahead) => {
+    if (pos + lookahead < source.length) {
+        return pos + lookahead;
     }
-    // Must be a JSDoc block comment
-    if (pos + 2 >= len ||
-        source.charCodeAt(pos) !== CH_SLASH ||
-        source.charCodeAt(pos + 1) !== 42 ||
-        source.charCodeAt(pos + 2) !== 42) {
-        return null;
+    return source.length;
+};
+const hasLineOptOutMarker = (source, pos) => {
+    const end = boundedEnd(source, pos, LINE_MARKER_LOOKAHEAD);
+    const frag = source.slice(pos, end);
+    return frag.startsWith('// @internal') || frag.startsWith('// @generated');
+};
+const hasBlockOptOutMarker = (source, pos) => pos + 2 < source.length &&
+    source.charCodeAt(pos + 2) !== CH_ASTERISK &&
+    source.slice(pos, boundedEnd(source, pos, BLOCK_MARKER_LOOKAHEAD)).startsWith('/* @internal');
+const hasOptOutMarker = (source, pos) => {
+    if (source.charCodeAt(pos) !== CH_SLASH || pos + 1 >= source.length) {
+        return false;
     }
-    // Find closing */
-    const closePos = source.indexOf(JSDOC_END, pos + 3);
-    if (closePos === -1) {
-        return null;
+    const next = source.charCodeAt(pos + 1);
+    if (next === CH_SLASH) {
+        return hasLineOptOutMarker(source, pos);
     }
-    return source.slice(pos, closePos + 2);
-}
+    if (next === CH_ASTERISK) {
+        return hasBlockOptOutMarker(source, pos);
+    }
+    return false;
+};
 /**
- * Returns true if the source file satisfies the file doc requirement.
- * Requires: JSDoc header, opt-out marker, or empty/whitespace-only.
+ * Extract the JSDoc file header comment from source text. Skips leading shebang lines and whitespace.
+ * Returns the full JSDoc block or undefined.
  */
-export default function hasRequiredFileDoc(source) {
-    const len = source.length;
-    let pos = 0;
-    // Skip shebang lines
-    while (pos < len && source.charCodeAt(pos) === CH_HASH) {
-        pos = source.indexOf('\n', pos);
-        if (pos === -1) {
-            return true;
-        }
-        pos++;
+export const extractDocHeader = (source) => {
+    const pos = leadingContentPosition(source, source.length);
+    if (pos >= source.length) {
+        return undefined;
     }
-    // Skip leading whitespace
-    while (pos < len) {
-        const ch = source.charCodeAt(pos);
-        if (ch !== CH_SPACE && ch !== CH_NEWLINE && ch !== CH_RETURN && ch !== CH_TAB) {
-            break;
-        }
-        pos++;
+    return extractDocHeaderAt(source, pos);
+};
+const extractDocHeaderAt = (source, pos) => {
+    const dividerEnd = dividerHeaderEnd(source, pos);
+    if (dividerEnd !== undefined) {
+        return source.slice(pos, dividerEnd);
     }
-    if (pos >= len) {
-        return true;
+    if (!hasJSDocStartAt(source, pos)) {
+        return undefined;
     }
-    // Opt-out markers
-    if (source.charCodeAt(pos) === CH_SLASH && pos + 1 < len) {
-        const next = source.charCodeAt(pos + 1);
-        if (next === CH_SLASH) {
-            // Line comment: check @internal or @generated
-            const end = pos + 20 < len ? pos + 20 : len;
-            const frag = source.slice(pos, end);
-            if (frag.indexOf('// @internal') === 0 || frag.indexOf('// @generated') === 0) {
-                return true;
-            }
-        }
-        else if (next === 42 && pos + 2 < len && source.charCodeAt(pos + 2) !== 42) {
-            // Block comment (not JSDoc): check @internal at start
-            const end = pos + 15 < len ? pos + 15 : len;
-            if (source.slice(pos, end).indexOf('/* @internal') === 0) {
-                return true;
-            }
-        }
+    const closePOS = source.indexOf(JSDOC_END, pos + JSDOC_PREFIX_LENGTH);
+    if (closePOS === -1) {
+        return undefined;
     }
-    // JSDoc header must be at or near file start
-    const jsdocPos = source.indexOf(JSDOC_START, pos);
-    if (jsdocPos === -1 || jsdocPos > pos + 50) {
-        return false;
+    return source.slice(pos, closePOS + 2);
+};
+/**
+ * Returns true if the source file satisfies the file doc requirement. Requires: divider header,
+ * opt-out marker, or empty/whitespace-only.
+ */
+export default function hasRequiredFileDoc(source) {
+    const pos = leadingContentPosition(source, source.length);
+    if (pos >= source.length) {
+        return true;
+    }
+    if (hasOptOutMarker(source, pos)) {
+        return true;
     }
-    // Must close
-    return source.indexOf(JSDOC_END, jsdocPos + 3) !== -1;
+    return dividerHeaderEnd(source, pos) !== undefined;
 }
 //# sourceMappingURL=require-file-doc.js.map

package/dist/rules/require-file-doc.js.map

@@ -1 +1 @@
-{"version":3,"file":"require-file-doc.js","sourceRoot":"","sources":["../../src/rules/require-file-doc.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,OAAO,GAAG,EAAE,CAAC;AACnB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,UAAU,GAAG,EAAE,CAAC;AACtB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,MAAM,GAAG,CAAC,CAAC;AAEjB,8BAA8B;AAC9B,MAAM,WAAW,GAAG,KAAK,CAAC;AAC1B,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1B,IAAI,GAAG,GAAG,CAAC,CAAC;IAEZ,qBAAqB;IACrB,OAAO,GAAG,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;QACvD,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG,EAAE,CAAC;IACR,CAAC;IAED,0BAA0B;IAC1B,OAAO,GAAG,GAAG,GAAG,EAAE,CAAC;QACjB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,UAAU,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;YAC9E,MAAM;QACR,CAAC;QACD,GAAG,EAAE,CAAC;IACR,CAAC;IAED,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,IACE,GAAG,GAAG,CAAC,IAAI,GAAG;QACd,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ;QACnC,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE;QACjC,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,EACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB;IAClB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;IACpD,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,MAAc;IACvD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1B,IAAI,GAAG,GAAG,CAAC,CAAC;IAEZ,qBAAqB;IACrB,OAAO,GAAG,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;QACvD,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QACD,GAAG,EAAE,CAAC;IACR,CAAC;IAED,0BAA0B;IAC1B,OAAO,GAAG,GAAG,GAAG,EAAE,CAAC;QACjB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,UAAU,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;YAC9E,MAAM;QACR,CAAC;QACD,GAAG,EAAE,CAAC;IACR,CAAC;IAED,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB;IAClB,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC;QACzD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QAExC,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,8CAA8C;YAC9C,MAAM,GAAG,GAAG,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACpC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9E,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,KAAK,EAAE,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YAC7E,sDAAsD;YACtD,MAAM,GAAG,GAAG,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC5C,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,6CAA6C;IAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAClD,IAAI,QAAQ,KAAK,CAAC,CAAC,IAAI,QAAQ,GAAG,GAAG,GAAG,EAAE,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,aAAa;IACb,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"require-file-doc.js","sourceRoot":"","sources":["../../src/rules/require-file-doc.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAChF,2BAA2B;AAC3B,MAAM,OAAO,GAAG,EAAE,CAAC;AACnB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,UAAU,GAAG,EAAE,CAAC;AACtB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,MAAM,GAAG,CAAC,CAAC;AACjB,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,8BAA8B;AAC9B,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,YAAY,GAChB,kFAAkF,CAAC;AAErF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE,CAC7C,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,CAAC;AAEpF,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE;IACvE,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IACtE,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACnE,GAAG,EAAE,CAAC;IACR,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE,CAC7E,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAEvE,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC/D,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM;IACvB,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ;IACnC,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW;IAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC;AAE7C,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IAC1D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IAChE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,OAAO,OAAO,GAAG,CAAC,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAClD,IAAI,CAAC,MAAM,KAAK,cAAc;IAC9B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAC/B,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;AAEhC,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,KAAK,YAAY,CAAC;AAE3E,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,KAAa,EAAsB,EAAE;IAC3E,IAAI,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,OAAO,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACjD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAsB,EAAE;IAC3E,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;QACpD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,iBAAiB,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3D,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC9C,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,SAAiB,EAAU,EAAE;IAC5E,IAAI,GAAG,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,OAAO,GAAG,GAAG,SAAS,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IACnE,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,qBAAqB,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CACpE,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM;IACvB,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW;IAC1C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,sBAAsB,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEhG,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IAC/D,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACpE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,OAAO,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;QACzB,OAAO,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAsB,EAAE;IACrE,MAAM,GAAG,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1D,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,kBAAkB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAsB,EAAE;IAC7E,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,GAAG,mBAAmB,CAAC,CAAC;IACtE,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,MAAc;IACvD,MAAM,GAAG,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1D,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,SAAS,CAAC;AACrD,CAAC"}

package/dist/rules/require-function-doc-ignored-text.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks whether a source offset is inside a comment or string literal.
+ *
+ * @internal
+ */
+export declare const isInsideIgnoredText: (source: string, pos: number) => boolean;
+//# sourceMappingURL=require-function-doc-ignored-text.d.ts.map

package/dist/rules/require-function-doc-ignored-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-function-doc-ignored-text.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"AA6EA;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,MAAM,EAAE,KAAK,MAAM,KAAG,OAMjE,CAAC"}

package/dist/rules/require-function-doc-ignored-text.js

@@ -0,0 +1,67 @@
+/* -------------------------------------------------------------------------- */
+/*          Ignored source-region helpers for exported JSDoc checks.          */
+/* -------------------------------------------------------------------------- */
+const initialState = {
+    isBlockComment: false,
+    isEscaped: false,
+    isLineComment: false,
+    quote: undefined,
+};
+const quoteCharacters = new Set(['"', "'", '`']);
+const lineCommentState = (state, char) => ({
+    ...state,
+    isLineComment: char !== '\n',
+});
+const blockCommentState = (state, char, nextChar) => ({
+    ...state,
+    isBlockComment: !(char === '*' && nextChar === '/'),
+});
+const quotedState = (state, char) => {
+    if (state.isEscaped) {
+        return { ...state, isEscaped: false };
+    }
+    if (char === '\\') {
+        return { ...state, isEscaped: true };
+    }
+    if (char === state.quote) {
+        return { ...state, quote: undefined };
+    }
+    return state;
+};
+const unquotedState = (state, char, nextChar) => {
+    if (char === '/' && nextChar === '/') {
+        return { ...state, isLineComment: true };
+    }
+    if (char === '/' && nextChar === '*') {
+        return { ...state, isBlockComment: true };
+    }
+    if (quoteCharacters.has(char)) {
+        return { ...state, quote: char };
+    }
+    return state;
+};
+const nextIgnoredState = (state, char, nextChar) => {
+    if (state.isLineComment) {
+        return lineCommentState(state, char);
+    }
+    if (state.isBlockComment) {
+        return blockCommentState(state, char, nextChar);
+    }
+    if (state.quote) {
+        return quotedState(state, char);
+    }
+    return unquotedState(state, char, nextChar);
+};
+/**
+ * Checks whether a source offset is inside a comment or string literal.
+ *
+ * @internal
+ */
+export const isInsideIgnoredText = (source, pos) => {
+    let state = initialState;
+    for (let index = 0; index < pos; index++) {
+        state = nextIgnoredState(state, source[index] ?? '', source[index + 1]);
+    }
+    return state.isBlockComment || state.isLineComment || state.quote !== undefined;
+};
+//# sourceMappingURL=require-function-doc-ignored-text.js.map

package/dist/rules/require-function-doc-ignored-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-function-doc-ignored-text.js","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAShF,MAAM,YAAY,GAAc;IAC9B,cAAc,EAAE,KAAK;IACrB,SAAS,EAAE,KAAK;IAChB,aAAa,EAAE,KAAK;IACpB,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAEjD,MAAM,gBAAgB,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAa,EAAE,CAAC,CAAC;IACvE,GAAG,KAAK;IACR,aAAa,EAAE,IAAI,KAAK,IAAI;CAC7B,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,CACxB,KAAgB,EAChB,IAAY,EACZ,QAA4B,EACjB,EAAE,CAAC,CAAC;IACf,GAAG,KAAK;IACR,cAAc,EAAE,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAa,EAAE;IAChE,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACpB,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACvC,CAAC;IACD,IAAI,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACxC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAE,QAA4B,EAAa,EAAE;IAChG,IAAI,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACrC,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACrC,OAAO,EAAE,GAAG,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;IAC5C,CAAC;IACD,IAAI,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,KAAgB,EAChB,IAAY,EACZ,QAA4B,EACjB,EAAE;IACb,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;QACxB,OAAO,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;QACzB,OAAO,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IAC1E,IAAI,KAAK,GAAG,YAAY,CAAC;IACzB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC;QACzC,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC;AAClF,CAAC,CAAC"}

package/dist/rules/require-function-doc-local-exports.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Internal helper exported for package-local composition.
+ *
+ * @internal
+ */
+export declare const isDocumentedLocalExportList: (source: string, afterExport: number, exportPOS: number, hasJSDocBefore: (source: string, declarationPOS: number) => boolean) => boolean | undefined;
+//# sourceMappingURL=require-function-doc-local-exports.d.ts.map

package/dist/rules/require-function-doc-local-exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-function-doc-local-exports.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-local-exports.ts"],"names":[],"mappings":"AA4HA;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACtC,QAAQ,MAAM,EACd,aAAa,MAAM,EACnB,WAAW,MAAM,EACjB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,OAAO,KAClE,OAAO,GAAG,SASZ,CAAC"}

package/dist/rules/require-function-doc-local-exports.js

@@ -0,0 +1,114 @@
+/* -------------------------------------------------------------------------- */
+/*     Local export-list documentation helpers for exported JSDoc checks.     */
+/* -------------------------------------------------------------------------- */
+const CHAR_CODE_OPEN_BRACE = 123;
+const CHAR_CODE_LOWER_A = 97;
+const CHAR_CODE_LOWER_Z = 122;
+const CHAR_CODE_UPPER_A = 65;
+const CHAR_CODE_UPPER_Z = 90;
+const TYPE_KEYWORD_LENGTH = 'type '.length;
+const skipWhitespace = (source, pos) => {
+    let cursor = pos;
+    while (cursor < source.length && /\s/u.test(source[cursor] ?? '')) {
+        cursor++;
+    }
+    return cursor;
+};
+const exportStatementEnd = (source, afterExport) => {
+    const semicolon = source.indexOf(';', afterExport);
+    if (semicolon === -1) {
+        return source.indexOf('\n', afterExport);
+    }
+    return semicolon;
+};
+const hasFromClauseBefore = (source, openBrace, statementEnd) => {
+    let end = statementEnd;
+    if (end === -1) {
+        end = source.length;
+    }
+    return source.slice(openBrace, end).includes(' from ');
+};
+const localExportOpenBrace = (source, afterExport) => {
+    if (source.slice(afterExport, afterExport + TYPE_KEYWORD_LENGTH) === 'type ' &&
+        afterExport + TYPE_KEYWORD_LENGTH < source.length) {
+        return skipWhitespace(source, afterExport + TYPE_KEYWORD_LENGTH);
+    }
+    return afterExport;
+};
+const localExportListBounds = (source, afterExport) => {
+    const openBrace = localExportOpenBrace(source, afterExport);
+    if (source.charCodeAt(openBrace) !== CHAR_CODE_OPEN_BRACE) {
+        return undefined;
+    }
+    const closeBrace = source.indexOf('}', openBrace);
+    if (closeBrace === -1) {
+        return undefined;
+    }
+    if (hasFromClauseBefore(source, openBrace, exportStatementEnd(source, closeBrace))) {
+        return undefined;
+    }
+    return { closeBrace, openBrace };
+};
+const localExportName = (part) => part
+    .trim()
+    .replace(/^type\s+/u, '')
+    .split(/\s+as\s+/u)[0]
+    ?.trim() ?? '';
+const localExportNames = (source, afterExport) => {
+    const bounds = localExportListBounds(source, afterExport);
+    if (!bounds) {
+        return undefined;
+    }
+    return source
+        .slice(bounds.openBrace + 1, bounds.closeBrace)
+        .split(',')
+        .map(localExportName)
+        .filter(Boolean);
+};
+const declarationNeedles = (name) => [
+    `const ${name}`,
+    `let ${name}`,
+    `var ${name}`,
+    `function ${name}`,
+    `class ${name}`,
+    `interface ${name}`,
+    `type ${name}`,
+    `enum ${name}`,
+];
+const isIdentifierBoundaryAfter = (source, pos) => {
+    if (pos >= source.length) {
+        return true;
+    }
+    const code = source.charCodeAt(pos);
+    return !((code >= CHAR_CODE_LOWER_A && code <= CHAR_CODE_LOWER_Z) ||
+        (code >= CHAR_CODE_UPPER_A && code <= CHAR_CODE_UPPER_Z));
+};
+const localDeclarationPosition = (source, name, exportPOS) => {
+    let bestPosition = -1;
+    for (const needle of declarationNeedles(name)) {
+        const pos = source.lastIndexOf(needle, exportPOS);
+        if (pos > bestPosition && isIdentifierBoundaryAfter(source, pos + needle.length)) {
+            bestPosition = pos;
+        }
+    }
+    if (bestPosition === -1) {
+        return undefined;
+    }
+    return bestPosition;
+};
+/**
+ * Internal helper exported for package-local composition.
+ *
+ * @internal
+ */
+export const isDocumentedLocalExportList = (source, afterExport, exportPOS, hasJSDocBefore) => {
+    const names = localExportNames(source, afterExport);
+    if (!names) {
+        return undefined;
+    }
+    return names.every((name) => {
+        const declarationPOS = localDeclarationPosition(source, name, exportPOS);
+        return declarationPOS !== undefined && hasJSDocBefore(source, declarationPOS);
+    });
+};
+//# sourceMappingURL=require-function-doc-local-exports.js.map

package/dist/rules/require-function-doc-local-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-function-doc-local-exports.js","sourceRoot":"","sources":["../../src/rules/require-function-doc-local-exports.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAEhF,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;AAE3C,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,GAAW,EAAU,EAAE;IAC7D,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,OAAO,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAClE,MAAM,EAAE,CAAC;IACX,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE;IACzE,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACnD,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAE,YAAoB,EAAW,EAAE;IAC/F,IAAI,GAAG,GAAG,YAAY,CAAC;IACvB,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;QACf,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE;IAC3E,IACE,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,GAAG,mBAAmB,CAAC,KAAK,OAAO;QACxE,WAAW,GAAG,mBAAmB,GAAG,MAAM,CAAC,MAAM,EACjD,CAAC;QACD,OAAO,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,mBAAmB,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,MAAc,EACd,WAAmB,EACoC,EAAE;IACzD,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,oBAAoB,EAAE,CAAC;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAClD,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,mBAAmB,CAAC,MAAM,EAAE,SAAS,EAAE,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;QACnF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE,CAC/C,IAAI;KACD,IAAI,EAAE;KACN,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;KACxB,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IACtB,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAEnB,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAiC,EAAE;IAC9F,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,MAAM;SACV,KAAK,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;SAC9C,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,eAAe,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAqB,EAAE,CAAC;IAC9D,SAAS,IAAI,EAAE;IACf,OAAO,IAAI,EAAE;IACb,OAAO,IAAI,EAAE;IACb,YAAY,IAAI,EAAE;IAClB,SAAS,IAAI,EAAE;IACf,aAAa,IAAI,EAAE;IACnB,QAAQ,IAAI,EAAE;IACd,QAAQ,IAAI,EAAE;CACf,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IACzE,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,CAAC,CACN,CAAC,IAAI,IAAI,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,CAAC;QACxD,CAAC,IAAI,IAAI,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,CAAC,CACzD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,MAAc,EACd,IAAY,EACZ,SAAiB,EACG,EAAE;IACtB,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;IACtB,KAAK,MAAM,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClD,IAAI,GAAG,GAAG,YAAY,IAAI,yBAAyB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACjF,YAAY,GAAG,GAAG,CAAC;QACrB,CAAC;IACH,CAAC;IACD,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,MAAc,EACd,WAAmB,EACnB,SAAiB,EACjB,cAAmE,EAC9C,EAAE;IACvB,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAW,EAAE;QACnC,MAAM,cAAc,GAAG,wBAAwB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QACzE,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/rules/require-function-doc.d.ts

@@ -1,23 +1,8 @@
 /**
- * Require-function-doc — ensures every exported declaration has a non-empty JSDoc comment.
+ * Checks whether exported declarations have meaningful JSDoc comments.
  *
- * Checks:
- *   - `export function`, `export class`, `export const`, `export let`, `export var`
- *   - `export default function`, `export default class`
- *   - `export type`, `export interface`, `export enum`
- *   - `export abstract class`
- *
- * Skips:
- *   - `export { ... } from ...` (re-exports)
- *   - `export * from ...` (wildcard re-exports)
- *   - `export type { ... } from ...` (type re-exports)
- *   - `export default <expression>` (not a declaration)
- *   - Non-exported declarations
- */
-/**
- * Returns true if all exported declarations have a non-empty JSDoc comment
- * preceding them. Returns false if any export is undocumented or has an
- * empty JSDoc.
+ * @param source - TypeScript source text to inspect.
+ * @returns True when every public declaration is documented or no public declarations exist.
  */
 export default function hasRequiredFunctionDocs(source: string): boolean;
 //# sourceMappingURL=require-function-doc.d.ts.map

package/dist/rules/require-function-doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"require-function-doc.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AA6JH;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CA0JvE"}
+{"version":3,"file":"require-function-doc.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc.ts"],"names":[],"mappings":"AAmiBA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAUvE"}