@tai-kun/vp-lint-plugins 0.0.0-stage → 0.0.1

package/dist/src/rules/jsdoc-param-order.js

@@ -0,0 +1,101 @@
+import { defineRule } from "vite-plus/lint/plugins";
+import { getNodeJSDoc, getParamName, getJSDocLines, hasExampleOrFence } from "./jsdoc-utils.js";
+function getParamNameFromPattern(param) {
+    if (param.type === "Identifier") {
+        return param.name;
+    }
+    if (param.type === "AssignmentPattern") {
+        return param.left.type === "Identifier" ? param.left.name : null;
+    }
+    if (param.type === "RestElement") {
+        return param.argument.type === "Identifier" ? param.argument.name : null;
+    }
+    if (param.type === "TSParameterProperty") {
+        return getParamNameFromPattern(param.parameter);
+    }
+    return null;
+}
+function getExpectedParams(params) {
+    const names = [];
+    for (const param of params) {
+        const name = getParamNameFromPattern(param);
+        if (name === null) {
+            return null;
+        }
+        names.push(name);
+    }
+    return names;
+}
+function checkFunction(context, sourceCode, node, params) {
+    const comment = getNodeJSDoc(node, sourceCode);
+    if (comment === null) {
+        return;
+    }
+    const lines = getJSDocLines(comment, sourceCode);
+    if (lines === null || hasExampleOrFence(lines)) {
+        return;
+    }
+    const tagNames = lines
+        .filter((line) => line.tagName === "param")
+        .map((line) => getParamName(line.content));
+    if (tagNames.length === 0 || tagNames.some((name) => name === null)) {
+        return;
+    }
+    const expected = getExpectedParams(params);
+    if (expected === null || expected.length !== tagNames.length) {
+        return;
+    }
+    if (new Set(expected).size !== expected.length ||
+        new Set(tagNames).size !== tagNames.length ||
+        tagNames.some((name) => name?.includes(".") === true)) {
+        return;
+    }
+    for (const [index, name] of tagNames.entries()) {
+        if (name !== expected[index]) {
+            context.report({
+                loc: comment.loc,
+                messageId: "paramOrder",
+            });
+            return;
+        }
+    }
+}
+/**
+ * `@param` タグが関数の引数の順序に従っていることを要求します。
+ */
+const jsdocParamOrder = defineRule({
+    meta: {
+        docs: {
+            description: "Require @param tags to follow the order of function parameters.",
+        },
+        type: "suggestion",
+        messages: {
+            paramOrder: "@param tags must follow the order of function parameters.",
+        },
+    },
+    create(context) {
+        const sourceCode = context.sourceCode;
+        return {
+            MethodDefinition(node) {
+                checkFunction(context, sourceCode, node, node.value.params);
+            },
+            TSDeclareFunction(node) {
+                checkFunction(context, sourceCode, node, node.params);
+            },
+            FunctionDeclaration(node) {
+                checkFunction(context, sourceCode, node, node.params);
+            },
+            ExportNamedDeclaration(node) {
+                const declaration = node.declaration;
+                if (declaration !== null &&
+                    (declaration.type === "FunctionDeclaration" || declaration.type === "TSDeclareFunction")) {
+                    checkFunction(context, sourceCode, node, declaration.params);
+                }
+            },
+            TSAbstractMethodDefinition(node) {
+                checkFunction(context, sourceCode, node, node.value.params);
+            },
+        };
+    },
+});
+export default jsdocParamOrder;

package/dist/src/rules/jsdoc-tag-lines.d.ts

@@ -0,0 +1,6 @@
+/**
+ * description とタグ、タググループの間の空行を揃えます。
+ */
+declare const jsdocTagLines: import("vite-plus/lint/plugins").Rule;
+export default jsdocTagLines;
+//# sourceMappingURL=jsdoc-tag-lines.d.ts.map

package/dist/src/rules/jsdoc-tag-lines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc-tag-lines.d.ts","sourceRoot":"","sources":["../../../src/rules/jsdoc-tag-lines.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,QAAA,MAAM,aAAa,uCAgJjB,CAAC;eAEY,aAAa"}

package/dist/src/rules/jsdoc-tag-lines.js

