123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640 |
- "use strict";
- const astUtils = require("./utils/ast-utils"),
- keywords = require("./utils/keywords");
- const PREV_TOKEN = /^[)\]}>]$/u;
- const NEXT_TOKEN = /^(?:[([{<~!]|\+\+?|--?)$/u;
- const PREV_TOKEN_M = /^[)\]}>*]$/u;
- const NEXT_TOKEN_M = /^[{*]$/u;
- const TEMPLATE_OPEN_PAREN = /\$\{$/u;
- const TEMPLATE_CLOSE_PAREN = /^\}/u;
- const CHECK_TYPE = /^(?:JSXElement|RegularExpression|String|Template|PrivateIdentifier)$/u;
- const KEYS = keywords.concat(["as", "async", "await", "from", "get", "let", "of", "set", "yield"]);
- (function() {
- KEYS.sort();
- for (let i = 1; i < KEYS.length; ++i) {
- if (KEYS[i] === KEYS[i - 1]) {
- throw new Error(`Duplication was found in the keyword list: ${KEYS[i]}`);
- }
- }
- }());
- function isOpenParenOfTemplate(token) {
- return token.type === "Template" && TEMPLATE_OPEN_PAREN.test(token.value);
- }
- function isCloseParenOfTemplate(token) {
- return token.type === "Template" && TEMPLATE_CLOSE_PAREN.test(token.value);
- }
- module.exports = {
- meta: {
- deprecated: true,
- replacedBy: [],
- type: "layout",
- docs: {
- description: "Enforce consistent spacing before and after keywords",
- recommended: false,
- url: "https://eslint.org/docs/latest/rules/keyword-spacing"
- },
- fixable: "whitespace",
- schema: [
- {
- type: "object",
- properties: {
- before: { type: "boolean", default: true },
- after: { type: "boolean", default: true },
- overrides: {
- type: "object",
- properties: KEYS.reduce((retv, key) => {
- retv[key] = {
- type: "object",
- properties: {
- before: { type: "boolean" },
- after: { type: "boolean" }
- },
- additionalProperties: false
- };
- return retv;
- }, {}),
- additionalProperties: false
- }
- },
- additionalProperties: false
- }
- ],
- messages: {
- expectedBefore: "Expected space(s) before \"{{value}}\".",
- expectedAfter: "Expected space(s) after \"{{value}}\".",
- unexpectedBefore: "Unexpected space(s) before \"{{value}}\".",
- unexpectedAfter: "Unexpected space(s) after \"{{value}}\"."
- }
- },
- create(context) {
- const sourceCode = context.sourceCode;
- const tokensToIgnore = new WeakSet();
-
- function expectSpaceBefore(token, pattern) {
- const prevToken = sourceCode.getTokenBefore(token);
- if (prevToken &&
- (CHECK_TYPE.test(prevToken.type) || pattern.test(prevToken.value)) &&
- !isOpenParenOfTemplate(prevToken) &&
- !tokensToIgnore.has(prevToken) &&
- astUtils.isTokenOnSameLine(prevToken, token) &&
- !sourceCode.isSpaceBetweenTokens(prevToken, token)
- ) {
- context.report({
- loc: token.loc,
- messageId: "expectedBefore",
- data: token,
- fix(fixer) {
- return fixer.insertTextBefore(token, " ");
- }
- });
- }
- }
-
- function unexpectSpaceBefore(token, pattern) {
- const prevToken = sourceCode.getTokenBefore(token);
- if (prevToken &&
- (CHECK_TYPE.test(prevToken.type) || pattern.test(prevToken.value)) &&
- !isOpenParenOfTemplate(prevToken) &&
- !tokensToIgnore.has(prevToken) &&
- astUtils.isTokenOnSameLine(prevToken, token) &&
- sourceCode.isSpaceBetweenTokens(prevToken, token)
- ) {
- context.report({
- loc: { start: prevToken.loc.end, end: token.loc.start },
- messageId: "unexpectedBefore",
- data: token,
- fix(fixer) {
- return fixer.removeRange([prevToken.range[1], token.range[0]]);
- }
- });
- }
- }
-
- function expectSpaceAfter(token, pattern) {
- const nextToken = sourceCode.getTokenAfter(token);
- if (nextToken &&
- (CHECK_TYPE.test(nextToken.type) || pattern.test(nextToken.value)) &&
- !isCloseParenOfTemplate(nextToken) &&
- !tokensToIgnore.has(nextToken) &&
- astUtils.isTokenOnSameLine(token, nextToken) &&
- !sourceCode.isSpaceBetweenTokens(token, nextToken)
- ) {
- context.report({
- loc: token.loc,
- messageId: "expectedAfter",
- data: token,
- fix(fixer) {
- return fixer.insertTextAfter(token, " ");
- }
- });
- }
- }
-
- function unexpectSpaceAfter(token, pattern) {
- const nextToken = sourceCode.getTokenAfter(token);
- if (nextToken &&
- (CHECK_TYPE.test(nextToken.type) || pattern.test(nextToken.value)) &&
- !isCloseParenOfTemplate(nextToken) &&
- !tokensToIgnore.has(nextToken) &&
- astUtils.isTokenOnSameLine(token, nextToken) &&
- sourceCode.isSpaceBetweenTokens(token, nextToken)
- ) {
- context.report({
- loc: { start: token.loc.end, end: nextToken.loc.start },
- messageId: "unexpectedAfter",
- data: token,
- fix(fixer) {
- return fixer.removeRange([token.range[1], nextToken.range[0]]);
- }
- });
- }
- }
-
- function parseOptions(options = {}) {
- const before = options.before !== false;
- const after = options.after !== false;
- const defaultValue = {
- before: before ? expectSpaceBefore : unexpectSpaceBefore,
- after: after ? expectSpaceAfter : unexpectSpaceAfter
- };
- const overrides = (options && options.overrides) || {};
- const retv = Object.create(null);
- for (let i = 0; i < KEYS.length; ++i) {
- const key = KEYS[i];
- const override = overrides[key];
- if (override) {
- const thisBefore = ("before" in override) ? override.before : before;
- const thisAfter = ("after" in override) ? override.after : after;
- retv[key] = {
- before: thisBefore ? expectSpaceBefore : unexpectSpaceBefore,
- after: thisAfter ? expectSpaceAfter : unexpectSpaceAfter
- };
- } else {
- retv[key] = defaultValue;
- }
- }
- return retv;
- }
- const checkMethodMap = parseOptions(context.options[0]);
-
- function checkSpacingBefore(token, pattern) {
- checkMethodMap[token.value].before(token, pattern || PREV_TOKEN);
- }
-
- function checkSpacingAfter(token, pattern) {
- checkMethodMap[token.value].after(token, pattern || NEXT_TOKEN);
- }
-
- function checkSpacingAround(token) {
- checkSpacingBefore(token);
- checkSpacingAfter(token);
- }
-
- function checkSpacingAroundFirstToken(node) {
- const firstToken = node && sourceCode.getFirstToken(node);
- if (firstToken && firstToken.type === "Keyword") {
- checkSpacingAround(firstToken);
- }
- }
-
- function checkSpacingBeforeFirstToken(node) {
- const firstToken = node && sourceCode.getFirstToken(node);
- if (firstToken && firstToken.type === "Keyword") {
- checkSpacingBefore(firstToken);
- }
- }
-
- function checkSpacingAroundTokenBefore(node) {
- if (node) {
- const token = sourceCode.getTokenBefore(node, astUtils.isKeywordToken);
- checkSpacingAround(token);
- }
- }
-
- function checkSpacingForFunction(node) {
- const firstToken = node && sourceCode.getFirstToken(node);
- if (firstToken &&
- ((firstToken.type === "Keyword" && firstToken.value === "function") ||
- firstToken.value === "async")
- ) {
- checkSpacingBefore(firstToken);
- }
- }
-
- function checkSpacingForClass(node) {
- checkSpacingAroundFirstToken(node);
- checkSpacingAroundTokenBefore(node.superClass);
- }
-
- function checkSpacingForIfStatement(node) {
- checkSpacingAroundFirstToken(node);
- checkSpacingAroundTokenBefore(node.alternate);
- }
-
- function checkSpacingForTryStatement(node) {
- checkSpacingAroundFirstToken(node);
- checkSpacingAroundFirstToken(node.handler);
- checkSpacingAroundTokenBefore(node.finalizer);
- }
-
- function checkSpacingForDoWhileStatement(node) {
- checkSpacingAroundFirstToken(node);
- checkSpacingAroundTokenBefore(node.test);
- }
-
- function checkSpacingForForInStatement(node) {
- checkSpacingAroundFirstToken(node);
- const inToken = sourceCode.getTokenBefore(node.right, astUtils.isNotOpeningParenToken);
- const previousToken = sourceCode.getTokenBefore(inToken);
- if (previousToken.type !== "PrivateIdentifier") {
- checkSpacingBefore(inToken);
- }
- checkSpacingAfter(inToken);
- }
-
- function checkSpacingForForOfStatement(node) {
- if (node.await) {
- checkSpacingBefore(sourceCode.getFirstToken(node, 0));
- checkSpacingAfter(sourceCode.getFirstToken(node, 1));
- } else {
- checkSpacingAroundFirstToken(node);
- }
- const ofToken = sourceCode.getTokenBefore(node.right, astUtils.isNotOpeningParenToken);
- const previousToken = sourceCode.getTokenBefore(ofToken);
- if (previousToken.type !== "PrivateIdentifier") {
- checkSpacingBefore(ofToken);
- }
- checkSpacingAfter(ofToken);
- }
-
|