@thethracian/oxlint-config 0.2.0 → 0.3.0

package/dist/codemods/comment-format.js

@@ -0,0 +1,100 @@
+/* -------------------------------------------------------------------------- */
+/*          Reusable comment formatting helpers for codemod output.           */
+/* -------------------------------------------------------------------------- */
+const dividerLength = 80;
+const dividerFiller = '-';
+const jsdocTextWidth = 100;
+const blockLeft = '/* ';
+const blockRight = ' */';
+const jsdocOpen = '/**';
+const jsdocClose = ' */';
+const repeat = (value, count) => value.repeat(Math.max(0, count));
+const dividerInnerWidth = () => dividerLength - blockLeft.length - blockRight.length;
+const solidDividerLine = () => `${blockLeft}${repeat(dividerFiller, dividerInnerWidth())}${blockRight}`;
+const centeredText = (text, width) => {
+    const remaining = Math.max(0, width - text.length);
+    const left = Math.floor(remaining / 2);
+    const right = remaining - left;
+    return `${repeat(' ', left)}${text}${repeat(' ', right)}`;
+};
+const capitalizedDividerText = (text) => {
+    const trimmed = text.trimStart();
+    const indent = text.slice(0, text.length - trimmed.length);
+    return `${indent}${trimmed.charAt(0).toUpperCase()}${trimmed.slice(1)}`;
+};
+const centeredDividerText = (text) => centeredText(capitalizedDividerText(text), dividerInnerWidth());
+const dividerTextLines = (text) => wrapTextToWidth(text, dividerInnerWidth());
+const nextWrappedLine = (line, word) => {
+    if (line) {
+        return `${line} ${word}`;
+    }
+    return word;
+};
+const wrapText = (text) => wrapTextToWidth(text, jsdocTextWidth);
+const wrapTextToWidth = (text, width) => {
+    if (text.length <= width) {
+        return [text];
+    }
+    const lines = [];
+    let line = '';
+    for (const word of text.split(' ')) {
+        line = appendWrappedWordToWidth(lines, line, word, width);
+    }
+    if (line) {
+        lines.push(line);
+    }
+    return lines;
+};
+const appendWrappedWordToWidth = (lines, line, word, width) => {
+    const nextLine = nextWrappedLine(line, word);
+    if (nextLine.length > width && line) {
+        lines.push(line);
+        return word;
+    }
+    return nextLine;
+};
+const pushJSDocTextLines = (lines, text) => {
+    for (const wrappedLine of wrapText(text)) {
+        lines.push(` * ${wrappedLine}`);
+    }
+};
+/**
+ * Formats a classic multi-line JSDoc block.
+ *
+ * @internal
+ */
+export const formatJSDoc = (input) => {
+    const lines = [jsdocOpen];
+    pushJSDocTextLines(lines, input.summary);
+    if (input.tags && input.tags.length > 0) {
+        lines.push(' *');
+        for (const tag of input.tags) {
+            pushJSDocTextLines(lines, tag);
+        }
+    }
+    lines.push(jsdocClose);
+    return `${lines.join('\n')}\n`;
+};
+/**
+ * Formats a three-line fixed-width section header.
+ *
+ * @internal
+ */
+export const formatMainHeader = (text) => [
+    solidDividerLine(),
+    ...dividerTextLines(text).map((line) => `${blockLeft}${centeredDividerText(line)}${blockRight}`),
+    solidDividerLine(),
+].join('\n');
+/**
+ * Formats a one-line fixed-width section header.
+ *
+ * @internal
+ */
+export const formatSubheader = (text) => {
+    const words = ` ${text} `;
+    const remaining = Math.max(0, dividerInnerWidth() - words.length);
+    const left = Math.floor(remaining / 2);
+    const right = remaining - left;
+    return `${blockLeft}${repeat(dividerFiller, left)}${words}${repeat(dividerFiller, right)}${blockRight}`;
+};
+//# sourceMappingURL=comment-format.js.map