@@ -0,0 +1,128 @@
+import { defineRule } from "vite-plus/lint/plugins";
+import { getJSDocLines, hasExampleOrFence } from "./jsdoc-utils.js";
+function getBlankPrefix(line) {
+    return line.prefix.trimEnd();
+}
+/**
+ * description とタグ、タググループの間の空行を揃えます。
+ */
+const jsdocTagLines = defineRule({
+    meta: {
+        docs: {
+            description: "Require consistent blank lines between JSDoc tag groups.",
+        },
+        type: "layout",
+        fixable: "whitespace",
+        messages: {
+            missingBlankLine: "Expected a blank line between JSDoc tag groups.",
+            unexpectedBlankLine: "Unexpected blank line in a JSDoc tag group.",
+        },
+    },
+    create(context) {
+        const sourceCode = context.sourceCode;
+        return {
+            "Program:exit"() {
+                for (const comment of sourceCode.getAllComments()) {
+                    if (comment.type !== "Block") {
+                        continue;
+                    }
+                    const lines = getJSDocLines(comment, sourceCode);
+                    if (lines === null || lines.length < 3 || hasExampleOrFence(lines)) {
+                        continue;
+                    }
+                    const opening = lines[0];
+                    const closing = lines.at(-1);
+                    if (opening === undefined ||
+                        closing === undefined ||
+                        opening.content.trim() !== "" ||
+                        closing.content.trim() !== "") {
+                        continue;
+                    }
+                    const contentLines = lines.slice(1, -1);
+                    const entries = [];
+                    for (const [index, line] of contentLines.entries()) {
+                        if (line.content.trim() !== "") {
+                            entries.push({
+                                line,
+                                groupId: -1,
+                                lineIndex: index,
+                            });
+                        }
+                    }
+                    if (entries.length === 0 || !entries.some((entry) => entry.line.tagName !== null)) {
+                        continue;
+                    }
+                    let firstTagIndex = -1;
+                    let currentGroup = -1;
+                    let currentTag = null;
+                    for (const [index, entry] of entries.entries()) {
+                        if (entry.line.tagName === null) {
+                            if (currentTag === null) {
+                                continue;
+                            }
+                            entry.groupId = currentGroup;
+                            continue;
+                        }
+                        if (firstTagIndex === -1) {
+                            firstTagIndex = index;
+                        }
+                        if (currentTag === null || entry.line.tagName !== currentTag) {
+                            currentGroup += 1;
+                            currentTag = entry.line.tagName;
+                        }
+                        entry.groupId = currentGroup;
+                    }
+                    if (firstTagIndex === -1) {
+                        continue;
+                    }
+                    const descriptionExists = firstTagIndex > 0;
+                    const result = [opening.raw];
+                    let previousEntry = null;
+                    let missingBlankLine = false;
+                    for (const entry of entries) {
+                        let desiredBlankLines;
+                        let originalBlankLines;
+                        if (previousEntry === null) {
+                            originalBlankLines = entry.lineIndex;
+                            desiredBlankLines = 0;
+                        }
+                        else {
+                            originalBlankLines = entry.lineIndex - previousEntry.lineIndex - 1;
+                            if (previousEntry.groupId === -1 && entry.groupId === -1) {
+                                desiredBlankLines = originalBlankLines;
+                            }
+                            else if (previousEntry.groupId === -1) {
+                                desiredBlankLines = descriptionExists ? 1 : 0;
+                            }
+                            else {
+                                desiredBlankLines = previousEntry.groupId === entry.groupId ? 0 : 1;
+                            }
+                        }
+                        if (desiredBlankLines > originalBlankLines) {
+                            missingBlankLine = true;
+                        }
+                        const blankPrefix = getBlankPrefix(entry.line);
+                        for (let count = 0; count < desiredBlankLines; count += 1) {
+                            result.push(blankPrefix);
+                        }
+                        result.push(entry.line.raw);
+                        previousEntry = entry;
+                    }
+                    result.push(closing.raw);
+                    const replacement = result.join("\n");
+                    if (replacement === sourceCode.getText(comment)) {
+                        continue;
+                    }
+                    context.report({
+                        fix(fixer) {
+                            return fixer.replaceText(comment, replacement);
+                        },
+                        loc: comment.loc,
+                        messageId: missingBlankLine ? "missingBlankLine" : "unexpectedBlankLine",
+                    });
+                }
+            },
+        };
+    },
+});
+export default jsdocTagLines;

