cannabis/dist/src/adapter/attributeTypes.d.ts

TypeScript AST Query library

import { ObjectStringKeyUnion } from 'misc-utils-of-mine-typescript';
import { ASTNode } from '../node/astNode';
export declare type AttributeNames = ObjectStringKeyUnion<AttributeValues>;
export interface AttributeValues {
    /**
     * Returns current node's text as in `ts.Node#getText()`. Example: `// VariableDeclaration [ @text!~'2' ]`
     */
    text: string;
    /**
     * Returns current node's name if any. If it doesn't have a name, it returns an empty string.
     *
     * There are node kinds that have name, like InterfaceDeclaration, and others that don't, like IfStatement.
     * Examples `// * [ @name=='f' && @modifiers=~'export' ]`
     */
    name: string;
    /**
     * Returns current node's type string representation. If type is not declared it will be inferrer form
     * usage. If type doesn't apply to current node it will return empty string.
     *
     * Examples: `// VariableDeclaration [ @type=='Date[]']`, `// Parameter [ @type=='boolean' ||
     * @type=='number']`
     */
    type: string;
    /**
     * A comma separated modifier names in ` "export", "default", "declare", "abstract", "public", "protected",
     * "private", "readonly", "static", "async", "const"`. Example: `// PropertyDeclaration [
     * @modifiers=~'private' || @modifiers=~'protected' ]`
     */
    modifiers: string;
    /**
     * Returns a AST Node if the node has an expression, or null other wise.
     */
    expression: ASTNode | null;
    /**
     * Gets the literal text of a literal-like node. Example: `// LiteralString [compareText({forbidden},
     * @literalText, 'verb:equals,caseSensitive:true']`
     */
    literalText: string;
    /**
     * Returns the position of current node in its source file.
     */
    start: number;
    /**
     * Returns the position of current node's end, in its source file.
     */
    end: number;
    /**
     * Returns the amount of characters of current node.
     */
    width: number;
    /**
     * Return current node's body node, or null if it doesn't have a body.
     */
    body: ASTNode | null;
    /**
     * Returns the text of comments before this node.
     */
    leadingComments: string[];
    /**
     * Returns the text of comments after this node.
     */
    trailingComments: string[];
    /**
     * Returns a node kind based path for the node, like
     * `src/services/login/loginService/InterfaceDeclaration/Identifier`. Notice that unlike @indexPath, this
     * doesn't necessarily points to the node.
     */
    kindPath: string;
    /**
     * Returns a child-index based path for the node, similar to `src/services/login/loginService/2/1`
     */
    indexPath: string;
    /**
     * Returns a node-name based path for current node, like
     * `src/services/login/loginService/LoginService/method1/param1`. Notice that unlike @indexPath, this
     * doesn't necessarily points to the node. If a node doesn't have a name, its kind name will be printed in
     * the path instead.
     */
    namePath: string;
}
export declare const attributeNames: ("name" | "expression" | "type" | "modifiers" | "end" | "text" | "literalText" | "start" | "width" | "body" | "leadingComments" | "trailingComments" | "kindPath" | "indexPath" | "namePath")[];