package/dist/codemods/comment-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-format.js","sourceRoot":"","sources":["../../src/codemods/comment-format.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAOhF,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,MAAM,UAAU,GAAG,KAAK,CAAC;AACzB,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,MAAM,UAAU,GAAG,KAAK,CAAC;AAEzB,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,KAAa,EAAU,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AAE1F,MAAM,iBAAiB,GAAG,GAAW,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;AAE7F,MAAM,gBAAgB,GAAG,GAAW,EAAE,CACpC,GAAG,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,iBAAiB,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC;AAE3E,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE;IAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC/B,OAAO,GAAG,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,IAAY,EAAU,EAAE;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAU,EAAE,CACnD,YAAY,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAElE,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAY,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAEhG,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,IAAY,EAAU,EAAE;IAC7D,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IAC3B,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAY,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;AAEnF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,KAAa,EAAY,EAAE;IAChE,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,GAAG,wBAAwB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,KAAe,EACf,IAAY,EACZ,IAAY,EACZ,KAAa,EACL,EAAE;IACV,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,IAAI,QAAQ,CAAC,MAAM,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,KAAe,EAAE,IAAY,EAAQ,EAAE;IACjE,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CAAC;IAClC,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAU,EAAE;IACvD,MAAM,KAAK,GAAG,CAAC,SAAS,CAAC,CAAC;IAC1B,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACvB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAU,EAAE,CACvD;IACE,gBAAgB,EAAE;IAClB,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,CAC3B,CAAC,IAAI,EAAU,EAAE,CAAC,GAAG,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,UAAU,EAAE,CAC1E;IACD,gBAAgB,EAAE;CACnB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEf;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE;IACtD,MAAM,KAAK,GAAG,IAAI,IAAI,GAAG,CAAC;IAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAClE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC/B,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,GAAG,UAAU,EAAE,CAAC;AAC1G,CAAC,CAAC"}

package/dist/codemods/explicit-return-types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Internal helper exported for package-local composition.
+ *
+ * @internal
+ */
+export declare const addVoidReturnTypes: (source: string) => string;
+//# sourceMappingURL=explicit-return-types.d.ts.map

package/dist/codemods/explicit-return-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explicit-return-types.d.ts","sourceRoot":"","sources":["../../src/codemods/explicit-return-types.ts"],"names":[],"mappings":"AA+cA;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,QAAQ,MAAM,KAAG,MACY,CAAC"}

package/dist/codemods/explicit-return-types.js