package/dist/src/rules/jsdoc-tag-order.d.ts

@@ -0,0 +1,6 @@
+/**
+ * JSDoc のタグの順序を統一します。
+ */
+declare const jsdocTagOrder: import("vite-plus/lint/plugins").Rule;
+export default jsdocTagOrder;
+//# sourceMappingURL=jsdoc-tag-order.d.ts.map

package/dist/src/rules/jsdoc-tag-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc-tag-order.d.ts","sourceRoot":"","sources":["../../../src/rules/jsdoc-tag-order.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,QAAA,MAAM,aAAa,uCAkDjB,CAAC;eAEY,aAAa"}

package/dist/src/rules/jsdoc-tag-order.js

@@ -0,0 +1,62 @@
+import { defineRule } from "vite-plus/lint/plugins";
+import { getJSDocLines, hasExampleOrFence } from "./jsdoc-utils.js";
+const TAG_ORDER = {
+    see: 70,
+    beta: 65,
+    note: 50,
+    param: 10,
+    throws: 40,
+    default: 20,
+    returns: 30,
+    internal: 65,
+    template: 5,
+    typeParam: 5,
+    deprecated: 60,
+};
+const UNKNOWN_TAG_ORDER = 100;
+/**
+ * JSDoc のタグの順序を統一します。
+ */
+const jsdocTagOrder = defineRule({
+    meta: {
+        docs: {
+            description: "Enforce a consistent order of JSDoc tags.",
+        },
+        type: "suggestion",
+        messages: {
+            order: "JSDoc tags must be ordered as follows: @param, @default, @returns, @throws, @note, @deprecated, @see.",
+        },
+    },
+    create(context) {
+        const sourceCode = context.sourceCode;
+        return {
+            "Program:exit"() {
+                for (const comment of sourceCode.getAllComments()) {
+                    if (comment.type !== "Block") {
+                        continue;
+                    }
+                    const lines = getJSDocLines(comment, sourceCode);
+                    if (lines === null || hasExampleOrFence(lines)) {
+                        continue;
+                    }
+                    let previousOrder = null;
+                    for (const line of lines) {
+                        if (line.tagName === null) {
+                            continue;
+                        }
+                        const order = TAG_ORDER[line.tagName] ?? UNKNOWN_TAG_ORDER;
+                        if (previousOrder !== null && order < previousOrder) {
+                            context.report({
+                                loc: comment.loc,
+                                messageId: "order",
+                            });
+                            break;
+                        }
+                        previousOrder = order;
+                    }
+                }
+            },
+        };
+    },
+});
+export default jsdocTagOrder;

package/dist/src/rules/jsdoc-utils.d.ts

@@ -0,0 +1,26 @@
+import type { ESTree, Comment, SourceCode } from "vite-plus/lint/plugins";
+interface JSDocLine {
+    content: string;
+    prefix: string;
+    raw: string;
+    tagName: string | null;
+}
+declare function getTagName(text: string): string | null;
+/**
+ * `@param` 行からパラメーター名を取得します。
+ */
+declare function getParamName(content: string): string | null;
+/**
+ * JSDoc コメントの各行を返します。
+ *
+ * JSDoc でない場合や、`*` の付かない行がある場合は null を返します。
+ */
+declare function getJSDocLines(comment: Comment, sourceCode: SourceCode): JSDocLine[] | null;
+declare function hasExampleOrFence(lines: readonly JSDocLine[]): boolean;
+/**
+ * ノードに付いている JSDoc コメントを返します。
+ */
+declare function getNodeJSDoc(node: ESTree.Node, sourceCode: SourceCode): Comment | null;
+export type { JSDocLine };
+export { getTagName, getNodeJSDoc, getParamName, getJSDocLines, hasExampleOrFence };
+//# sourceMappingURL=jsdoc-utils.d.ts.map

package/dist/src/rules/jsdoc-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc-utils.d.ts","sourceRoot":"","sources":["../../../src/rules/jsdoc-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAI1E,UAAU,SAAS;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI/C;AAyBD;;GAEG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAqBpD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,GAAG,SAAS,EAAE,GAAG,IAAI,CA+DnF;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,GAAG,OAAO,CAE/D;AAcD;;GAEG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,GAAG,IAAI,CAmB/E;AAED,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/src/rules/jsdoc-utils.js

