413 lines
17 KiB
Plaintext
413 lines
17 KiB
Plaintext
|
"use strict";
|
||
|
|
/**
|
||
|
|
* Note this file is rather type-unsafe in its current state.
|
||
|
|
* This is due to some really funky type conversions between different node types.
|
||
|
|
* This is done intentionally based on the internal implementation of the base indent rule.
|
||
|
|
*/
|
||
|
|
/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment */
|
||
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||
|
|
const utils_1 = require("@typescript-eslint/utils");
|
||
|
|
const util_1 = require("../util");
|
||
|
|
const getESLintCoreRule_1 = require("../util/getESLintCoreRule");
|
||
|
|
const baseRule = (0, getESLintCoreRule_1.getESLintCoreRule)('indent');
|
||
|
|
const KNOWN_NODES = new Set([
|
||
|
|
// Class properties aren't yet supported by eslint...
|
||
|
|
utils_1.AST_NODE_TYPES.PropertyDefinition,
|
||
|
|
// ts keywords
|
||
|
|
utils_1.AST_NODE_TYPES.TSAbstractKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSAnyKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSBooleanKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSNeverKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSNumberKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSStringKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSSymbolKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSUndefinedKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSUnknownKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSVoidKeyword,
|
||
|
|
utils_1.AST_NODE_TYPES.TSNullKeyword,
|
||
|
|
// ts specific nodes we want to support
|
||
|
|
utils_1.AST_NODE_TYPES.TSAbstractPropertyDefinition,
|
||
|
|
utils_1.AST_NODE_TYPES.TSAbstractMethodDefinition,
|
||
|
|
utils_1.AST_NODE_TYPES.TSArrayType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSAsExpression,
|
||
|
|
utils_1.AST_NODE_TYPES.TSCallSignatureDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSConditionalType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSConstructorType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSConstructSignatureDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSDeclareFunction,
|
||
|
|
utils_1.AST_NODE_TYPES.TSEmptyBodyFunctionExpression,
|
||
|
|
utils_1.AST_NODE_TYPES.TSEnumDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSEnumMember,
|
||
|
|
utils_1.AST_NODE_TYPES.TSExportAssignment,
|
||
|
|
utils_1.AST_NODE_TYPES.TSExternalModuleReference,
|
||
|
|
utils_1.AST_NODE_TYPES.TSFunctionType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSImportType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSIndexedAccessType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSIndexSignature,
|
||
|
|
utils_1.AST_NODE_TYPES.TSInferType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSInterfaceBody,
|
||
|
|
utils_1.AST_NODE_TYPES.TSInterfaceDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSInterfaceHeritage,
|
||
|
|
utils_1.AST_NODE_TYPES.TSIntersectionType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSImportEqualsDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSLiteralType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSMappedType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSMethodSignature,
|
||
|
|
'TSMinusToken',
|
||
|
|
utils_1.AST_NODE_TYPES.TSModuleBlock,
|
||
|
|
utils_1.AST_NODE_TYPES.TSModuleDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSNonNullExpression,
|
||
|
|
utils_1.AST_NODE_TYPES.TSParameterProperty,
|
||
|
|
'TSPlusToken',
|
||
|
|
utils_1.AST_NODE_TYPES.TSPropertySignature,
|
||
|
|
utils_1.AST_NODE_TYPES.TSQualifiedName,
|
||
|
|
'TSQuestionToken',
|
||
|
|
utils_1.AST_NODE_TYPES.TSRestType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSThisType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTupleType,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeAnnotation,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeLiteral,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeOperator,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeParameter,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeParameterDeclaration,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeParameterInstantiation,
|
||
|
|
utils_1.AST_NODE_TYPES.TSTypeReference,
|
||
|
|
utils_1.AST_NODE_TYPES.TSUnionType,
|
||
|
|
utils_1.AST_NODE_TYPES.Decorator,
|
||
|
|
]);
|
||
|
|
exports.default = (0, util_1.createRule)({
|
||
|
|
name: 'indent',
|
||
|
|
meta: {
|
||
|
|
deprecated: true,
|
||
|
|
replacedBy: ['@stylistic/ts/indent'],
|
||
|
|
type: 'layout',
|
||
|
|
docs: {
|
||
|
|
description: 'Enforce consistent indentation',
|
||
|
|
// too opinionated to be recommended
|
||
|
|
extendsBaseRule: true,
|
||
|
|
},
|
||
|
|
fixable: 'whitespace',
|
||
|
|
hasSuggestions: baseRule.meta.hasSuggestions,
|
||
|
|
schema: baseRule.meta.schema,
|
||
|
|
messages: baseRule.meta.messages,
|
||
|
|
},
|
||
|
|
defaultOptions: [
|
||
|
|
// typescript docs and playground use 4 space indent
|
||
|
|
4,
|
||
|
|
{
|
||
|
|
// typescript docs indent the case from the switch
|
||
|
|
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-1-8.html#example-4
|
||
|
|
SwitchCase: 1,
|
||
|
|
flatTernaryExpressions: false,
|
||
|
|
ignoredNodes: [],
|
||
|
|
},
|
||
|
|
],
|
||
|
|
create(context, optionsWithDefaults) {
|
||
|
|
// because we extend the base rule, have to update opts on the context
|
||
|
|
// the context defines options as readonly though...
|
||
|
|
const contextWithDefaults = Object.create(context, {
|
||
|
|
options: {
|
||
|
|
writable: false,
|
||
|
|
configurable: false,
|
||
|
|
value: optionsWithDefaults,
|
||
|
|
},
|
||
|
|
});
|
||
|
|
const rules = baseRule.create(contextWithDefaults);
|
||
|
|
/**
|
||
|
|
* Converts from a TSPropertySignature to a Property
|
||
|
|
* @param node a TSPropertySignature node
|
||
|
|
* @param [type] the type to give the new node
|
||
|
|
* @returns a Property node
|
||
|
|
*/
|
||
|
|
function TSPropertySignatureToProperty(node, type = utils_1.AST_NODE_TYPES.Property) {
|
||
|
|
const base = {
|
||
|
|
// indent doesn't actually use these
|
||
|
|
key: null,
|
||
|
|
value: null,
|
||
|
|
// Property flags
|
||
|
|
computed: false,
|
||
|
|
method: false,
|
||
|
|
kind: 'init',
|
||
|
|
// this will stop eslint from interrogating the type literal
|
||
|
|
shorthand: true,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
};
|
||
|
|
if (type === utils_1.AST_NODE_TYPES.Property) {
|
||
|
|
return {
|
||
|
|
type,
|
||
|
|
...base,
|
||
|
|
};
|
||
|
|
}
|
||
|
|
return {
|
||
|
|
type,
|
||
|
|
accessibility: undefined,
|
||
|
|
declare: false,
|
||
|
|
decorators: [],
|
||
|
|
definite: false,
|
||
|
|
optional: false,
|
||
|
|
override: false,
|
||
|
|
readonly: false,
|
||
|
|
static: false,
|
||
|
|
typeAnnotation: undefined,
|
||
|
|
...base,
|
||
|
|
};
|
||
|
|
}
|
||
|
|
return Object.assign({}, rules, {
|
||
|
|
// overwrite the base rule here so we can use our KNOWN_NODES list instead
|
||
|
|
'*:exit'(node) {
|
||
|
|
// For nodes we care about, skip the default handling, because it just marks the node as ignored...
|
||
|
|
if (!KNOWN_NODES.has(node.type)) {
|
||
|
|
rules['*:exit'](node);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
VariableDeclaration(node) {
|
||
|
|
// https://github.com/typescript-eslint/typescript-eslint/issues/441
|
||
|
|
if (node.declarations.length === 0) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
return rules.VariableDeclaration(node);
|
||
|
|
},
|
||
|
|
TSAsExpression(node) {
|
||
|
|
// transform it to a BinaryExpression
|
||
|
|
return rules['BinaryExpression, LogicalExpression']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.BinaryExpression,
|
||
|
|
operator: 'as',
|
||
|
|
left: node.expression,
|
||
|
|
// the first typeAnnotation includes the as token
|
||
|
|
right: node.typeAnnotation,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSConditionalType(node) {
|
||
|
|
// transform it to a ConditionalExpression
|
||
|
|
return rules.ConditionalExpression({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ConditionalExpression,
|
||
|
|
test: {
|
||
|
|
parent: node,
|
||
|
|
type: utils_1.AST_NODE_TYPES.BinaryExpression,
|
||
|
|
operator: 'extends',
|
||
|
|
left: node.checkType,
|
||
|
|
right: node.extendsType,
|
||
|
|
// location data
|
||
|
|
range: [node.checkType.range[0], node.extendsType.range[1]],
|
||
|
|
loc: {
|
||
|
|
start: node.checkType.loc.start,
|
||
|
|
end: node.extendsType.loc.end,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
consequent: node.trueType,
|
||
|
|
alternate: node.falseType,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
'TSEnumDeclaration, TSTypeLiteral'(node) {
|
||
|
|
// transform it to an ObjectExpression
|
||
|
|
return rules['ObjectExpression, ObjectPattern']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ObjectExpression,
|
||
|
|
properties: node.members.map(member => TSPropertySignatureToProperty(member)),
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSImportEqualsDeclaration(node) {
|
||
|
|
// transform it to an VariableDeclaration
|
||
|
|
// use VariableDeclaration instead of ImportDeclaration because it's essentially the same thing
|
||
|
|
const { id, moduleReference } = node;
|
||
|
|
return rules.VariableDeclaration({
|
||
|
|
type: utils_1.AST_NODE_TYPES.VariableDeclaration,
|
||
|
|
kind: 'const',
|
||
|
|
declarations: [
|
||
|
|
{
|
||
|
|
type: utils_1.AST_NODE_TYPES.VariableDeclarator,
|
||
|
|
range: [id.range[0], moduleReference.range[1]],
|
||
|
|
loc: {
|
||
|
|
start: id.loc.start,
|
||
|
|
end: moduleReference.loc.end,
|
||
|
|
},
|
||
|
|
id: id,
|
||
|
|
init: {
|
||
|
|
type: utils_1.AST_NODE_TYPES.CallExpression,
|
||
|
|
callee: {
|
||
|
|
type: utils_1.AST_NODE_TYPES.Identifier,
|
||
|
|
name: 'require',
|
||
|
|
range: [
|
||
|
|
moduleReference.range[0],
|
||
|
|
moduleReference.range[0] + 'require'.length,
|
||
|
|
],
|
||
|
|
loc: {
|
||
|
|
start: moduleReference.loc.start,
|
||
|
|
end: {
|
||
|
|
line: moduleReference.loc.end.line,
|
||
|
|
column: moduleReference.loc.start.line + 'require'.length,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
arguments: 'expression' in moduleReference
|
||
|
|
? [moduleReference.expression]
|
||
|
|
: [],
|
||
|
|
// location data
|
||
|
|
range: moduleReference.range,
|
||
|
|
loc: moduleReference.loc,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
],
|
||
|
|
declare: false,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSIndexedAccessType(node) {
|
||
|
|
// convert to a MemberExpression
|
||
|
|
return rules['MemberExpression, JSXMemberExpression, MetaProperty']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.MemberExpression,
|
||
|
|
object: node.objectType,
|
||
|
|
property: node.indexType,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
optional: false,
|
||
|
|
computed: true,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSInterfaceBody(node) {
|
||
|
|
// transform it to an ClassBody
|
||
|
|
return rules['BlockStatement, ClassBody']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ClassBody,
|
||
|
|
body: node.body.map(p => TSPropertySignatureToProperty(p, utils_1.AST_NODE_TYPES.PropertyDefinition)),
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
'TSInterfaceDeclaration[extends.length > 0]'(node) {
|
||
|
|
// transform it to a ClassDeclaration
|
||
|
|
return rules['ClassDeclaration[superClass], ClassExpression[superClass]']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ClassDeclaration,
|
||
|
|
body: node.body,
|
||
|
|
id: null,
|
||
|
|
// TODO: This is invalid, there can be more than one extends in interface
|
||
|
|
superClass: node.extends[0].expression,
|
||
|
|
abstract: false,
|
||
|
|
declare: false,
|
||
|
|
decorators: [],
|
||
|
|
implements: [],
|
||
|
|
superTypeArguments: undefined,
|
||
|
|
superTypeParameters: undefined,
|
||
|
|
typeParameters: undefined,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSMappedType(node) {
|
||
|
|
const squareBracketStart = context.sourceCode.getTokenBefore(node.typeParameter);
|
||
|
|
// transform it to an ObjectExpression
|
||
|
|
return rules['ObjectExpression, ObjectPattern']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ObjectExpression,
|
||
|
|
properties: [
|
||
|
|
{
|
||
|
|
parent: node,
|
||
|
|
type: utils_1.AST_NODE_TYPES.Property,
|
||
|
|
key: node.typeParameter,
|
||
|
|
value: node.typeAnnotation,
|
||
|
|
// location data
|
||
|
|
range: [
|
||
|
|
squareBracketStart.range[0],
|
||
|
|
node.typeAnnotation
|
||
|
|
? node.typeAnnotation.range[1]
|
||
|
|
: squareBracketStart.range[0],
|
||
|
|
],
|
||
|
|
loc: {
|
||
|
|
start: squareBracketStart.loc.start,
|
||
|
|
end: node.typeAnnotation
|
||
|
|
? node.typeAnnotation.loc.end
|
||
|
|
: squareBracketStart.loc.end,
|
||
|
|
},
|
||
|
|
kind: 'init',
|
||
|
|
computed: false,
|
||
|
|
method: false,
|
||
|
|
optional: false,
|
||
|
|
shorthand: false,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSModuleBlock(node) {
|
||
|
|
// transform it to a BlockStatement
|
||
|
|
return rules['BlockStatement, ClassBody']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.BlockStatement,
|
||
|
|
body: node.body,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSQualifiedName(node) {
|
||
|
|
return rules['MemberExpression, JSXMemberExpression, MetaProperty']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.MemberExpression,
|
||
|
|
object: node.left,
|
||
|
|
property: node.right,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
optional: false,
|
||
|
|
computed: false,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSTupleType(node) {
|
||
|
|
// transform it to an ArrayExpression
|
||
|
|
return rules['ArrayExpression, ArrayPattern']({
|
||
|
|
type: utils_1.AST_NODE_TYPES.ArrayExpression,
|
||
|
|
elements: node.elementTypes,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
TSTypeParameterDeclaration(node) {
|
||
|
|
if (!node.params.length) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
const [name, ...attributes] = node.params;
|
||
|
|
// JSX is about the closest we can get because the angle brackets
|
||
|
|
// it's not perfect but it works!
|
||
|
|
return rules.JSXOpeningElement({
|
||
|
|
type: utils_1.AST_NODE_TYPES.JSXOpeningElement,
|
||
|
|
selfClosing: false,
|
||
|
|
name: name,
|
||
|
|
attributes: attributes,
|
||
|
|
typeArguments: undefined,
|
||
|
|
typeParameters: undefined,
|
||
|
|
// location data
|
||
|
|
parent: node.parent,
|
||
|
|
range: node.range,
|
||
|
|
loc: node.loc,
|
||
|
|
});
|
||
|
|
},
|
||
|
|
});
|
||
|
|
},
|
||
|
|
});
|
||
|
|
//# sourceMappingURL=indent.js.map
|