eslint-plugin-jsonc
Version:
ESLint plugin for JSON, JSONC and JSON5 files.
178 lines (177 loc) • 6.92 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("../utils");
const eslint_ast_utils_1 = require("../utils/eslint-ast-utils");
const eslint_utils_1 = require("@eslint-community/eslint-utils");
exports.default = (0, utils_1.createRule)("object-curly-spacing", {
meta: {
docs: {
description: "enforce consistent spacing inside braces",
recommended: null,
extensionRule: true,
layout: true,
},
type: "layout",
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 sourceCode = context.sourceCode;
if (!sourceCode.parserServices.isJSON) {
return {};
}
const spaced = context.options[0] === "always";
function isOptionSet(option) {
return context.options[1]
? context.options[1][option] === !spaced
: false;
}
const options = {
spaced,
arraysInObjectsException: isOptionSet("arraysInObjects"),
objectsInObjectsException: isOptionSet("objectsInObjects"),
isOpeningCurlyBraceMustBeSpaced(_second) {
return options.spaced;
},
isClosingCurlyBraceMustBeSpaced(penultimate) {
const targetPenultimateType = options.arraysInObjectsException &&
(0, eslint_utils_1.isClosingBracketToken)(penultimate)
? "JSONArrayExpression"
: options.objectsInObjectsException &&
(0, eslint_utils_1.isClosingBraceToken)(penultimate)
? "JSONObjectExpression"
: null;
const node = sourceCode.getNodeByRangeIndex(penultimate.range[0]);
return targetPenultimateType && (node === null || node === void 0 ? void 0 : node.type) === targetPenultimateType
? !options.spaced
: options.spaced;
},
};
function reportNoBeginningSpace(node, token) {
const nextToken = sourceCode.getTokenAfter(token, {
includeComments: true,
});
context.report({
node: 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: 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: node,
loc: token.loc,
messageId: "requireSpaceAfter",
data: {
token: token.value,
},
fix(fixer) {
return fixer.insertTextAfter(token, " ");
},
});
}
function reportRequiredEndingSpace(node, token) {
context.report({
node: node,
loc: token.loc,
messageId: "requireSpaceBefore",
data: {
token: token.value,
},
fix(fixer) {
return fixer.insertTextBefore(token, " ");
},
});
}
function validateBraceSpacing(node, first, second, penultimate, last) {
if ((0, eslint_ast_utils_1.isTokenOnSameLine)(first, second)) {
const firstSpaced = sourceCode.isSpaceBetween(first, second);
if (options.isOpeningCurlyBraceMustBeSpaced(second)) {
if (!firstSpaced)
reportRequiredBeginningSpace(node, first);
}
else {
if (firstSpaced && second.type !== "Line") {
reportNoBeginningSpace(node, first);
}
}
}
if ((0, eslint_ast_utils_1.isTokenOnSameLine)(penultimate, last)) {
const lastSpaced = sourceCode.isSpaceBetween(penultimate, last);
if (options.isClosingCurlyBraceMustBeSpaced(penultimate)) {
if (!lastSpaced)
reportRequiredEndingSpace(node, last);
}
else {
if (lastSpaced)
reportNoEndingSpace(node, last);
}
}
}
function getClosingBraceOfObject(node) {
const lastProperty = node.properties[node.properties.length - 1];
return sourceCode.getTokenAfter(lastProperty, eslint_utils_1.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);
}
return {
JSONObjectExpression: checkForObject,
};
},
});