All items 95

Interfaces 2§

SourceExtension public APIRequirements\SourceReads a source format and selects the units that coverage counts and evidence quotes.
RunnerExtension public APIRequirements\TestExecutes one linked test target and reports what actually ran.

Classes 93§

BootstrapRequirements\ConfigLoads the bootstrap file a configuration names, so extension classes can be found.
CoverageThresholdsRequirements\ConfigReads the per-source coverage thresholds of the configuration.
DefinitionReaderRequirements\ConfigReads the definition files that the configuration's patterns match.
DefinitionsRequirements\ConfigThe items and sources of every definition file of a project.
DocumentReaderRequirements\ConfigReads configuration and definition documents written in YAML or Markdown.
ExtensionClassesRequirements\ConfigReads the extension class names a configuration registers by name.
JsonSchemaFileRequirements\ConfigValidates a document against a JSON Schema read from a file.
LinkValidatorRequirements\ConfigResolves the links between items and from items to runners.
LoaderRequirements\ConfigLoads a project from its requirements.yaml and the definition files it names.
MarkdownDocumentRequirements\ConfigReads a definition written as Markdown cards and writes it back in the same form.
SchemaValidatorRequirements\ConfigValidates documents against the bundled JSON Schemas and any local schema they declare.
BadgesRequirements\Config\MarkdownReads and writes the badge rows that carry a card's kind, status, origin, category and labels.
CardReaderRequirements\Config\MarkdownReads the item cards of a Markdown definition body.
CitationRequirements\Config\MarkdownLinks quoted evidence to the unit of the definition's source it quotes.
FieldReaderRequirements\Config\MarkdownReads the value of one bold field section of a card.
FieldSectionsRequirements\Config\MarkdownReads the bold field sections that end a card, such as tests or reason.
FrontmatterRequirements\Config\MarkdownSplits a Markdown definition into its YAML frontmatter and its card body.
LocalPathRequirements\Config\MarkdownNormalizes local paths so a citation and the source URI can be compared.
MetadataReaderRequirements\Config\MarkdownReads the metadata field: nested lists of "**key:** value" entries or plain values.
NodesRequirements\Config\MarkdownReads the CommonMark nodes that cards are built from, and escapes text written back.
PresentationRequirements\Config\MarkdownWhat a Markdown definition says beyond its data: link targets, badge images and citations.
QuotationRequirements\Config\MarkdownReads and writes one evidence quotation of a card.
QuotationBlocksRequirements\Config\MarkdownReads the evidence quotations that follow a card's statement.
ReferenceRequirements\Config\MarkdownA Markdown link from one item to another, checked once every definition is loaded.
StaticBadgeRequirements\Config\MarkdownChecks that a static shields.io badge image shows the value and role its alt text and title declare, so the rendered card cannot mislead.
AllowedBlocksRequirements\Config\Markdown\ProfileChecks that a block and its nested blocks are of the kinds the profile allows anywhere.
BlockKindRequirements\Config\Markdown\ProfileNames block kinds the way the profile does.
DocumentSchemaRequirements\Config\Markdown\ProfileEvaluates the bundled document-schema profile; it is not a general dialect implementation.
OccurrencesRequirements\Config\Markdown\ProfileChecks the minContains and maxContains constraints of the profile.
SectionBlocksRequirements\Config\Markdown\ProfileChecks the blocks of one item section against the ordered block entries of the profile.
TextConstraintRequirements\Config\Markdown\ProfileEvaluates the pattern, const and enum text constraints of the profile.
CardWriterRequirements\Config\Markdown\RenderWrites a definition as Markdown cards in the canonical layout.
FieldWriterRequirements\Config\Markdown\RenderWrites the value of one bold field section of a card.
MetadataWriterRequirements\Config\Markdown\RenderWrites metadata as nested lists of "**key:** value" entries or plain values.
RecordRequirements\Config\Markdown\RenderReads the fields of a record of a decoded definition.
Application public APIRequirements\ConsoleThe requirements command line: lint, check, coverage, spec and format.
CommandHandlerRequirements\ConsoleRuns one command: loads the project, executes the command and reports the result.
CommandLineRequirements\ConsoleDeclares the commands, their options and the global options of the command line.
CoverageTableRequirements\ConsoleRenders the coverage report as one row per scope: overall, each source and changed units.
ExecutorRequirements\ConsoleExecutes a command against a loaded project and returns its report.
FormatterRequirements\ConsoleRewrites configuration and definition documents in their canonical form.
ItemRecordRequirements\ConsoleDescribes an item as the complete traceability record of the spec report.
OptionsRequirements\ConsoleThe command and the option values given on the command line.
OverviewRequirements\ConsoleShows the application overview when no command, or only help, is requested.
ReporterRequirements\ConsoleRenders a command report as terminal tables and messages.
SpecificationReportRequirements\ConsoleReports selected specifications and applies optional test linkage gates.
SpecificationTableRequirements\ConsoleRenders the spec report: one row per item with its statement, result and passing / linked targets, followed by the failure messages.
TextRequirements\ConsoleMakes report values safe to write to a terminal.
VerdictRequirements\ConsoleRenders the errors of a report and its closing success or failure message.
ConditionOrderRequirements\EarsAccepts the condition clauses of one statement in EARS order.
LiteralMaskRequirements\EarsReplaces quoted and code literals with filler so their words are not read as clauses.
SystemResponseRequirements\EarsChecks the system clause that ends every EARS statement.
ValidatorRequirements\EarsValidates the clause grammar published at https://alistairmavin.com/ears/.
WordingRequirements\EarsDecides whether clause text says anything.
FieldsRequirements\InputNarrows decoded YAML, JSON and Markdown values to the shapes the definitions require.
InvalidInputExceptionRequirements\InputReports configuration, definitions, snapshots or command-line options that cannot be accepted.
ExcerptRequirements\ModelOne piece of evidence: a quotation and the selector of the source unit it quotes.
ItemRequirements\ModelA requirement or specification with its source evidence, links and disposition.
ItemValidatorRequirements\ModelEnforces the rules an item must satisfy on its own, before links between items are checked.
ProjectRequirements\ModelA loaded project: its items and sources, runners, extensions and coverage gates.
Source public APIRequirements\ModelA source document a definition quotes, and the scope of units that coverage counts.
TestReferenceRequirements\ModelA test linked to a specification: the configured runner and the target it runs.
AnalysisRequirements\ReportThe result of analyzing a project's sources: units, scopes, errors and resolved evidence.
AnalyzerRequirements\ReportSelects every declared scope, resolves every evidence entry and records which units the specifications claim.
ClaimsRequirements\ReportRecords which specifications account for each source unit.
CoverageRequirements\ReportBuilds the coverage report and applies the overall, per-source and differential gates.
EvidenceMatcherRequirements\ReportResolves an evidence entry to the one unit of its item's scope that it quotes completely.
SnapshotRequirements\ReportA coverage snapshot lists every source unit in scope with the semantic fingerprint of the records claiming it, and nothing else: no source text. Comparing the current analysis with the snapshot of a trusted base revision yields the new or changed units, which form the differential denominator, and the units the snapshot lists but the scope no longer contains.
SourceUnitRequirements\ReportA unit in scope together with the specifications that claim it.
UnitCollectorRequirements\ReportGathers the units selected by each declared scope and rejects inconsistent selections.
DomSourceRequirements\SourceSelects elements of HTML, XML, IETF XML and Markdown sources with CSS selectors.
DownloadRequirements\SourceDownloads a source document over HTTP(S) within the 16 MiB limit.
JsonPathRequirements\SourceEvaluates the supported JSONPath subset: child names, quoted keys, array indices, wildcards and recursive names.
JsonSourceRequirements\SourceSelects values of a JSON source with a subset of JSONPath.
LocalFileRequirements\SourceReads a local source document within the 16 MiB limit.
RegistryRequirements\SourceThe source extensions available to a project by format.
ResourceLoader public APIRequirements\SourceReads source documents from HTTP(S) URLs or local paths, with pinned snapshots.
ResourceLocationRequirements\SourceResolves where a source document is read from.
SnapshotCacheRequirements\SourceStores a verified source document as its pinned local snapshot.
TextFragmentRequirements\SourceExact-text directives identifying complete units within a declared CSS scope.
TextSourceRequirements\SourceSelects nonblank lines of a plain-text source with lines:START-END or lines:NUMBER.
Unit public APIRequirements\SourceA complete unit of source text at a stable location, such as a paragraph or a line.
BehatRunnerRequirements\TestThe built-in runner for Behat scenarios selected as file.feature:line.
JUnitRequirements\TestReads the verdict of a test run from its JUnit XML reports.
PhpUnitRunnerRequirements\TestThe built-in runner for PHPUnit test methods selected as Class::method.
ProcessRunner public APIRequirements\TestRuns a runner command that writes JUnit XML and reads the verdict from its reports.
RegistryRequirements\TestThe runner extensions available to a project by name.
RunnerConfig public APIRequirements\TestHow a named runner executes: its extension, command, working directory and timeout.
TestResult public APIRequirements\TestThe outcome of running one test target.
TargetResultsRequirements\VerificationSummarizes executed and deferred targets without treating deferred work as a pass.
TestExecutionRequirements\VerificationExecutes distinct targets selected by supported specifications and execution policies.
VerificationResultRequirements\VerificationThe verdict for one item: its status and how many linked targets and tests passed.
VerifierRequirements\VerificationRuns the tests linked to specifications and decides each verdict.