@@ -0,0 +1,350 @@
+import jscodeshift from 'jscodeshift';
+const codemodAPI = jscodeshift.withParser('ts');
+const CHAR_CODE_UPPER_A = 65;
+const CHAR_CODE_UPPER_Z = 90;
+const CAN_PREFIX_LENGTH = 3;
+const HAS_PREFIX_LENGTH = 3;
+const IS_PREFIX_LENGTH = 2;
+const SHOULD_PREFIX_LENGTH = 6;
+const isObjectRecord = (value) => typeof value === 'object' && value !== null;
+const applyReplacements = (source, replacements) => [...replacements]
+    .sort((left, right) => right.start - left.start)
+    .reduce((current, replacement) => current.slice(0, replacement.start) + replacement.text + current.slice(replacement.end), source);
+const nodeStart = (node) => {
+    if (isObjectRecord(node)) {
+        const { start } = node;
+        if (typeof start === 'number') {
+            return start;
+        }
+    }
+    throw new Error('jscodeshift node is missing a start offset');
+};
+const nodeEnd = (node) => {
+    if (isObjectRecord(node)) {
+        const { end } = node;
+        if (typeof end === 'number') {
+            return end;
+        }
+    }
+    throw new Error('jscodeshift node is missing an end offset');
+};
+const sourceForNode = (source, node) => source.slice(nodeStart(node), nodeEnd(node));
+const isExpressionLike = (value) => isObjectRecord(value) && typeof value.type === 'string';
+const isFunctionLikeNode = (node) => isObjectRecord(node) &&
+    (node.type === 'ArrowFunctionExpression' ||
+        node.type === 'FunctionDeclaration' ||
+        node.type === 'FunctionExpression' ||
+        node.type === 'ObjectMethod');
+const nestedSearch = (search) => ({
+    isRoot: false,
+    seen: search.seen,
+});
+const canScanReturnRecord = (value, search) => {
+    if (search.seen.has(value)) {
+        return false;
+    }
+    search.seen.add(value);
+    return search.isRoot || !isFunctionLikeNode(value);
+};
+const hasDirectReturnValueInRecord = (value, search) => {
+    if (!canScanReturnRecord(value, search)) {
+        return false;
+    }
+    if (value.type === 'ReturnStatement' && value.argument) {
+        return true;
+    }
+    return Object.values(value).some((entry) => hasDirectReturnValue(entry, nestedSearch(search)));
+};
+const hasDirectReturnValue = (value, search) => {
+    if (Array.isArray(value)) {
+        return value.some((entry) => hasDirectReturnValue(entry, nestedSearch(search)));
+    }
+    if (!isObjectRecord(value)) {
+        return false;
+    }
+    return hasDirectReturnValueInRecord(value, search);
+};
+const hasReturnValue = (node) => hasDirectReturnValue(node, { isRoot: true, seen: new WeakSet() });
+const isAsync = (node) => node.async === true;
+const isIdentifier = (node) => isObjectRecord(node) && node.type === 'Identifier' && typeof node.name === 'string';
+const objectPropertyName = (node) => {
+    if (!isObjectRecord(node) || node.type !== 'ObjectProperty') {
+        return undefined;
+    }
+    const { key } = node;
+    if (isIdentifier(key)) {
+        return key.name;
+    }
+    if (isObjectRecord(key) && key.type === 'StringLiteral' && typeof key.value === 'string') {
+        return key.value;
+    }
+    return undefined;
+};
+const objectPropertyValue = (node) => {
+    if (!isObjectRecord(node)) {
+        return undefined;
+    }
+    const { value } = node;
+    if (isFunctionLikeNode(value)) {
+        return value;
+    }
+    return undefined;
+};
+const functionKey = (node) => `${nodeStart(node)}:${nodeEnd(node)}`;
+const collectObjectPropertyNames = (source) => {
+    const names = new Map();
+    codemodAPI(source)
+        .find(codemodAPI.ObjectProperty)
+        .forEach((path) => {
+        const value = objectPropertyValue(path.value);
+        const name = objectPropertyName(path.value);
+        if (value && name) {
+            names.set(functionKey(value), name);
+        }
+    });
+    return names;
+};
+const hasUppercaseAt = (text, index) => {
+    const code = text.charCodeAt(index);
+    return code >= CHAR_CODE_UPPER_A && code <= CHAR_CODE_UPPER_Z;
+};
+const startsWithPredicatePrefix = (text) => (text.startsWith('has') && hasUppercaseAt(text, HAS_PREFIX_LENGTH)) ||
+    (text.startsWith('is') && hasUppercaseAt(text, IS_PREFIX_LENGTH)) ||
+    (text.startsWith('should') && hasUppercaseAt(text, SHOULD_PREFIX_LENGTH)) ||
+    (text.startsWith('can') && hasUppercaseAt(text, CAN_PREFIX_LENGTH));
+const isPredicateCall = (expression) => {
+    if (!isObjectRecord(expression)) {
+        return false;
+    }
+    const { callee } = expression;
+    if (!isObjectRecord(callee)) {
+        return false;
+    }
+    if (callee.type === 'MemberExpression' && isIdentifier(callee.property)) {
+        return callee.property.name === 'test';
+    }
+    if (callee.type === 'Identifier' && typeof callee.name === 'string') {
+        return startsWithPredicatePrefix(callee.name);
+    }
+    return false;
+};
+const isComparisonOperator = (operator) => operator === '===' ||
+    operator === '!==' ||
+    operator === '>' ||
+    operator === '>=' ||
+    operator === '<' ||
+    operator === '<=';
+const isBooleanLogicalOperator = (operator) => operator === '&&' || operator === '||';
+const expressionOperator = (expression) => {
+    if (!isObjectRecord(expression)) {
+        return undefined;
+    }
+    const { operator } = expression;
+    if (typeof operator === 'string') {
+        return operator;
+    }
+    return undefined;
+};
+const expressionSide = (expression, key) => {
+    if (!isObjectRecord(expression)) {
+        return undefined;
+    }
+    const value = expression[key];
+    if (isExpressionLike(value)) {
+        return value;
+    }
+    return undefined;
+};
+const isBooleanLogicalExpression = (expression) => {
+    const left = expressionSide(expression, 'left');
+    const right = expressionSide(expression, 'right');
+    const operator = expressionOperator(expression);
+    return Boolean(operator &&
+        isBooleanLogicalOperator(operator) &&
+        left &&
+        right &&
+        isBooleanExpression(left) &&
+        isBooleanExpression(right));
+};
+const isBooleanExpression = (expression) => {
+    if (expression.type === 'BooleanLiteral') {
+        return true;
+    }
+    if (expression.type === 'UnaryExpression' && expressionOperator(expression) === '!') {
+        return true;
+    }
+    if (expression.type === 'BinaryExpression') {
+        return isComparisonOperator(expressionOperator(expression) ?? '');
+    }
+    if (expression.type === 'LogicalExpression') {
+        return isBooleanLogicalExpression(expression);
+    }
+    return expression.type === 'CallExpression' && isPredicateCall(expression);
+};
+const primitiveLiteralReturnType = (expression) => {
+    if (expression.type === 'StringLiteral') {
+        return ': string';
+    }
+    if (expression.type === 'NumericLiteral') {
+        return ': number';
+    }
+    if (expression.type === 'BooleanLiteral') {
+        return ': boolean';
+    }
+    return undefined;
+};
+const parameterTypeText = (source, parameter) => {
+    if (parameter.type !== 'Identifier' || !isObjectRecord(parameter)) {
+        return undefined;
+    }
+    const { typeAnnotation } = parameter;
+    if (!typeAnnotation) {
+        return undefined;
+    }
+    return sourceForNode(source, typeAnnotation).trim();
+};
+const stringParameterNames = (source, node) => new Set(node.params.flatMap((parameter) => {
+    if (isIdentifier(parameter) && parameterTypeText(source, parameter) === ': string') {
+        return [parameter.name];
+    }
+    return [];
+}));
+const stringMethodName = (expression) => {
+    if (expression.type !== 'CallExpression' || !isObjectRecord(expression)) {
+        return undefined;
+    }
+    const { callee } = expression;
+    if (!isObjectRecord(callee) || callee.type !== 'MemberExpression') {
+        return undefined;
+    }
+    const { property } = callee;
+    if (!isIdentifier(property)) {
+        return undefined;
+    }
+    return property.name;
+};
+const stringMethodReceiver = (expression) => {
+    if (expression.type !== 'CallExpression' || !isObjectRecord(expression)) {
+        return undefined;
+    }
+    const { callee } = expression;
+    if (!isObjectRecord(callee) || callee.type !== 'MemberExpression') {
+        return undefined;
+    }
+    return callee.object;
+};
+const isStringReturningMethod = (name) => name === 'slice' || name === 'toLowerCase' || name === 'toUpperCase' || name === 'trim';
+const stringMethodReturnType = (source, node, expression) => {
+    if (!isStringReturningMethod(stringMethodName(expression))) {
+        return undefined;
+    }
+    const object = stringMethodReceiver(expression);
+    if (isIdentifier(object) && stringParameterNames(source, node).has(object.name)) {
+        return ': string';
+    }
+    return undefined;
+};
+const singleReturnExpression = (node) => {
+    if (node.type === 'ArrowFunctionExpression' && node.body.type !== 'BlockStatement') {
+        return node.body;
+    }
+    if (node.body.type !== 'BlockStatement' || node.body.body.length !== 1) {
+        return undefined;
+    }
+    const [statement] = node.body.body;
+    if (statement?.type !== 'ReturnStatement') {
+        return undefined;
+    }
+    return statement.argument ?? undefined;
+};
+const inferredExpressionReturnTypeText = (source, path, propertyNames) => {
+    const expression = singleReturnExpression(path.value);
+    if (!expression) {
+        return undefined;
+    }
+    if (propertyNames.get(functionKey(path.value)) === 'check' || isBooleanExpression(expression)) {
+        return ': boolean';
+    }
+    const primitiveType = primitiveLiteralReturnType(expression);
+    if (primitiveType) {
+        return primitiveType;
+    }
+    return stringMethodReturnType(source, path.value, expression);
+};
+const inferredBodyReturnTypeText = (node) => {
+    if (hasReturnValue(node)) {
+        return undefined;
+    }
+    if (isAsync(node)) {
+        return ': Promise<void>';
+    }
+    return ': void';
+};
+const inferredReturnTypeText = (source, path, propertyNames) => {
+    if (propertyNames.get(functionKey(path.value)) === 'ast') {
+        return ': Record<string, (node: object) => void>';
+    }
+    const expressionReturnType = inferredExpressionReturnTypeText(source, path, propertyNames);
+    if (expressionReturnType) {
+        return expressionReturnType;
+    }
+    if (singleReturnExpression(path.value)) {
+        return undefined;
+    }
+    return inferredBodyReturnTypeText(path.value);
+};
+const previousNonWhitespaceIndex = (source, index) => {
+    let cursor = index;
+    while (cursor > 0 && /\s/u.test(source[cursor - 1] ?? '')) {
+        cursor -= 1;
+    }
+    return cursor;
+};
+const arrowInsertionPoint = (source, node) => {
+    const bodyStart = nodeStart(node.body);
+    const arrowStart = source.lastIndexOf('=>', bodyStart);
+    if (arrowStart === -1) {
+        return previousNonWhitespaceIndex(source, bodyStart);
+    }
+    return previousNonWhitespaceIndex(source, arrowStart);
+};
+const insertionPoint = (source, node) => {
+    if (node.returnType || !node.body) {
+        return undefined;
+    }
+    if (node.type === 'ArrowFunctionExpression') {
+        return arrowInsertionPoint(source, node);
+    }
+    return previousNonWhitespaceIndex(source, nodeStart(node.body));
+};
+const replacementForFunction = (source, path, propertyNames) => {
+    const start = insertionPoint(source, path.value);
+    const returnType = inferredReturnTypeText(source, path, propertyNames);
+    if (start === undefined || !returnType) {
+        return undefined;
+    }
+    return { end: start, start, text: returnType };
+};
+const collectFunctionReplacements = (source) => {
+    const replacements = [];
+    const propertyNames = collectObjectPropertyNames(source);
+    const collect = (path) => {
+        const replacement = replacementForFunction(source, path, propertyNames);
+        if (replacement) {
+            replacements.push(replacement);
+        }
+    };
+    const root = codemodAPI(source);
+    root.find(codemodAPI.ArrowFunctionExpression).forEach(collect);
+    root.find(codemodAPI.ObjectMethod).forEach(collect);
+    root.find(codemodAPI.FunctionDeclaration).forEach(collect);
+    root.find(codemodAPI.FunctionExpression).forEach(collect);
+    return replacements;
+};
+/**
+ * Internal helper exported for package-local composition.
+ *
+ * @internal
+ */
+export const addVoidReturnTypes = (source) => applyReplacements(source, collectFunctionReplacements(source));
+//# sourceMappingURL=explicit-return-types.js.map

