class Analyzer::Typescript::Loopback

Overview

LoopBack 4 (@loopback/rest) routes controller methods with OpenAPI decorators applied directly to the method — @get('/users/{id}'), @post('/users'), @put, @patch, @del (LB4's name for DELETE), plus the generic @operation('get', '/path'). Unlike NestJS there is no mandatory class-level @Controller('prefix'): every decorator already carries the endpoint's full path, so — unlike the NestJS analyzer this one is modeled on — there is no controller/base-path composition step. @api({basePath: ...}) is the one (rarely used) exception; it is not resolved here (see the class doc at the bottom).

Defined in:

analyzer/analyzers/typescript/loopback.cr

Constant Summary

ARRAY_PARAM_LOCATIONS = {"query", "path", "header"}

Request-body param types accepted by @param.array('name', 'query'|'path'|'header', ...).

HTTP_VERBS = {"GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "QUERY"}
LOOPBACK_IMPORT_RE = Regex.union(/from\s*['"]@loopback\/rest['"]/, /from\s*['"]@loopback\/core['"]/, /require\(\s*['"]@loopback\/rest['"]\s*\)/, /require\(\s*['"]@loopback\/core['"]\s*\)/)

Precompiled once — a single PCRE2-JIT scan replaces eight naive String#includes? substring scans over the whole file content.

from '@loopback/rest' (not import.*from ['"]@loopback\/rest['"]) so a multi-line import block — the shape the lb4 CLI scaffolder actually emits (import {\n get,\n post,\n} from '@loopback/rest';) — still matches: . never spans a newline in Crystal regex, but the closing from '<module>' is always on one line.

METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "del" => "DELETE"}

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]