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"}
SPLIT_TOP_LEVEL_RULES = Noir::TopLevelSplit::Rules.new(nest: (Noir::TopLevelSplit::Nest::Paren | Noir::TopLevelSplit::Nest::Bracket) | Noir::TopLevelSplit::Nest::Brace, quotes: "\"'`", escape: Noir::TopLevelSplit::Escape::InQuotes, strip: true, empties: Noir::TopLevelSplit::Empties::DropAll, per_kind: false, clamp: true)

Rules::JS except that one depth counter is shared by (), [] and {} instead of one per kind — this file's copy tracked a single depth where nestjs.cr and loopback.cr tracked three. Only observable on the unbalanced fragments these actually receive: on "[a)b, c" the shared counter reads ) as closing the [ and splits, where Rules::JS stays at bracket depth 1 and returns one part.

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.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, 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, tech : String tech, 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

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, 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_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, 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, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]