package/dist/codemods/explicit-return-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explicit-return-types.js","sourceRoot":"","sources":["../../src/codemods/explicit-return-types.ts"],"names":[],"mappings":"AAaA,OAAO,WAAW,MAAM,aAAa,CAAC;AAmBtC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAChD,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAC3B,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAE/B,MAAM,cAAc,GAAG,CAAC,KAAc,EAAoC,EAAE,CAC1E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AAE9C,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAE,YAAoC,EAAU,EAAE,CACzF,CAAC,GAAG,YAAY,CAAC;KACd,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;KAC/C,MAAM,CACL,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,CACvB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,EACzF,MAAM,CACP,CAAC;AAEN,MAAM,SAAS,GAAG,CAAC,IAAa,EAAU,EAAE;IAC1C,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,IAAa,EAAU,EAAE;IACxC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,IAAa,EAAU,EAAE,CAC9D,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/C,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAuB,EAAE,CAC/D,cAAc,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;AAE1D,MAAM,kBAAkB,GAAG,CAAC,IAAa,EAAwB,EAAE,CACjE,cAAc,CAAC,IAAI,CAAC;IACpB,CAAC,IAAI,CAAC,IAAI,KAAK,yBAAyB;QACtC,IAAI,CAAC,IAAI,KAAK,qBAAqB;QACnC,IAAI,CAAC,IAAI,KAAK,oBAAoB;QAClC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;AAElC,MAAM,YAAY,GAAG,CAAC,MAAoB,EAAgB,EAAE,CAAC,CAAC;IAC5D,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,MAAM,CAAC,IAAI;CAClB,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAAC,KAA8B,EAAE,MAAoB,EAAW,EAAE;IAC5F,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,4BAA4B,GAAG,CACnC,KAA8B,EAC9B,MAAoB,EACX,EAAE;IACX,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAW,EAAE,CAClD,oBAAoB,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAClD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAE,MAAoB,EAAW,EAAE;IAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAW,EAAE,CAAC,oBAAoB,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,4BAA4B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAkB,EAAW,EAAE,CACrD,oBAAoB,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,EAAE,CAAC,CAAC;AAEpE,MAAM,OAAO,GAAG,CAAC,IAAkB,EAAW,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;AAErE,MAAM,YAAY,GAAG,CAAC,IAAa,EAAsB,EAAE,CACzD,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;AAEtF,MAAM,kBAAkB,GAAG,CAAC,IAAa,EAAsB,EAAE;IAC/D,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACrB,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IACD,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QACzF,OAAO,GAAG,CAAC,KAAK,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAa,EAA4B,EAAE;IACtE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACvB,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAkB,EAAU,EAAE,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;AAE1F,MAAM,0BAA0B,GAAG,CAAC,MAAc,EAA+B,EAAE;IACjF,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,UAAU,CAAC,MAAM,CAAC;SACf,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;SAC/B,OAAO,CAAC,CAAC,IAAI,EAAQ,EAAE;QACtB,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC;IACH,CAAC,CAAC,CAAC;IACL,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,KAAa,EAAW,EAAE;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,IAAI,IAAI,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,IAAY,EAAW,EAAE,CAC1D,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACnE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAEtE,MAAM,eAAe,GAAG,CAAC,UAAmB,EAAW,EAAE;IACvD,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,kBAAkB,IAAI,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxE,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,MAAM,CAAC;IACzC,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,yBAAyB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAW,EAAE,CACzD,QAAQ,KAAK,KAAK;IAClB,QAAQ,KAAK,KAAK;IAClB,QAAQ,KAAK,GAAG;IAChB,QAAQ,KAAK,IAAI;IACjB,QAAQ,KAAK,GAAG;IAChB,QAAQ,KAAK,IAAI,CAAC;AAEpB,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAW,EAAE,CAC7D,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI,CAAC;AAEzC,MAAM,kBAAkB,GAAG,CAAC,UAAsB,EAAsB,EAAE;IACxE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;IAChC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,UAAsB,EAAE,GAAqB,EAA0B,EAAE;IAC/F,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,UAAsB,EAAW,EAAE;IACrE,MAAM,IAAI,GAAG,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAChD,OAAO,OAAO,CACZ,QAAQ;QACR,wBAAwB,CAAC,QAAQ,CAAC;QAClC,IAAI;QACJ,KAAK;QACL,mBAAmB,CAAC,IAAI,CAAC;QACzB,mBAAmB,CAAC,KAAK,CAAC,CAC3B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,UAAsB,EAAW,EAAE;IAC9D,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,iBAAiB,IAAI,kBAAkB,CAAC,UAAU,CAAC,KAAK,GAAG,EAAE,CAAC;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QAC3C,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC5C,OAAO,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,KAAK,gBAAgB,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,UAAsB,EAAsB,EAAE;IAChF,IAAI,UAAU,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACxC,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACzC,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACzC,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAE,SAAe,EAAsB,EAAE;IAChF,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,IAAkB,EAAe,EAAE,CAC/E,IAAI,GAAG,CACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAY,EAAE;IAC1C,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;QACnF,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC,CACH,CAAC;AAEJ,MAAM,gBAAgB,GAAG,CAAC,UAAsB,EAAsB,EAAE;IACtE,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,UAAsB,EAAW,EAAE;IAC/D,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,IAAwB,EAAW,EAAE,CACpE,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,aAAa,IAAI,IAAI,KAAK,aAAa,IAAI,IAAI,KAAK,MAAM,CAAC;AAE1F,MAAM,sBAAsB,GAAG,CAC7B,MAAc,EACd,IAAkB,EAClB,UAAsB,EACF,EAAE;IACtB,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;QAC3D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAChD,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAChF,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,IAAkB,EAA0B,EAAE;IAC5E,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAyB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACnF,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACnC,IAAI,SAAS,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,gCAAgC,GAAG,CACvC,MAAc,EACd,IAA2B,EAC3B,aAA0C,EACtB,EAAE;IACtB,MAAM,UAAU,GAAG,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,OAAO,IAAI,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9F,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,OAAO,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,IAAkB,EAAsB,EAAE;IAC5E,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAClB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC7B,MAAc,EACd,IAA2B,EAC3B,aAA0C,EACtB,EAAE;IACtB,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QACzD,OAAO,0CAA0C,CAAC;IACpD,CAAC;IAED,MAAM,oBAAoB,GAAG,gCAAgC,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC3F,IAAI,oBAAoB,EAAE,CAAC;QACzB,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IACD,IAAI,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IAC3E,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,OAAO,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,CAAC,CAAC;IACd,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,IAA6B,EAAU,EAAE;IACpF,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACvD,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,0BAA0B,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,0BAA0B,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,IAAkB,EAAsB,EAAE;IAChF,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAyB,EAAE,CAAC;QAC5C,OAAO,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,0BAA0B,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC7B,MAAc,EACd,IAA2B,EAC3B,aAA0C,EACjB,EAAE;IAC3B,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACvE,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,MAAc,EAAiB,EAAE;IACpE,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,aAAa,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAEzD,MAAM,OAAO,GAAG,CAAC,IAA2B,EAAQ,EAAE;QACpD,MAAM,WAAW,GAAG,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QACxE,IAAI,WAAW,EAAE,CAAC;YAChB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1D,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAU,EAAE,CAC3D,iBAAiB,CAAC,MAAM,EAAE,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/codemods/format-file-header.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Rewrites or inserts the file-level purpose header in the project divider style.
+ *
+ * @internal
+ */
+export declare const formatFileHeaderComment: (source: string, generatedDescription?: string) => string;
+//# sourceMappingURL=format-file-header.d.ts.map

