class Detector

Direct Known Subclasses

Defined in:

models/detector.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(options : Hash(String, YAML::Any)) #

[View source]

Macro Detail

macro define_getter_methods(names) #

[View source]

Instance Method Detail

def applicable?(filename : String) : Bool #

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def idempotent? : Bool #

Whether the detector can be skipped on subsequent files once it has matched. Defaults to true (idempotent — the detector only signals tech presence). Detectors that perform side effects in #detect (e.g., the C# ASP.NET ones populate the CodeLocator with route-config paths, the OAS/RAML detectors register spec paths) must override to false so the detector pass keeps invoking them on every file.


[View source]
def logger : NoirLogger #

[View source]
def name : String #

[View source]