@@ -0,0 +1,132 @@
+import { isFence } from "./comment-utils.js";
+function getTagName(text) {
+    const match = /^@(?<tag>[A-Za-z][\w-]*)/u.exec(text.trimStart());
+    return match?.groups?.["tag"] ?? null;
+}
+function stripType(value) {
+    if (!value.startsWith("{")) {
+        return value;
+    }
+    let depth = 0;
+    for (let index = 0; index < value.length; index += 1) {
+        const character = value[index];
+        if (character === "{") {
+            depth += 1;
+        }
+        else if (character === "}") {
+            depth -= 1;
+            if (depth === 0) {
+                return value.slice(index + 1).trimStart();
+            }
+        }
+    }
+    return value;
+}
+/**
+ * `@param` 行からパラメーター名を取得します。
+ */
+function getParamName(content) {
+    let value = content.trimStart();
+    if (getTagName(value) !== "param") {
+        return null;
+    }
+    value = stripType(value.slice("@param".length).trimStart());
+    const match = /^(?<name>\S+)/u.exec(value);
+    const name = match?.groups?.["name"] ?? null;
+    if (name === null) {
+        return null;
+    }
+    return name
+        .replace(/^\[/u, "")
+        .replace(/\]$/u, "")
+        .replace(/^\.\.\./u, "")
+        .replace(/=.*$/u, "");
+}
+/**
+ * JSDoc コメントの各行を返します。
+ *
+ * JSDoc でない場合や、`*` の付かない行がある場合は null を返します。
+ */
+function getJSDocLines(comment, sourceCode) {
+    const raw = sourceCode.getText(comment);
+    if (!raw.startsWith("/**") || comment.type !== "Block") {
+        return null;
+    }
+    const rawLines = raw.split("\n");
+    if (rawLines.length === 1) {
+        const contentStart = 3;
+        const contentEnd = raw.lastIndexOf("*/");
+        const content = raw.slice(contentStart, contentEnd);
+        return [
+            {
+                raw,
+                prefix: raw.slice(0, contentStart),
+                content,
+                tagName: getTagName(content),
+            },
+        ];
+    }
+    const lines = [];
+    for (const [index, line] of rawLines.entries()) {
+        if (index === 0) {
+            const contentStart = 3;
+            const closeIndex = line.lastIndexOf("*/");
+            const contentEnd = closeIndex === -1 ? line.length : Math.max(contentStart, closeIndex);
+            const content = line.slice(contentStart, contentEnd);
+            lines.push({
+                raw: line,
+                prefix: line.slice(0, contentStart),
+                content,
+                tagName: getTagName(content),
+            });
+            continue;
+        }
+        const match = /^(?<prefix>\s*\*[ \t]?).*$/u.exec(line);
+        if (match === null) {
+            return null;
+        }
+        const prefix = match.groups?.["prefix"] ?? "";
+        const contentStart = prefix.length;
+        const closeIndex = line.lastIndexOf("*/");
+        const contentEnd = closeIndex === -1 ? line.length : Math.max(contentStart, closeIndex);
+        const content = line.slice(contentStart, contentEnd);
+        lines.push({
+            raw: line,
+            prefix,
+            content,
+            tagName: getTagName(content),
+        });
+    }
+    return lines;
+}
+function hasExampleOrFence(lines) {
+    return lines.some((line) => line.tagName === "example" || isFence(line.content));
+}
+function getNodeStart(node) {
+    if ("decorators" in node) {
+        const decorator = node.decorators?.[0];
+        if (decorator !== undefined) {
+            return decorator.range[0];
+        }
+    }
+    return node.range[0];
+}
+/**
+ * ノードに付いている JSDoc コメントを返します。
+ */
+function getNodeJSDoc(node, sourceCode) {
+    const start = getNodeStart(node);
+    const comment = sourceCode.getAllComments().findLast((candidate) => candidate.range[1] <= start);
+    if (comment === null || comment === undefined || comment.type !== "Block") {
+        return null;
+    }
+    if (!sourceCode.getText(comment).startsWith("/**")) {
+        return null;
+    }
+    if (sourceCode.text.slice(comment.range[1], start).trim() !== "") {
+        return null;
+    }
+    const startLine = sourceCode.getLocFromIndex(start).line;
+    return comment.loc.end.line === startLine - 1 ? comment : null;
+}
+export { getTagName, getNodeJSDoc, getParamName, getJSDocLines, hasExampleOrFence };

