class Detector::Specification::PayloadCms

Overview

Payload CMS generates a REST surface from its collection and global configs: /api/<slug> for collections, /api/globals/<slug> for globals, plus whatever endpoints: [...] declares.

CollectionConfig / GlobalConfig are types exported by the payload package and appear essentially nowhere else, which is what separates a Payload config from the many unrelated TS files that also carry slug: and fields: (Astro content collections, Sanity schemas, Keystone lists).

The deliberate cost is plain-JS configs with no type annotation. Matching bare slug: + fields: would trip on all three of the above, so that gap is accepted.

Defined in:

detector/detectors/specification/payload_cms.cr

Constant Summary

BUILD_CONFIG = /\bbuildConfig\s*\(/
COLLECTION_MARKER = /\bCollectionConfig\b/
CONFIG_EXTENSIONS = {".ts", ".tsx", ".js", ".mjs", ".cjs", ".mts", ".cts"}
FIELDS_MARKER = /\bfields\s*:\s*\[/
GLOBAL_MARKER = /\bGlobalConfig\b/
PAYLOAD_MARKER = /\bCollectionConfig\b|\bGlobalConfig\b|\bbuildConfig\s*\(/

Single combined gate, checked before anything else. This detector is applicable to every JS/TS file in the tree and is non-idempotent, so #detect runs on all of them for the whole scan — and vendored bundles (compiled/*.min.js) can be megabytes each. Running the individual markers unconditionally meant three full scans per file and cost ~4x the total scan time on a large TS monorepo.

SLUG_MARKER = /\bslug\s*:\s*['"]/

A config object always declares both.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, base_relative_path(filename : String) : String base_relative_path, content_matches?(file_contents : String, markers : Regex) : Bool content_matches?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

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

Macros inherited from class Detector

detector_for(tech, extensions = nil, basenames = nil, path_segments = nil, idempotent = nil) detector_for

Class Method Detail

def self.tech_name : String #

The tech name without needing an instance, so the registry can be read off the classes themselves rather than from a parallel list.


[View source]

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

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 #

Registers every collection, global and config path in CodeLocator.


[View source]
def set_name #

Registers every collection, global and config path in CodeLocator.


[View source]