TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
306 lines
11 KiB
Plaintext
306 lines
11 KiB
Plaintext
'use strict';
|
|
|
|
var utils = require('../utils.js');
|
|
require('eslint-visitor-keys');
|
|
require('espree');
|
|
require('estraverse');
|
|
|
|
var commaStyle = utils.createRule({
|
|
name: "comma-style",
|
|
package: "js",
|
|
meta: {
|
|
type: "layout",
|
|
docs: {
|
|
description: "Enforce consistent comma style"
|
|
},
|
|
fixable: "code",
|
|
schema: [
|
|
{
|
|
type: "string",
|
|
enum: ["first", "last"]
|
|
},
|
|
{
|
|
type: "object",
|
|
properties: {
|
|
exceptions: {
|
|
type: "object",
|
|
additionalProperties: {
|
|
type: "boolean"
|
|
}
|
|
}
|
|
},
|
|
additionalProperties: false
|
|
}
|
|
],
|
|
messages: {
|
|
unexpectedLineBeforeAndAfterComma: "Bad line breaking before and after ','.",
|
|
expectedCommaFirst: "',' should be placed first.",
|
|
expectedCommaLast: "',' should be placed last."
|
|
}
|
|
},
|
|
create(context) {
|
|
var _a;
|
|
const style = context.options[0] || "last";
|
|
const sourceCode = context.sourceCode;
|
|
const exceptions = {
|
|
ArrayPattern: true,
|
|
ArrowFunctionExpression: true,
|
|
CallExpression: true,
|
|
FunctionDeclaration: true,
|
|
FunctionExpression: true,
|
|
ImportDeclaration: true,
|
|
ObjectPattern: true,
|
|
NewExpression: true,
|
|
ExportAllDeclaration: true,
|
|
ExportNamedDeclaration: true,
|
|
ImportExpression: true,
|
|
SequenceExpression: true,
|
|
ClassDeclaration: true,
|
|
ClassExpression: true,
|
|
TSDeclareFunction: true,
|
|
TSFunctionType: true,
|
|
TSConstructorType: true,
|
|
TSEmptyBodyFunctionExpression: true,
|
|
TSEnumBody: true,
|
|
TSTypeLiteral: true,
|
|
TSIndexSignature: true,
|
|
TSMethodSignature: true,
|
|
TSCallSignatureDeclaration: true,
|
|
TSConstructSignatureDeclaration: true,
|
|
TSInterfaceBody: true,
|
|
TSInterfaceDeclaration: true,
|
|
TSTupleType: true,
|
|
TSTypeParameterDeclaration: true,
|
|
TSTypeParameterInstantiation: true
|
|
};
|
|
if (context.options.length === 2 && Object.prototype.hasOwnProperty.call(context.options[1], "exceptions")) {
|
|
(_a = context.options)[1] ?? (_a[1] = { exceptions: {} });
|
|
const rawExceptions = context.options[1].exceptions;
|
|
const keys = Object.keys(rawExceptions);
|
|
for (let i = 0; i < keys.length; i++)
|
|
exceptions[keys[i]] = rawExceptions[keys[i]];
|
|
}
|
|
function getReplacedText(styleType, text) {
|
|
switch (styleType) {
|
|
case "between":
|
|
return `,${text.replace(utils.LINEBREAK_MATCHER, "")}`;
|
|
case "first":
|
|
return `${text},`;
|
|
case "last":
|
|
return `,${text}`;
|
|
default:
|
|
return "";
|
|
}
|
|
}
|
|
function getFixerFunction(styleType, previousItemToken, commaToken, currentItemToken) {
|
|
const text = sourceCode.text.slice(previousItemToken.range[1], commaToken.range[0]) + sourceCode.text.slice(commaToken.range[1], currentItemToken.range[0]);
|
|
const range = [previousItemToken.range[1], currentItemToken.range[0]];
|
|
return function(fixer) {
|
|
return fixer.replaceTextRange(range, getReplacedText(styleType, text));
|
|
};
|
|
}
|
|
function validateCommaItemSpacing(previousItemToken, commaToken, currentItemToken, reportItem) {
|
|
if (utils.isTokenOnSameLine(commaToken, currentItemToken) && utils.isTokenOnSameLine(previousItemToken, commaToken)) ; else if (!utils.isTokenOnSameLine(commaToken, currentItemToken) && !utils.isTokenOnSameLine(previousItemToken, commaToken)) {
|
|
const comment = sourceCode.getCommentsAfter(commaToken)[0];
|
|
const styleType = comment && comment.type === "Block" && utils.isTokenOnSameLine(commaToken, comment) ? style : "between";
|
|
context.report({
|
|
node: reportItem,
|
|
loc: commaToken.loc,
|
|
messageId: "unexpectedLineBeforeAndAfterComma",
|
|
fix: getFixerFunction(styleType, previousItemToken, commaToken, currentItemToken)
|
|
});
|
|
} else if (style === "first" && !utils.isTokenOnSameLine(commaToken, currentItemToken)) {
|
|
context.report({
|
|
node: reportItem,
|
|
loc: commaToken.loc,
|
|
messageId: "expectedCommaFirst",
|
|
fix: getFixerFunction(style, previousItemToken, commaToken, currentItemToken)
|
|
});
|
|
} else if (style === "last" && utils.isTokenOnSameLine(commaToken, currentItemToken)) {
|
|
context.report({
|
|
node: reportItem,
|
|
loc: commaToken.loc,
|
|
messageId: "expectedCommaLast",
|
|
fix: getFixerFunction(style, previousItemToken, commaToken, currentItemToken)
|
|
});
|
|
}
|
|
}
|
|
function validateComma(node, items) {
|
|
const arrayLiteral = node.type === "ArrayExpression" || node.type === "ArrayPattern";
|
|
if (items.length > 1 || arrayLiteral) {
|
|
let previousItemToken = sourceCode.getFirstToken(node);
|
|
items.forEach((item) => {
|
|
const commaToken = item ? sourceCode.getTokenBefore(item) : previousItemToken;
|
|
const currentItemToken = item ? sourceCode.getFirstToken(item) : sourceCode.getTokenAfter(commaToken);
|
|
const reportItem = item || currentItemToken;
|
|
if (utils.isCommaToken(commaToken))
|
|
validateCommaItemSpacing(previousItemToken, commaToken, currentItemToken, reportItem);
|
|
if (item) {
|
|
const tokenLastItem = sourceCode.getLastToken(item);
|
|
if (tokenLastItem && utils.isCommaToken(tokenLastItem)) {
|
|
previousItemToken = sourceCode.getTokenBefore(tokenLastItem);
|
|
} else {
|
|
const tokenAfterItem = sourceCode.getTokenAfter(item, utils.isNotClosingParenToken);
|
|
previousItemToken = tokenAfterItem ? sourceCode.getTokenBefore(tokenAfterItem) : sourceCode.ast.tokens[sourceCode.ast.tokens.length - 1];
|
|
}
|
|
} else {
|
|
previousItemToken = currentItemToken;
|
|
}
|
|
});
|
|
if (arrayLiteral) {
|
|
const lastToken = sourceCode.getLastToken(node);
|
|
const nextToLastToken = sourceCode.getTokenBefore(lastToken);
|
|
if (utils.isCommaToken(nextToLastToken)) {
|
|
validateCommaItemSpacing(
|
|
sourceCode.getTokenBefore(nextToLastToken),
|
|
nextToLastToken,
|
|
lastToken,
|
|
lastToken
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
const nodes = {};
|
|
if (!exceptions.VariableDeclaration) {
|
|
nodes.VariableDeclaration = (node) => validateComma(node, node.declarations);
|
|
}
|
|
if (!exceptions.ObjectExpression) {
|
|
nodes.ObjectExpression = validateObjectProperties;
|
|
}
|
|
if (!exceptions.ObjectPattern) {
|
|
nodes.ObjectPattern = validateObjectProperties;
|
|
}
|
|
if (!exceptions.ArrayExpression) {
|
|
nodes.ArrayExpression = validateArrayElements;
|
|
}
|
|
if (!exceptions.ArrayPattern) {
|
|
nodes.ArrayPattern = validateArrayElements;
|
|
}
|
|
if (!exceptions.FunctionDeclaration) {
|
|
nodes.FunctionDeclaration = validateFunctionParams;
|
|
}
|
|
if (!exceptions.FunctionExpression) {
|
|
nodes.FunctionExpression = validateFunctionParams;
|
|
}
|
|
if (!exceptions.ArrowFunctionExpression) {
|
|
nodes.ArrowFunctionExpression = validateFunctionParams;
|
|
}
|
|
if (!exceptions.CallExpression) {
|
|
nodes.CallExpression = validateCallArguments;
|
|
}
|
|
if (!exceptions.ImportDeclaration) {
|
|
nodes.ImportDeclaration = (node) => {
|
|
visitModulesSpecifiers(node);
|
|
visitImportAttributes(node);
|
|
};
|
|
}
|
|
if (!exceptions.NewExpression) {
|
|
nodes.NewExpression = validateCallArguments;
|
|
}
|
|
if (!exceptions.ExportAllDeclaration) {
|
|
nodes.ExportAllDeclaration = visitImportAttributes;
|
|
}
|
|
if (!exceptions.ExportNamedDeclaration) {
|
|
nodes.ExportNamedDeclaration = (node) => {
|
|
visitModulesSpecifiers(node);
|
|
visitImportAttributes(node);
|
|
};
|
|
}
|
|
if (!exceptions.ImportExpression) {
|
|
nodes.ImportExpression = (node) => {
|
|
if (node.options)
|
|
validateComma(node, [node.source, node.options]);
|
|
};
|
|
}
|
|
if (!exceptions.SequenceExpression) {
|
|
nodes.SequenceExpression = (node) => validateComma(node, node.expressions);
|
|
}
|
|
if (!exceptions.ClassDeclaration) {
|
|
nodes.ClassDeclaration = visitClassImplements;
|
|
}
|
|
if (!exceptions.ClassExpression) {
|
|
nodes.ClassExpression = visitClassImplements;
|
|
}
|
|
if (!exceptions.TSDeclareFunction) {
|
|
nodes.TSDeclareFunction = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSFunctionType) {
|
|
nodes.TSFunctionType = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSConstructorType) {
|
|
nodes.TSConstructorType = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSEmptyBodyFunctionExpression) {
|
|
nodes.TSEmptyBodyFunctionExpression = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSMethodSignature) {
|
|
nodes.TSMethodSignature = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSCallSignatureDeclaration) {
|
|
nodes.TSCallSignatureDeclaration = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSConstructSignatureDeclaration) {
|
|
nodes.TSConstructSignatureDeclaration = validateFunctionParams;
|
|
}
|
|
if (!exceptions.TSTypeParameterDeclaration) {
|
|
nodes.TSTypeParameterDeclaration = validateTypeParams;
|
|
}
|
|
if (!exceptions.TSTypeParameterInstantiation) {
|
|
nodes.TSTypeParameterInstantiation = validateTypeParams;
|
|
}
|
|
if (!exceptions.TSEnumBody) {
|
|
nodes.TSEnumBody = visitMembers;
|
|
}
|
|
if (!exceptions.TSTypeLiteral) {
|
|
nodes.TSTypeLiteral = visitMembers;
|
|
}
|
|
if (!exceptions.TSIndexSignature) {
|
|
nodes.TSIndexSignature = (node) => validateComma(node, node.parameters);
|
|
}
|
|
if (!exceptions.TSInterfaceDeclaration) {
|
|
nodes.TSInterfaceDeclaration = (node) => validateComma(node, node.extends);
|
|
}
|
|
if (!exceptions.TSInterfaceBody) {
|
|
nodes.TSInterfaceBody = (node) => validateComma(node, node.body);
|
|
}
|
|
if (!exceptions.TSTupleType) {
|
|
nodes.TSTupleType = (node) => validateComma(node, node.elementTypes);
|
|
}
|
|
return nodes;
|
|
function validateObjectProperties(node) {
|
|
validateComma(node, node.properties);
|
|
}
|
|
function validateArrayElements(node) {
|
|
validateComma(node, node.elements);
|
|
}
|
|
function validateFunctionParams(node) {
|
|
validateComma(node, node.params);
|
|
}
|
|
function validateCallArguments(node) {
|
|
validateComma(node, node.arguments);
|
|
}
|
|
function visitImportAttributes(node) {
|
|
if (!node.attributes)
|
|
return;
|
|
validateComma(node, node.attributes);
|
|
}
|
|
function visitModulesSpecifiers(node) {
|
|
validateComma(node, node.specifiers);
|
|
}
|
|
function visitClassImplements(node) {
|
|
if (!node.implements)
|
|
return;
|
|
validateComma(node, node.implements);
|
|
}
|
|
function visitMembers(node) {
|
|
validateComma(node, node.members);
|
|
}
|
|
function validateTypeParams(node) {
|
|
validateComma(node, node.params);
|
|
}
|
|
}
|
|
});
|
|
|
|
module.exports = commaStyle;
|