package/dist/src/rules/member-ordering.d.ts

@@ -0,0 +1,6 @@
+/**
+ * クラスメンバーを「static フィールド → static ブロック → インスタンスフィールド → constructor → static メソッド → インスタンスメソッド」の順に要求します。
+ */
+declare const memberOrdering: import("vite-plus/lint/plugins").Rule;
+export default memberOrdering;
+//# sourceMappingURL=member-ordering.d.ts.map

package/dist/src/rules/member-ordering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"member-ordering.d.ts","sourceRoot":"","sources":["../../../src/rules/member-ordering.ts"],"names":[],"mappings":"AAiDA;;GAEG;AACH,QAAA,MAAM,cAAc,uCAsClB,CAAC;eAEY,cAAc"}

package/dist/src/rules/member-ordering.js

@@ -0,0 +1,66 @@
+import { defineRule } from "vite-plus/lint/plugins";
+const MEMBER_GROUP_ORDER = {
+    constructor: 3,
+    "static-block": 1,
+    "static-field": 0,
+    "static-method": 4,
+    "instance-field": 2,
+    "instance-method": 5,
+};
+function getMemberGroup(member) {
+    if (member.type === "StaticBlock") {
+        return "static-block";
+    }
+    if (member.type === "TSIndexSignature") {
+        return null;
+    }
+    if (member.type === "PropertyDefinition" ||
+        member.type === "TSAbstractPropertyDefinition" ||
+        member.type === "AccessorProperty" ||
+        member.type === "TSAbstractAccessorProperty") {
+        return member.static ? "static-field" : "instance-field";
+    }
+    if (member.type === "MethodDefinition" || member.type === "TSAbstractMethodDefinition") {
+        if (member.kind === "constructor") {
+            return "constructor";
+        }
+        return member.static ? "static-method" : "instance-method";
+    }
+    return null;
+}
+/**
+ * クラスメンバーを「static フィールド → static ブロック → インスタンスフィールド → constructor → static メソッド → インスタンスメソッド」の順に要求します。
+ */
+const memberOrdering = defineRule({
+    meta: {
+        docs: {
+            description: "Require class members to be ordered as static fields, static blocks, instance fields, constructor, static methods, and instance methods.",
+        },
+        type: "suggestion",
+        messages: {
+            order: "Class members must be ordered as static fields, static blocks, instance fields, constructor, static methods, and instance methods.",
+        },
+    },
+    create(context) {
+        return {
+            ClassBody(node) {
+                let previousRank = null;
+                for (const member of node.body) {
+                    const group = getMemberGroup(member);
+                    if (group === null) {
+                        continue;
+                    }
+                    const rank = MEMBER_GROUP_ORDER[group];
+                    if (previousRank !== null && rank < previousRank) {
+                        context.report({
+                            node: member,
+                            messageId: "order",
+                        });
+                    }
+                    previousRank = rank;
+                }
+            },
+        };
+    },
+});
+export default memberOrdering;

package/dist/src/rules/object-properties-newline.d.ts

@@ -0,0 +1,9 @@
+/**
+ * プロパティーが 2 つ以上あるオブジェクトリテラルを複数行にします。
+ *
+ * Oxfmt の `objectWrap` には「プロパティー数で改行を強制する」オプションがないため、改行を挿入する最小限の fix を提供します。
+ * `objectWrap: "preserve"` と組み合わせることで、後続の Oxfmt がプロパティーごとの改行とインデントを整えます。
+ */
+declare const objectPropertiesNewline: import("vite-plus/lint/plugins").Rule;
+export default objectPropertiesNewline;
+//# sourceMappingURL=object-properties-newline.d.ts.map

package/dist/src/rules/object-properties-newline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-properties-newline.d.ts","sourceRoot":"","sources":["../../../src/rules/object-properties-newline.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,QAAA,MAAM,uBAAuB,uCAyC3B,CAAC;eAEY,uBAAuB"}

