72 lines
2.6 KiB
TypeScript
72 lines
2.6 KiB
TypeScript
import { TSESTree, AST_NODE_TYPES } from "@typescript-eslint/experimental-utils";
|
|
import { createRule } from "./utils";
|
|
|
|
export = createRule({
|
|
name: "no-double-space",
|
|
meta: {
|
|
docs: {
|
|
description: ``,
|
|
category: "Stylistic Issues",
|
|
recommended: "error",
|
|
},
|
|
messages: {
|
|
noDoubleSpaceError: `Use only one space`,
|
|
},
|
|
schema: [],
|
|
type: "problem",
|
|
},
|
|
defaultOptions: [],
|
|
|
|
create(context) {
|
|
const sourceCode = context.getSourceCode();
|
|
const lines = sourceCode.getLines();
|
|
|
|
const isStringLiteral = (node: TSESTree.Node | null): boolean => {
|
|
return !!(node && (
|
|
(node.type === AST_NODE_TYPES.TemplateElement) ||
|
|
(node.type === AST_NODE_TYPES.TemplateLiteral && node.quasis) ||
|
|
(node.type === AST_NODE_TYPES.Literal && typeof node.value === "string")
|
|
));
|
|
};
|
|
|
|
const isRegexLiteral = (node: TSESTree.Node | null): boolean => {
|
|
return !!(node && node.type === AST_NODE_TYPES.Literal && Object.prototype.hasOwnProperty.call(node, "regex"));
|
|
};
|
|
|
|
const checkDoubleSpace = (node: TSESTree.Node) => {
|
|
lines.forEach((line, index) => {
|
|
const firstNonSpace = /\S/.exec(line);
|
|
if (!firstNonSpace || line.includes("@param")) {
|
|
return;
|
|
}
|
|
|
|
// Allow common uses of double spaces
|
|
// * To align `=` or `!=` signs
|
|
// * To align comments at the end of lines
|
|
// * To indent inside a comment
|
|
// * To use two spaces after a period
|
|
// * To include aligned `->` in a comment
|
|
const rgx = /[^/*. ][ ]{2}[^-!/= ]/g;
|
|
rgx.lastIndex = firstNonSpace.index;
|
|
const doubleSpace = rgx.exec(line);
|
|
|
|
if (!doubleSpace) {
|
|
return;
|
|
}
|
|
|
|
const locIndex = sourceCode.getIndexFromLoc({ column: doubleSpace.index, line: index + 1 });
|
|
const sourceNode = sourceCode.getNodeByRangeIndex(locIndex);
|
|
if (isStringLiteral(sourceNode) || isRegexLiteral(sourceNode)) {
|
|
return;
|
|
}
|
|
|
|
context.report({ messageId: "noDoubleSpaceError", node, loc: { line: index + 1, column: doubleSpace.index + 1 } });
|
|
});
|
|
};
|
|
|
|
return {
|
|
Program: checkDoubleSpace,
|
|
};
|
|
},
|
|
});
|