eslint-plugin-stylistic-compat
Version:
Compatibility version of @stylistic/eslint-plugin for Node.js >= 12 and ESLint v8
403 lines (398 loc) • 16.7 kB
JavaScript
'use strict';
var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/includes');
var utils = require('../utils.js');
var vendor = require('../vendor.js');
require('@babel/runtime-corejs3/core-js/object/from-entries');
require('@babel/runtime-corejs3/core-js/instance/map');
require('@babel/runtime-corejs3/core-js/instance/filter');
require('@babel/runtime-corejs3/core-js/object/entries');
require('@babel/runtime-corejs3/core-js/set');
require('@babel/runtime-corejs3/core-js/instance/flags');
require('@babel/runtime-corejs3/core-js/instance/starts-with');
require('@babel/runtime-corejs3/core-js/array/from');
require('@babel/runtime-corejs3/core-js/array/is-array');
require('@babel/runtime-corejs3/core-js/instance/concat');
require('@babel/runtime-corejs3/core-js/object/keys');
require('@babel/runtime-corejs3/core-js/instance/reduce');
require('@babel/runtime-corejs3/core-js/object/assign');
require('@babel/runtime-corejs3/core-js/instance/keys');
require('@babel/runtime-corejs3/core-js/instance/find');
require('@babel/runtime-corejs3/core-js/instance/reverse');
require('@babel/runtime-corejs3/core-js/object/define-property');
require('@babel/runtime-corejs3/core-js/instance/slice');
require('@babel/runtime-corejs3/core-js/object/create');
require('@babel/runtime-corejs3/core-js/object/freeze');
require('@babel/runtime-corejs3/core-js/instance/last-index-of');
require('@babel/runtime-corejs3/core-js/object/define-properties');
require('@babel/runtime-corejs3/core-js/instance/index-of');
require('@babel/runtime-corejs3/core-js/instance/at');
require('@babel/runtime-corejs3/core-js/symbol');
require('@babel/runtime-corejs3/core-js/symbol/iterator');
require('@babel/runtime-corejs3/core-js/parse-int');
require('@babel/runtime-corejs3/core-js/parse-float');
require('@babel/runtime-corejs3/core-js/weak-map');
require('@babel/runtime-corejs3/core-js/global-this');
require('@babel/runtime-corejs3/core-js/instance/for-each');
require('eslint/use-at-your-own-risk');
require('eslint');
require('@babel/runtime-corejs3/core-js/object/get-own-property-descriptor');
require('@babel/runtime-corejs3/core-js/map');
require('@babel/runtime-corejs3/core-js/instance/some');
require('@babel/runtime-corejs3/core-js/instance/every');
require('@babel/runtime-corejs3/core-js/instance/sort');
require('@babel/runtime-corejs3/core-js/array/of');
require('@babel/runtime-corejs3/core-js/instance/entries');
require('@babel/runtime-corejs3/core-js/instance/find-index');
require('@babel/runtime-corejs3/core-js/instance/flat');
require('@babel/runtime-corejs3/core-js/instance/values');
require('@babel/runtime-corejs3/core-js/object/get-own-property-names');
require('@babel/runtime-corejs3/core-js/number/is-finite');
require('@babel/runtime-corejs3/core-js/number/is-nan');
require('@babel/runtime-corejs3/core-js/number/parse-float');
require('@babel/runtime-corejs3/core-js/number/parse-int');
require('@babel/runtime-corejs3/core-js/object/is');
require('@babel/runtime-corejs3/core-js/object/is-extensible');
require('@babel/runtime-corejs3/core-js/object/is-frozen');
require('@babel/runtime-corejs3/core-js/object/is-sealed');
require('@babel/runtime-corejs3/core-js/object/values');
require('@babel/runtime-corejs3/core-js/string/from-code-point');
require('@babel/runtime-corejs3/core-js/string/raw');
require('@babel/runtime-corejs3/core-js/instance/code-point-at');
require('@babel/runtime-corejs3/core-js/instance/ends-with');
require('@babel/runtime-corejs3/core-js/instance/pad-end');
require('@babel/runtime-corejs3/core-js/instance/pad-start');
require('@babel/runtime-corejs3/core-js/instance/trim');
require('@babel/runtime-corejs3/core-js/instance/trim-end');
require('@babel/runtime-corejs3/core-js/instance/trim-left');
require('@babel/runtime-corejs3/core-js/instance/trim-right');
require('@babel/runtime-corejs3/core-js/instance/trim-start');
require('@babel/runtime-corejs3/core-js/symbol/for');
require('@babel/runtime-corejs3/core-js/symbol/key-for');
require('@babel/runtime-corejs3/core-js/object/prevent-extensions');
require('@babel/runtime-corejs3/core-js/object/seal');
require('@babel/runtime-corejs3/core-js/object/get-prototype-of');
require('@babel/runtime-corejs3/core-js/symbol/replace');
require('@babel/runtime-corejs3/core-js/instance/bind');
require('@babel/runtime-corejs3/core-js/instance/splice');
require('@babel/runtime-corejs3/core-js/instance/repeat');
var _baseRule = utils.createRule({
name: "object-curly-spacing",
package: "js",
meta: {
type: "layout",
docs: {
description: "Enforce consistent spacing inside braces"
},
fixable: "whitespace",
schema: [{
type: "string",
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";
const sourceCode = context.sourceCode;
function isOptionSet(option) {
return context.options[1] ? context.options[1][option] === !spaced : false;
}
const options = {
spaced,
arraysInObjectsException: isOptionSet("arraysInObjects"),
objectsInObjectsException: isOptionSet("objectsInObjects")
};
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]]);
}
});
}
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]]);
}
});
}
function reportRequiredBeginningSpace(node, token) {
context.report({
node,
loc: token.loc,
messageId: "requireSpaceAfter",
data: {
token: token.value
},
fix(fixer) {
return fixer.insertTextAfter(token, " ");
}
});
}
function reportRequiredEndingSpace(node, token) {
context.report({
node,
loc: token.loc,
messageId: "requireSpaceBefore",
data: {
token: token.value
},
fix(fixer) {
return fixer.insertTextBefore(token, " ");
}
});
}
function validateBraceSpacing(node, first, second, penultimate, last) {
if (utils.isTokenOnSameLine(first, second)) {
const firstSpaced = sourceCode.isSpaceBetween(first, second);
if (options.spaced && !firstSpaced) reportRequiredBeginningSpace(node, first);
if (!options.spaced && firstSpaced && second.type !== "Line") reportNoBeginningSpace(node, first);
}
if (utils.isTokenOnSameLine(penultimate, last)) {
const shouldCheckPenultimate = options.arraysInObjectsException && utils.isClosingBracketToken(penultimate) || options.objectsInObjectsException && utils.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.isSpaceBetween(penultimate, last);
if (closingCurlyBraceMustBeSpaced && !lastSpaced) reportRequiredEndingSpace(node, last);
if (!closingCurlyBraceMustBeSpaced && lastSpaced) reportNoEndingSpace(node, last);
}
}
function getClosingBraceOfObject(node) {
const lastProperty = node.properties[node.properties.length - 1];
return sourceCode.getTokenAfter(lastProperty, utils.isClosingBraceToken);
}
function checkForObject(node) {
if (node.properties.length === 0) return;
const first = sourceCode.getFirstToken(node);
const last = getClosingBraceOfObject(node);
const second = sourceCode.getTokenAfter(first, {
includeComments: true
});
const penultimate = sourceCode.getTokenBefore(last, {
includeComments: true
});
validateBraceSpacing(node, first, second, penultimate, last);
}
function checkForImport(node) {
if (node.specifiers.length === 0) return;
let firstSpecifier = node.specifiers[0];
const lastSpecifier = node.specifiers[node.specifiers.length - 1];
if (lastSpecifier.type !== "ImportSpecifier") return;
if (firstSpecifier.type !== "ImportSpecifier") firstSpecifier = node.specifiers[1];
const first = sourceCode.getTokenBefore(firstSpecifier);
const last = sourceCode.getTokenAfter(lastSpecifier, utils.isNotCommaToken);
const second = sourceCode.getTokenAfter(first, {
includeComments: true
});
const penultimate = sourceCode.getTokenBefore(last, {
includeComments: true
});
validateBraceSpacing(node, first, second, penultimate, last);
}
function checkForExport(node) {
if (node.specifiers.length === 0) return;
const firstSpecifier = node.specifiers[0];
const lastSpecifier = node.specifiers[node.specifiers.length - 1];
const first = sourceCode.getTokenBefore(firstSpecifier);
const last = sourceCode.getTokenAfter(lastSpecifier, utils.isNotCommaToken);
const second = sourceCode.getTokenAfter(first, {
includeComments: true
});
const penultimate = sourceCode.getTokenBefore(last, {
includeComments: true
});
validateBraceSpacing(node, first, second, penultimate, last);
}
return {
// var {x} = y;
ObjectPattern: checkForObject,
// var y = {x: 'y'}
ObjectExpression: checkForObject,
// import {y} from 'x';
ImportDeclaration: checkForImport,
// export {name} from 'yo';
ExportNamedDeclaration: checkForExport
};
}
});
const baseRule = /* @__PURE__ */utils.castRuleModule(_baseRule);
var objectCurlySpacing = utils.createRule({
name: "object-curly-spacing",
package: "ts",
meta: {
...baseRule.meta,
docs: {
description: "Enforce consistent spacing inside braces"
}
},
defaultOptions: ["never"],
create(context) {
const [firstOption, secondOption] = context.options;
const spaced = firstOption === "always";
const sourceCode = context.sourceCode || context.getSourceCode();
function isOptionSet(option) {
return secondOption ? secondOption[option] === !spaced : false;
}
const options = {
spaced,
arraysInObjectsException: isOptionSet("arraysInObjects"),
objectsInObjectsException: isOptionSet("objectsInObjects")
};
function reportNoBeginningSpace(node, token) {
const nextToken = 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]]);
}
});
}
function reportNoEndingSpace(node, token) {
const previousToken = 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]]);
}
});
}
function reportRequiredBeginningSpace(node, token) {
context.report({
node,
loc: token.loc,
messageId: "requireSpaceAfter",
data: {
token: token.value
},
fix(fixer) {
return fixer.insertTextAfter(token, " ");
}
});
}
function reportRequiredEndingSpace(node, token) {
context.report({
node,
loc: token.loc,
messageId: "requireSpaceBefore",
data: {
token: token.value
},
fix(fixer) {
return fixer.insertTextBefore(token, " ");
}
});
}
function validateBraceSpacing(node, first, second, penultimate, last) {
if (vendor.astUtilsExports.isTokenOnSameLine(first, second)) {
var _context;
const firstSpaced = sourceCode.isSpaceBetween(first, second);
const secondType = sourceCode.getNodeByRangeIndex(second.range[0]).type;
const openingCurlyBraceMustBeSpaced = options.arraysInObjectsException && _includesInstanceProperty(_context = [vendor.distExports.AST_NODE_TYPES.TSMappedType, vendor.distExports.AST_NODE_TYPES.TSIndexSignature]).call(_context, secondType) ? !options.spaced : options.spaced;
if (openingCurlyBraceMustBeSpaced && !firstSpaced) reportRequiredBeginningSpace(node, first);
if (!openingCurlyBraceMustBeSpaced && firstSpaced && second.type !== vendor.distExports.AST_TOKEN_TYPES.Line) {
reportNoBeginningSpace(node, first);
}
}
if (vendor.astUtilsExports.isTokenOnSameLine(penultimate, last)) {
var _context2;
const shouldCheckPenultimate = options.arraysInObjectsException && vendor.astUtilsExports.isClosingBracketToken(penultimate) || options.objectsInObjectsException && vendor.astUtilsExports.isClosingBraceToken(penultimate);
const penultimateType = shouldCheckPenultimate ? sourceCode.getNodeByRangeIndex(penultimate.range[0]).type : undefined;
const closingCurlyBraceMustBeSpaced = options.arraysInObjectsException && penultimateType === vendor.distExports.AST_NODE_TYPES.TSTupleType || options.objectsInObjectsException && penultimateType !== undefined && _includesInstanceProperty(_context2 = [vendor.distExports.AST_NODE_TYPES.TSMappedType, vendor.distExports.AST_NODE_TYPES.TSTypeLiteral]).call(_context2, penultimateType) ? !options.spaced : options.spaced;
const lastSpaced = sourceCode.isSpaceBetween(penultimate, last);
if (closingCurlyBraceMustBeSpaced && !lastSpaced) reportRequiredEndingSpace(node, last);
if (!closingCurlyBraceMustBeSpaced && lastSpaced) reportNoEndingSpace(node, last);
}
}
function getClosingBraceOfObject(node) {
const lastProperty = node.members[node.members.length - 1];
return sourceCode.getTokenAfter(lastProperty, vendor.astUtilsExports.isClosingBraceToken);
}
const rules = baseRule.create(context);
return {
...rules,
TSMappedType(node) {
const first = sourceCode.getFirstToken(node);
const last = sourceCode.getLastToken(node);
const second = sourceCode.getTokenAfter(first, {
includeComments: true
});
const penultimate = sourceCode.getTokenBefore(last, {
includeComments: true
});
validateBraceSpacing(node, first, second, penultimate, last);
},
TSTypeLiteral(node) {
if (node.members.length === 0) return;
const first = sourceCode.getFirstToken(node);
const last = getClosingBraceOfObject(node);
const second = sourceCode.getTokenAfter(first, {
includeComments: true
});
const penultimate = sourceCode.getTokenBefore(last, {
includeComments: true
});
validateBraceSpacing(node, first, second, penultimate, last);
}
};
}
});
module.exports = objectCurlySpacing;