@alexlit/lint-kit 126.6.0 → 126.7.0

package/packages/config-eslint/node_modules/eslint/lib/rules/object-curly-newline.js

@@ -0,0 +1,324 @@
+/**
+ * @fileoverview Rule to require or disallow line breaks inside braces.
+ * @author Toru Nagashima
+ * @deprecated in ESLint v8.53.0
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+// Schema objects.
+const OPTION_VALUE = {
+    oneOf: [
+        {
+            enum: ["always", "never"]
+        },
+        {
+            type: "object",
+            properties: {
+                multiline: {
+                    type: "boolean"
+                },
+                minProperties: {
+                    type: "integer",
+                    minimum: 0
+                },
+                consistent: {
+                    type: "boolean"
+                }
+            },
+            additionalProperties: false,
+            minProperties: 1
+        }
+    ]
+};
+
+/**
+ * Normalizes a given option value.
+ * @param {string|Object|undefined} value An option value to parse.
+ * @returns {{multiline: boolean, minProperties: number, consistent: boolean}} Normalized option object.
+ */
+function normalizeOptionValue(value) {
+    let multiline = false;
+    let minProperties = Number.POSITIVE_INFINITY;
+    let consistent = false;
+
+    if (value) {
+        if (value === "always") {
+            minProperties = 0;
+        } else if (value === "never") {
+            minProperties = Number.POSITIVE_INFINITY;
+        } else {
+            multiline = Boolean(value.multiline);
+            minProperties = value.minProperties || Number.POSITIVE_INFINITY;
+            consistent = Boolean(value.consistent);
+        }
+    } else {
+        consistent = true;
+    }
+
+    return { multiline, minProperties, consistent };
+}
+
+/**
+ * Checks if a value is an object.
+ * @param {any} value The value to check
+ * @returns {boolean} `true` if the value is an object, otherwise `false`
+ */
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+
+/**
+ * Checks if an option is a node-specific option
+ * @param {any} option The option to check
+ * @returns {boolean} `true` if the option is node-specific, otherwise `false`
+ */
+function isNodeSpecificOption(option) {
+    return isObject(option) || typeof option === "string";
+}
+
+/**
+ * Normalizes a given option value.
+ * @param {string|Object|undefined} options An option value to parse.
+ * @returns {{
+ *   ObjectExpression: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ObjectPattern: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ImportDeclaration: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ExportNamedDeclaration : {multiline: boolean, minProperties: number, consistent: boolean}
+ * }} Normalized option object.
+ */
+function normalizeOptions(options) {
+    if (isObject(options) && Object.values(options).some(isNodeSpecificOption)) {
+        return {
+            ObjectExpression: normalizeOptionValue(options.ObjectExpression),
+            ObjectPattern: normalizeOptionValue(options.ObjectPattern),
+            ImportDeclaration: normalizeOptionValue(options.ImportDeclaration),
+            ExportNamedDeclaration: normalizeOptionValue(options.ExportDeclaration)
+        };
+    }
+
+    const value = normalizeOptionValue(options);
+
+    return { ObjectExpression: value, ObjectPattern: value, ImportDeclaration: value, ExportNamedDeclaration: value };
+}
+
+/**
+ * Determines if ObjectExpression, ObjectPattern, ImportDeclaration or ExportNamedDeclaration
+ * node needs to be checked for missing line breaks
+ * @param {ASTNode} node Node under inspection
+ * @param {Object} options option specific to node type
+ * @param {Token} first First object property
+ * @param {Token} last Last object property
+ * @returns {boolean} `true` if node needs to be checked for missing line breaks
+ */
+function areLineBreaksRequired(node, options, first, last) {
+    let objectProperties;
+
+    if (node.type === "ObjectExpression" || node.type === "ObjectPattern") {
+        objectProperties = node.properties;
+    } else {
+
+        // is ImportDeclaration or ExportNamedDeclaration
+        objectProperties = node.specifiers
+            .filter(s => s.type === "ImportSpecifier" || s.type === "ExportSpecifier");
+    }
+
+    return objectProperties.length >= options.minProperties ||
+        (
+            options.multiline &&
+            objectProperties.length > 0 &&
+            first.loc.start.line !== last.loc.end.line
+        );
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../shared/types').Rule} */
+module.exports = {
+    meta: {
+        deprecated: true,
+        replacedBy: [],
+        type: "layout",
+
+        docs: {
+            description: "Enforce consistent line breaks after opening and before closing braces",
+            recommended: false,
+            url: "https://eslint.org/docs/latest/rules/object-curly-newline"
+        },
+
+        fixable: "whitespace",
+
+        schema: [
+            {
+                oneOf: [
+                    OPTION_VALUE,
+                    {
+                        type: "object",
+                        properties: {
+                            ObjectExpression: OPTION_VALUE,
+                            ObjectPattern: OPTION_VALUE,
+                            ImportDeclaration: OPTION_VALUE,
+                            ExportDeclaration: OPTION_VALUE
+                        },
+                        additionalProperties: false,
+                        minProperties: 1
+                    }
+                ]
+            }
+        ],
+
+        messages: {
+            unexpectedLinebreakBeforeClosingBrace: "Unexpected line break before this closing brace.",
+            unexpectedLinebreakAfterOpeningBrace: "Unexpected line break after this opening brace.",
+            expectedLinebreakBeforeClosingBrace: "Expected a line break before this closing brace.",
+            expectedLinebreakAfterOpeningBrace: "Expected a line break after this opening brace."
+        }
+    },
+
+    create(context) {
+        const sourceCode = context.sourceCode;
+        const normalizedOptions = normalizeOptions(context.options[0]);
+
+        /**
+         * Reports a given node if it violated this rule.
+         * @param {ASTNode} node A node to check. This is an ObjectExpression, ObjectPattern, ImportDeclaration or ExportNamedDeclaration node.
+         * @returns {void}
+         */
+        function check(node) {
+            const options = normalizedOptions[node.type];
+
+            if (
+                (node.type === "ImportDeclaration" &&
+                    !node.specifiers.some(specifier => specifier.type === "ImportSpecifier")) ||
+                (node.type === "ExportNamedDeclaration" &&
+                    !node.specifiers.some(specifier => specifier.type === "ExportSpecifier"))
+            ) {
+                return;
+            }
+
+            const openBrace = sourceCode.getFirstToken(node, token => token.value === "{");
+
+            let closeBrace;
+
+            if (node.typeAnnotation) {
+                closeBrace = sourceCode.getTokenBefore(node.typeAnnotation);
+            } else {
+                closeBrace = sourceCode.getLastToken(node, token => token.value === "}");
+            }
+
+            let first = sourceCode.getTokenAfter(openBrace, { includeComments: true });
+            let last = sourceCode.getTokenBefore(closeBrace, { includeComments: true });
+
+            const needsLineBreaks = areLineBreaksRequired(node, options, first, last);
+
+            const hasCommentsFirstToken = astUtils.isCommentToken(first);
+            const hasCommentsLastToken = astUtils.isCommentToken(last);
+
+            /*
+             * Use tokens or comments to check multiline or not.
+             * But use only tokens to check whether line breaks are needed.
+             * This allows:
+             *     var obj = { // eslint-disable-line foo
+             *         a: 1
+             *     }
+             */
+            first = sourceCode.getTokenAfter(openBrace);
+            last = sourceCode.getTokenBefore(closeBrace);
+
+            if (needsLineBreaks) {
+                if (astUtils.isTokenOnSameLine(openBrace, first)) {
+                    context.report({
+                        messageId: "expectedLinebreakAfterOpeningBrace",
+                        node,
+                        loc: openBrace.loc,
+                        fix(fixer) {
+                            if (hasCommentsFirstToken) {
+                                return null;
+                            }
+
+                            return fixer.insertTextAfter(openBrace, "\n");
+                        }
+                    });
+                }
+                if (astUtils.isTokenOnSameLine(last, closeBrace)) {
+                    context.report({
+                        messageId: "expectedLinebreakBeforeClosingBrace",
+                        node,
+                        loc: closeBrace.loc,
+                        fix(fixer) {
+                            if (hasCommentsLastToken) {
+                                return null;
+                            }
+
+                            return fixer.insertTextBefore(closeBrace, "\n");
+                        }
+                    });
+                }
+            } else {
+                const consistent = options.consistent;
+                const hasLineBreakBetweenOpenBraceAndFirst = !astUtils.isTokenOnSameLine(openBrace, first);
+                const hasLineBreakBetweenCloseBraceAndLast = !astUtils.isTokenOnSameLine(last, closeBrace);
+
+                if (
+                    (!consistent && hasLineBreakBetweenOpenBraceAndFirst) ||
+                    (consistent && hasLineBreakBetweenOpenBraceAndFirst && !hasLineBreakBetweenCloseBraceAndLast)
+                ) {
+                    context.report({
+                        messageId: "unexpectedLinebreakAfterOpeningBrace",
+                        node,
+                        loc: openBrace.loc,
+                        fix(fixer) {
+                            if (hasCommentsFirstToken) {
+                                return null;
+                            }
+
+                            return fixer.removeRange([
+                                openBrace.range[1],
+                                first.range[0]
+                            ]);
+                        }
+                    });
+                }
+                if (
+                    (!consistent && hasLineBreakBetweenCloseBraceAndLast) ||
+                    (consistent && !hasLineBreakBetweenOpenBraceAndFirst && hasLineBreakBetweenCloseBraceAndLast)
+                ) {
+                    context.report({
+                        messageId: "unexpectedLinebreakBeforeClosingBrace",
+                        node,
+                        loc: closeBrace.loc,
+                        fix(fixer) {
+                            if (hasCommentsLastToken) {
+                                return null;
+                            }
+
+                            return fixer.removeRange([
+                                last.range[1],
+                                closeBrace.range[0]
+                            ]);
+                        }
+                    });
+                }
+            }
+        }
+
+        return {
+            ObjectExpression: check,
+            ObjectPattern: check,
+            ImportDeclaration: check,
+            ExportNamedDeclaration: check
+        };
+    }
+};

package/packages/config-eslint/node_modules/eslint/lib/rules/object-curly-spacing.js

@@ -0,0 +1,311 @@
+/**
+ * @fileoverview Disallows or enforces spaces inside of object literals.
+ * @author Jamund Ferguson
+ * @deprecated in ESLint v8.53.0
+ */
+"use strict";
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../shared/types').Rule} */
+module.exports = {
+    meta: {
+        deprecated: true,
+        replacedBy: [],
+        type: "layout",
+
+        docs: {
+            description: "Enforce consistent spacing inside braces",
+            recommended: false,
+            url: "https://eslint.org/docs/latest/rules/object-curly-spacing"
+        },
+
+        fixable: "whitespace",
+
+        schema: [
+            {
+                enum: ["always", "never"]
+            },
+            {
+                type: "object",
+                properties: {
+                    arraysInObjects: {
+                        type: "boolean"
+                    },
+                    objectsInObjects: {
+                        type: "boolean"
+                    }
+                },
+                additionalProperties: false
+            }
+        ],
+
+        messages: {
+            requireSpaceBefore: "A space is required before '{{token}}'.",
+            requireSpaceAfter: "A space is required after '{{token}}'.",
+            unexpectedSpaceBefore: "There should be no space before '{{token}}'.",
+            unexpectedSpaceAfter: "There should be no space after '{{token}}'."
+        }
+    },
+
+    create(context) {
+        const spaced = context.options[0] === "always",
+            sourceCode = context.sourceCode;
+
+        /**
+         * Determines whether an option is set, relative to the spacing option.
+         * If spaced is "always", then check whether option is set to false.
+         * If spaced is "never", then check whether option is set to true.
+         * @param {Object} option The option to exclude.
+         * @returns {boolean} Whether or not the property is excluded.
+         */
+        function isOptionSet(option) {
+            return context.options[1] ? context.options[1][option] === !spaced : false;
+        }
+
+        const options = {
+            spaced,
+            arraysInObjectsException: isOptionSet("arraysInObjects"),
+            objectsInObjectsException: isOptionSet("objectsInObjects")
+        };
+
+        //--------------------------------------------------------------------------
+        // Helpers
+        //--------------------------------------------------------------------------
+
+        /**
+         * Reports that there shouldn't be a space after the first token
+         * @param {ASTNode} node The node to report in the event of an error.
+         * @param {Token} token The token to use for the report.
+         * @returns {void}
+         */
+        function reportNoBeginningSpace(node, token) {
+            const nextToken = context.sourceCode.getTokenAfter(token, { includeComments: true });
+
+            context.report({
+                node,
+                loc: { start: token.loc.end, end: nextToken.loc.start },
+                messageId: "unexpectedSpaceAfter",
+                data: {
+                    token: token.value
+                },
+                fix(fixer) {
+                    return fixer.removeRange([token.range[1], nextToken.range[0]]);
+                }
+            });
+        }
+
+        /**
+         * Reports that there shouldn't be a space before the last token
+         * @param {ASTNode} node The node to report in the event of an error.
+         * @param {Token} token The token to use for the report.
+         * @returns {void}
+         */
+        function reportNoEndingSpace(node, token) {
+            const previousToken = context.sourceCode.getTokenBefore(token, { includeComments: true });
+
+            context.report({
+                node,
+                loc: { start: previousToken.loc.end, end: token.loc.start },
+                messageId: "unexpectedSpaceBefore",
+                data: {
+                    token: token.value
+                },
+                fix(fixer) {
+                    return fixer.removeRange([previousToken.range[1], token.range[0]]);
+                }
+            });
+        }
+
+        /**
+         * Reports that there should be a space after the first token
+         * @param {ASTNode} node The node to report in the event of an error.
+         * @param {Token} token The token to use for the report.
+         * @returns {void}
+         */
+        function reportRequiredBeginningSpace(node, token) {
+            context.report({
+                node,
+                loc: token.loc,
+                messageId: "requireSpaceAfter",
+                data: {
+                    token: token.value
+                },
+                fix(fixer) {
+                    return fixer.insertTextAfter(token, " ");
+                }
+            });
+        }
+
+        /**
+         * Reports that there should be a space before the last token
+         * @param {ASTNode} node The node to report in the event of an error.
+         * @param {Token} token The token to use for the report.
+         * @returns {void}
+         */
+        function reportRequiredEndingSpace(node, token) {
+            context.report({
+                node,
+                loc: token.loc,
+                messageId: "requireSpaceBefore",
+                data: {
+                    token: token.value
+                },
+                fix(fixer) {
+                    return fixer.insertTextBefore(token, " ");
+                }
+            });
+        }
+
+        /**
+         * Determines if spacing in curly braces is valid.
+         * @param {ASTNode} node The AST node to check.
+         * @param {Token} first The first token to check (should be the opening brace)
+         * @param {Token} second The second token to check (should be first after the opening brace)
+         * @param {Token} penultimate The penultimate token to check (should be last before closing brace)
+         * @param {Token} last The last token to check (should be closing brace)
+         * @returns {void}
+         */
+        function validateBraceSpacing(node, first, second, penultimate, last) {
+            if (astUtils.isTokenOnSameLine(first, second)) {
+                const firstSpaced = sourceCode.isSpaceBetweenTokens(first, second);
+
+                if (options.spaced && !firstSpaced) {
+                    reportRequiredBeginningSpace(node, first);
+                }
+                if (!options.spaced && firstSpaced && second.type !== "Line") {
+                    reportNoBeginningSpace(node, first);
+                }
+            }
+
+            if (astUtils.isTokenOnSameLine(penultimate, last)) {
+                const shouldCheckPenultimate = (
+                    options.arraysInObjectsException && astUtils.isClosingBracketToken(penultimate) ||
+                    options.objectsInObjectsException && astUtils.isClosingBraceToken(penultimate)
+                );
+                const penultimateType = shouldCheckPenultimate && sourceCode.getNodeByRangeIndex(penultimate.range[0]).type;
+
+                const closingCurlyBraceMustBeSpaced = (
+                    options.arraysInObjectsException && penultimateType === "ArrayExpression" ||
+                    options.objectsInObjectsException && (penultimateType === "ObjectExpression" || penultimateType === "ObjectPattern")
+                ) ? !options.spaced : options.spaced;
+
+                const lastSpaced = sourceCode.isSpaceBetweenTokens(penultimate, last);
+
+                if (closingCurlyBraceMustBeSpaced && !lastSpaced) {
+                    reportRequiredEndingSpace(node, last);
+                }
+                if (!closingCurlyBraceMustBeSpaced && lastSpaced) {
+                    reportNoEndingSpace(node, last);
+                }
+            }
+        }
+
+        /**
+         * Gets '}' token of an object node.
+         *
+         * Because the last token of object patterns might be a type annotation,
+         * this traverses tokens preceded by the last property, then returns the
+         * first '}' token.
+         * @param {ASTNode} node The node to get. This node is an
+         *      ObjectExpression or an ObjectPattern. And this node has one or
+         *      more properties.
+         * @returns {Token} '}' token.
+         */
+        function getClosingBraceOfObject(node) {
+            const lastProperty = node.properties.at(-1);
+
+            return sourceCode.getTokenAfter(lastProperty, astUtils.isClosingBraceToken);
+        }
+
+        /**
+         * Reports a given object node if spacing in curly braces is invalid.
+         * @param {ASTNode} node An ObjectExpression or ObjectPattern node to check.
+         * @returns {void}
+         */
+        function checkForObject(node) {
+            if (node.properties.length === 0) {
+                return;
+            }
+
+            const first = sourceCode.getFirstToken(node),
+                last = getClosingBraceOfObject(node),
+                second = sourceCode.getTokenAfter(first, { includeComments: true }),
+                penultimate = sourceCode.getTokenBefore(last, { includeComments: true });
+
+            validateBraceSpacing(node, first, second, penultimate, last);
+        }
+
+        /**
+         * Reports a given import node if spacing in curly braces is invalid.
+         * @param {ASTNode} node An ImportDeclaration node to check.
+         * @returns {void}
+         */
+        function checkForImport(node) {
+            if (node.specifiers.length === 0) {
+                return;
+            }
+
+            let firstSpecifier = node.specifiers[0];
+            const lastSpecifier = node.specifiers.at(-1);
+
+            if (lastSpecifier.type !== "ImportSpecifier") {
+                return;
+            }
+            if (firstSpecifier.type !== "ImportSpecifier") {
+                firstSpecifier = node.specifiers[1];
+            }
+
+            const first = sourceCode.getTokenBefore(firstSpecifier),
+                last = sourceCode.getTokenAfter(lastSpecifier, astUtils.isNotCommaToken),
+                second = sourceCode.getTokenAfter(first, { includeComments: true }),
+                penultimate = sourceCode.getTokenBefore(last, { includeComments: true });
+
+            validateBraceSpacing(node, first, second, penultimate, last);
+        }
+
+        /**
+         * Reports a given export node if spacing in curly braces is invalid.
+         * @param {ASTNode} node An ExportNamedDeclaration node to check.
+         * @returns {void}
+         */
+        function checkForExport(node) {
+            if (node.specifiers.length === 0) {
+                return;
+            }
+
+            const firstSpecifier = node.specifiers[0],
+                lastSpecifier = node.specifiers.at(-1),
+                first = sourceCode.getTokenBefore(firstSpecifier),
+                last = sourceCode.getTokenAfter(lastSpecifier, astUtils.isNotCommaToken),
+                second = sourceCode.getTokenAfter(first, { includeComments: true }),
+                penultimate = sourceCode.getTokenBefore(last, { includeComments: true });
+
+            validateBraceSpacing(node, first, second, penultimate, last);
+        }
+
+        //--------------------------------------------------------------------------
+        // Public
+        //--------------------------------------------------------------------------
+
+        return {
+
+            // var {x} = y;
+            ObjectPattern: checkForObject,
+
+            // var y = {x: 'y'}
+            ObjectExpression: checkForObject,
+
+            // import {y} from 'x';
+            ImportDeclaration: checkForImport,
+
+            // export {name} from 'yo';
+            ExportNamedDeclaration: checkForExport
+        };
+
+    }
+};