123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294 |
- /**
- * @fileoverview Utility functions for AST
- */
- 'use strict';
- /**
- * Find a return statment in the current node
- *
- * @param {ASTNode} node The AST node being checked
- * @returns {ASTNode | false}
- */
- function findReturnStatement(node) {
- if (
- (!node.value || !node.value.body || !node.value.body.body)
- && (!node.body || !node.body.body)
- ) {
- return false;
- }
- const bodyNodes = (node.value ? node.value.body.body : node.body.body);
- return (function loopNodes(nodes) {
- let i = nodes.length - 1;
- for (; i >= 0; i--) {
- if (nodes[i].type === 'ReturnStatement') {
- return nodes[i];
- }
- if (nodes[i].type === 'SwitchStatement') {
- let j = nodes[i].cases.length - 1;
- for (; j >= 0; j--) {
- return loopNodes(nodes[i].cases[j].consequent);
- }
- }
- }
- return false;
- }(bodyNodes));
- }
- /**
- * Get node with property's name
- * @param {Object} node - Property.
- * @returns {Object} Property name node.
- */
- function getPropertyNameNode(node) {
- if (node.key || ['MethodDefinition', 'Property'].indexOf(node.type) !== -1) {
- return node.key;
- }
- if (node.type === 'MemberExpression') {
- return node.property;
- }
- return null;
- }
- /**
- * Get properties name
- * @param {Object} node - Property.
- * @returns {String} Property name.
- */
- function getPropertyName(node) {
- const nameNode = getPropertyNameNode(node);
- return nameNode ? nameNode.name : '';
- }
- /**
- * Get properties for a given AST node
- * @param {ASTNode} node The AST node being checked.
- * @returns {Array} Properties array.
- */
- function getComponentProperties(node) {
- switch (node.type) {
- case 'ClassDeclaration':
- case 'ClassExpression':
- return node.body.body;
- case 'ObjectExpression':
- return node.properties;
- default:
- return [];
- }
- }
- /**
- * Gets the first node in a line from the initial node, excluding whitespace.
- * @param {Object} context The node to check
- * @param {ASTNode} node The node to check
- * @return {ASTNode} the first node in the line
- */
- function getFirstNodeInLine(context, node) {
- const sourceCode = context.getSourceCode();
- let token = node;
- let lines;
- do {
- token = sourceCode.getTokenBefore(token);
- lines = token.type === 'JSXText'
- ? token.value.split('\n')
- : null;
- } while (
- token.type === 'JSXText'
- && /^\s*$/.test(lines[lines.length - 1])
- );
- return token;
- }
- /**
- * Checks if the node is the first in its line, excluding whitespace.
- * @param {Object} context The node to check
- * @param {ASTNode} node The node to check
- * @return {Boolean} true if it's the first node in its line
- */
- function isNodeFirstInLine(context, node) {
- const token = getFirstNodeInLine(context, node);
- const startLine = node.loc.start.line;
- const endLine = token ? token.loc.end.line : -1;
- return startLine !== endLine;
- }
- /**
- * Checks if the node is a function or arrow function expression.
- * @param {ASTNode} node The node to check
- * @return {Boolean} true if it's a function-like expression
- */
- function isFunctionLikeExpression(node) {
- return node.type === 'FunctionExpression' || node.type === 'ArrowFunctionExpression';
- }
- /**
- * Checks if the node is a function.
- * @param {ASTNode} node The node to check
- * @return {Boolean} true if it's a function
- */
- function isFunction(node) {
- return node.type === 'FunctionExpression' || node.type === 'FunctionDeclaration';
- }
- /**
- * Checks if the node is a class.
- * @param {ASTNode} node The node to check
- * @return {Boolean} true if it's a class
- */
- function isClass(node) {
- return node.type === 'ClassDeclaration' || node.type === 'ClassExpression';
- }
- /**
- * Removes quotes from around an identifier.
- * @param {string} string the identifier to strip
- * @returns {string}
- */
- function stripQuotes(string) {
- return string.replace(/^'|'$/g, '');
- }
- /**
- * Retrieve the name of a key node
- * @param {Context} context The AST node with the key.
- * @param {ASTNode} node The AST node with the key.
- * @return {string | undefined} the name of the key
- */
- function getKeyValue(context, node) {
- if (node.type === 'ObjectTypeProperty') {
- const tokens = context.getFirstTokens(node, 2);
- return (tokens[0].value === '+' || tokens[0].value === '-'
- ? tokens[1].value
- : stripQuotes(tokens[0].value)
- );
- }
- if (node.type === 'GenericTypeAnnotation') {
- return node.id.name;
- }
- if (node.type === 'ObjectTypeAnnotation') {
- return;
- }
- const key = node.key || node.argument;
- if (!key) {
- return;
- }
- return key.type === 'Identifier' ? key.name : key.value;
- }
- /**
- * Checks if a node is being assigned a value: props.bar = 'bar'
- * @param {ASTNode} node The AST node being checked.
- * @returns {Boolean}
- */
- function isAssignmentLHS(node) {
- return (
- node.parent
- && node.parent.type === 'AssignmentExpression'
- && node.parent.left === node
- );
- }
- /**
- * Extracts the expression node that is wrapped inside a TS type assertion
- *
- * @param {ASTNode} node - potential TS node
- * @returns {ASTNode} - unwrapped expression node
- */
- function unwrapTSAsExpression(node) {
- if (node && node.type === 'TSAsExpression') return node.expression;
- return node;
- }
- function isTSTypeReference(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeReference';
- }
- function isTSTypeAnnotation(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeAnnotation';
- }
- function isTSTypeLiteral(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeLiteral';
- }
- function isTSIntersectionType(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSIntersectionType';
- }
- function isTSInterfaceHeritage(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSInterfaceHeritage';
- }
- function isTSInterfaceDeclaration(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSInterfaceDeclaration';
- }
- function isTSTypeAliasDeclaration(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeAliasDeclaration';
- }
- function isTSParenthesizedType(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeAliasDeclaration';
- }
- function isTSFunctionType(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSFunctionType';
- }
- function isTSTypeQuery(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeQuery';
- }
- function isTSTypeParameterInstantiation(node) {
- if (!node) return false;
- const nodeType = node.type;
- return nodeType === 'TSTypeParameterInstantiation';
- }
- module.exports = {
- findReturnStatement,
- getFirstNodeInLine,
- getPropertyName,
- getPropertyNameNode,
- getComponentProperties,
- getKeyValue,
- isAssignmentLHS,
- isClass,
- isFunction,
- isFunctionLikeExpression,
- isNodeFirstInLine,
- unwrapTSAsExpression,
- isTSTypeReference,
- isTSTypeAnnotation,
- isTSTypeLiteral,
- isTSIntersectionType,
- isTSInterfaceHeritage,
- isTSInterfaceDeclaration,
- isTSTypeAliasDeclaration,
- isTSParenthesizedType,
- isTSFunctionType,
- isTSTypeQuery,
- isTSTypeParameterInstantiation
- };
|