package/dist/codemods/format-file-header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-file-header.d.ts","sourceRoot":"","sources":["../../src/codemods/format-file-header.ts"],"names":[],"mappings":"AA8MA;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,MAAM,EAAE,uBAAuB,MAAM,KAAG,MAOvF,CAAC"}

package/dist/codemods/format-file-header.js

@@ -0,0 +1,163 @@
+/* -------------------------------------------------------------------------- */
+/*    Codemod for rendering module-level file comments as divider headers.    */
+/* -------------------------------------------------------------------------- */
+import { formatMainHeader } from './comment-format.js';
+const jsdocOpenLength = '/**'.length;
+const jsdocCloseLength = '*/'.length;
+const tagPattern = /^@\S+/;
+const dividerTextPrefix = '/*';
+const dividerTextSuffix = '*/';
+const declarationStartPattern = /^(?:export\s+)?(?:default\s+)?(?:async\s+)?(?:abstract\s+)?(?:function|class|interface|type|enum|const|let|var)\b/u;
+const skipWhitespace = (source, start) => {
+    let cursor = start;
+    while (cursor < source.length && /\s/u.test(source[cursor] ?? '')) {
+        cursor++;
+    }
+    return cursor;
+};
+const skipShebang = (source) => {
+    if (!source.startsWith('#!')) {
+        return 0;
+    }
+    const newline = source.indexOf('\n');
+    if (newline === -1) {
+        return source.length;
+    }
+    return newline + 1;
+};
+const leadingContentPosition = (source) => skipWhitespace(source, skipShebang(source));
+const cleanJSDocLine = (line) => line
+    .trim()
+    .replace(/^\*\s?/u, '')
+    .trim();
+const headerText = (body) => {
+    const lines = body
+        .split('\n')
+        .map(cleanJSDocLine)
+        .filter((line) => line.length > 0 && !tagPattern.test(line));
+    const summary = lines.join(' ');
+    if (!summary) {
+        return undefined;
+    }
+    return summary;
+};
+const isDeclarationAfterHeader = (source, headerEnd) => declarationStartPattern.test(source.slice(headerEnd).trimStart());
+const lineEnd = (source, start) => {
+    const newline = source.indexOf('\n', start);
+    if (newline === -1) {
+        return source.length;
+    }
+    return newline;
+};
+const nextLineStart = (source, start) => {
+    const newline = source.indexOf('\n', start);
+    if (newline === -1) {
+        return source.length;
+    }
+    return newline + 1;
+};
+const dividerTextLine = (line) => line.slice(dividerTextPrefix.length, -dividerTextSuffix.length).trim();
+const isSOLIDDividerLine = (line) => {
+    if (!line.startsWith('/* ') || !line.endsWith(' */')) {
+        return false;
+    }
+    const inner = dividerTextLine(line);
+    return inner.length > 0 && isDividerFiller(inner);
+};
+const isDividerFiller = (text) => {
+    for (let index = 0; index < text.length; index++) {
+        if (text.charAt(index) !== '-') {
+            return false;
+        }
+    }
+    return true;
+};
+const dividerLineAt = (source, start) => {
+    const end = lineEnd(source, start);
+    return {
+        end,
+        line: source.slice(start, end),
+        next: nextLineStart(source, start),
+    };
+};
+const collectDividerBody = (source, cursor, textLines) => {
+    if (cursor >= source.length) {
+        return undefined;
+    }
+    const current = dividerLineAt(source, cursor);
+    if (isSOLIDDividerLine(current.line)) {
+        return {
+            end: current.end,
+            text: textLines.join(' '),
+        };
+    }
+    textLines.push(dividerTextLine(current.line));
+    return collectDividerBody(source, current.next, textLines);
+};
+const collectDividerHeader = (source, start) => {
+    const first = dividerLineAt(source, start);
+    if (!isSOLIDDividerLine(first.line)) {
+        return undefined;
+    }
+    return collectDividerBody(source, first.next, []);
+};
+const dividerHeaderReplacement = (source, start) => {
+    const header = collectDividerHeader(source, start);
+    if (!header?.text) {
+        return undefined;
+    }
+    return {
+        end: header.end,
+        text: formatMainHeader(header.text),
+    };
+};
+const jsdocHeaderReplacement = (source, start) => {
+    if (!source.startsWith('/**', start)) {
+        return undefined;
+    }
+    const close = source.indexOf('*/', start + jsdocOpenLength);
+    if (close === -1 || isDeclarationAfterHeader(source, close + jsdocCloseLength)) {
+        return undefined;
+    }
+    const text = headerText(source.slice(start + jsdocOpenLength, close));
+    if (!text) {
+        return undefined;
+    }
+    return {
+        end: close + jsdocCloseLength,
+        text: formatMainHeader(text),
+    };
+};
+const generatedHeaderReplacement = (text, start) => {
+    if (!text) {
+        return undefined;
+    }
+    return {
+        end: start,
+        text: `${formatMainHeader(text)}\n`,
+    };
+};
+const applyHeaderReplacement = (source, start, replacement) => `${source.slice(0, start)}${replacement.text}${source.slice(replacement.end)}`;
+const headerReplacement = (source, start, generatedDescription) => {
+    const replacement = dividerHeaderReplacement(source, start) ??
+        jsdocHeaderReplacement(source, start) ??
+        generatedHeaderReplacement(generatedDescription, start);
+    if (!replacement) {
+        return undefined;
+    }
+    return replacement;
+};
+/**
+ * Rewrites or inserts the file-level purpose header in the project divider style.
+ *
+ * @internal
+ */
+export const formatFileHeaderComment = (source, generatedDescription) => {
+    const start = leadingContentPosition(source);
+    const replacement = headerReplacement(source, start, generatedDescription);
+    if (!replacement) {
+        return source;
+    }
+    return applyHeaderReplacement(source, start, replacement);
+};
+//# sourceMappingURL=format-file-header.js.map