package/dist/src/rules/object-properties-newline.js

@@ -0,0 +1,47 @@
+import { defineRule } from "vite-plus/lint/plugins";
+import { getSortPlan } from "./object-sort-utils.js";
+/**
+ * プロパティーが 2 つ以上あるオブジェクトリテラルを複数行にします。
+ *
+ * Oxfmt の `objectWrap` には「プロパティー数で改行を強制する」オプションがないため、改行を挿入する最小限の fix を提供します。
+ * `objectWrap: "preserve"` と組み合わせることで、後続の Oxfmt がプロパティーごとの改行とインデントを整えます。
+ */
+const objectPropertiesNewline = defineRule({
+    meta: {
+        docs: {
+            description: "Enforce multiline object literals when they have two or more properties.",
+        },
+        type: "layout",
+        fixable: "whitespace",
+        messages: {
+            multiline: "Objects with 2 or more properties must be multiline.",
+        },
+    },
+    create(context) {
+        return {
+            ObjectExpression(node) {
+                if (node.properties.length < 2) {
+                    return;
+                }
+                // 並び替え可能なオブジェクトは sort-object-properties が複数行化も担当します。
+                if (getSortPlan(node, context.sourceCode) !== null) {
+                    return;
+                }
+                // Oxfmt は `{` の直後に改行があるかどうかで複数行を維持するため、最初のプロパティーが `{` と同じ行にある場合だけを対象にします。
+                const firstProperty = node.properties[0];
+                if (firstProperty === undefined || firstProperty.loc.start.line !== node.loc.start.line) {
+                    return;
+                }
+                context.report({
+                    fix(fixer) {
+                        // Oxfmt は `{` の直後の改行を複数行オブジェクトの目印にするため、ここでは改行を 1 つ挿入するだけで十分です。
+                        return fixer.insertTextAfterRange([node.range[0], node.range[0] + 1], "\n");
+                    },
+                    node,
+                    messageId: "multiline",
+                });
+            },
+        };
+    },
+});
+export default objectPropertiesNewline;

package/dist/src/rules/object-sort-utils.d.ts

@@ -0,0 +1,32 @@
+import type { ESTree, SourceCode } from "vite-plus/lint/plugins";
+type SortableObject = ESTree.ObjectExpression | ESTree.ObjectPattern;
+interface SortPlanOptions {
+    /**
+     * 末尾の RestElement を許可するかどうかです。
+     */
+    allowRest?: boolean;
+    /**
+     * 1 行のオブジェクトを複数行に整形するかどうかです。
+     */
+    forceMultiline?: boolean;
+}
+type SortPlan = {
+    needsFix: false;
+    replacement: null;
+} | {
+    needsFix: true;
+    replacement: string;
+};
+declare function compareNames(left: string, right: string): number;
+/**
+ * オブジェクトリテラル／オブジェクトパターンの並び替え計画を返します。
+ *
+ * - プロパティー名の長さが短い順、同じ長さなら名前順
+ * - 空行で区切られたグループ内だけで並び替え
+ * - プロパティー直上のコメントはプロパティーと一緒に移動
+ *
+ * 並び替えが安全でない場合は null を返します。
+ */
+declare function getSortPlan(node: SortableObject, sourceCode: SourceCode, options?: SortPlanOptions): SortPlan | null;
+export { getSortPlan, compareNames };
+//# sourceMappingURL=object-sort-utils.d.ts.map

package/dist/src/rules/object-sort-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-sort-utils.d.ts","sourceRoot":"","sources":["../../../src/rules/object-sort-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAW,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE1E,KAAK,cAAc,GAAG,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,aAAa,CAAC;AAIrE,UAAU,eAAe;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAYD,KAAK,QAAQ,GACT;IACE,QAAQ,EAAE,KAAK,CAAC;IAChB,WAAW,EAAE,IAAI,CAAC;CACnB,GACD;IACE,QAAQ,EAAE,IAAI,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAuEN,iBAAS,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAiBzD;AAeD;;;;;;;;GAQG;AACH,iBAAS,WAAW,CAClB,IAAI,EAAE,cAAc,EACpB,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,eAAoB,GAC5B,QAAQ,GAAG,IAAI,CAwLjB;AAED,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC"}