class Analyzer::Typescript::TRPC

Defined in:

analyzer/analyzers/typescript/trpc.cr

Constant Summary

DEFAULT_PREFIX = "/api/trpc"
PREFIX_HINTS = ["endpoint:", "createExpressMiddleware", "createKoaMiddleware", "fastifyTRPCPlugin", "fastifyTRPC"]
PREFIX_HINTS_RE = Regex.union(PREFIX_HINTS)
PROCEDURE_BUILDER_RE = Regex.union("Procedure", ".procedure")

Procedure/.procedure identify a procedure-builder reference.

PROCEDURE_HINTS = [".query(", ".query (", ".mutation(", ".mutation (", ".subscription(", ".subscription ("]
PROCEDURE_HINTS_RE = Regex.union(PROCEDURE_HINTS)

One precompiled Regex.union (PCRE2 JIT) scan replaces the six-item .any? { includes? } check below — this gate is evaluated on every candidate file, from both v9_router_candidate? and trpc_candidate?.

PROCEDURE_VERBS = {"query" => "GET", "mutation" => "POST", "subscription" => "SUBSCRIBE"}
TEST_FIXTURE_PATH_MARKERS = ["/test/", "/tests/", "/__tests__/", "/e2e/", "/snapshots/", "/test-files/"]
TRPC_ROOT_MARKER_RE = Regex.union("initTRPC", "createTRPCRouter")

initTRPC/createTRPCRouter are OR-ed as a standalone boolean gate in trpc_candidate? below; union them into one scan like the hint lists above instead of two sequential String#includes? calls.

V9_MERGE_HINTS = [".merge(", ".merge ("]
V9_MERGE_HINTS_RE = Regex.union(V9_MERGE_HINTS)
V9_ROUTER_MARKER_RE = Regex.union("createRouter", "trpc.router")

createRouter/trpc.router gate the v9 chain-router shape.

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files

Instance Method Detail

def analyze #

[View source]