@jqassistant/ts-lce/dist/src/core/context.keys.js

Tool to extract language concepts from a TypeScript codebase and export them to a JSON file.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CoreContextKeys = void 0;
/**
 * Specifies keys for the definition and retrieval of local contexts within the core part of the TS LCE.
 *
 * (see also "Local Contexts" in the developer documentation)
 */
class CoreContextKeys {
    /**
     * `TraverserContext` instance for each currently traversed node layer.
     * This context is always present, one for each node layer.
     */
    static TRAVERSER_CONTEXT = "~traverser";
    // === Declaration Processing ===
    /**
     * Flag indicating, whether members of an enum should be processed (`boolean`)
     */
    static ENUM_MEMBERS_PROCESSING_FLAG = "process-enum-members";
    /**
     * Predetermined native type (via TypeChecker) of a function declaration that may be used for further processing.
     * The presence of this context is also implicitly used to trigger the processing of nested parameter nodes.
     */
    static FUNCTION_TYPE = "function-type";
    /**
     * Predetermined native type (via TypeChecker) of a method declaration/signature that may be used for further processing.
     * The presence of this context is also implicitly used to trigger the processing of nested parameter nodes.
     */
    static METHOD_TYPE = "method-type";
    /**
     * Flag indicating, whether members of a class or interface should be processed. (`number`)
     *
     * The number indicates at which depth the child nodes of the members may occur (`1` for direct children, `2` for grand-children, etc.)
     */
    static PROCESS_CLASS_LIKE_MEMBERS = "process-members";
    /**
     * Flag indicating, whether parameters of a function or method should be processed. (`number`)
     *
     * The number indicates at which depth the child nodes of the parameters may occur (`1` for direct children, `2` for grand-children, etc.)
     */
    static PROCESS_PARAMETERS = "process-parameters";
    // === Dependency and FQN resolution ===
    /**
     * Dependency index used for registering all declarations made within a module (`DeclarationIndex`)
     */
    static DECLARATION_INDEX = "declaration-index";
    /**
     * Current scope object, used to introduce new FQN scoping levels (`FQNScope`)
     */
    static FQN_SCOPE = "fqn-scope";
    /**
     * FQN resolver index, used to schedule FQN resolutions (`FQNResolverContext`)
     */
    static FQN_RESOLVER = "fqn-resolver";
    /**
     * FQN of the declaration that any newly discovered dependencies are added to (`string`)
     */
    static DEPENDENCY_GLOBAL_SOURCE_FQN = "dependency-global-fqn";
    /**
     * Dependency index of the current dependency fqn (`Array<LCEDependency>`)
     */
    static DEPENDENCY_INDEX = "dependency-index";
    /**
     * Identifier of the declaration that is default-exported in the current module (not used for inline default exports, e.g. `export default class MyClass { ... }`)
     */
    static DEFAULT_EXPORT_IDENTIFIER = "default-export-identifier-context";
    // === Value Processing ===
    /**
     * Flag indicating, whether value child nodes should be processed to actual value concepts (`boolean`)
     */
    static VALUE_PROCESSING_FLAG = "process-values";
    /**
     * Integer used to trigger the FQN resolution of identifiers within (stacked) member value expressions (`number`)
     */
    static DO_NOT_RESOLVE_IDENTIFIER_FLAG = "do-not-resolve-value-identifier";
}
exports.CoreContextKeys = CoreContextKeys;