IF Commons GitHub

physical/catalog

Written to: 1 requirement: 0 proved, 0 partly, 0 failing, 1 with no test recorded. 0004-planning-sources FR-011

What the sources of Planning are, as data (0037-planning FR-015, FR-031, FR-046, FR-047): the names of the sources built and of the sources reserved for the later phase (a source of the list is not registered until the specification of the standard or the service it reads has been read and cited), the row of each source in the matrix of what a source can hold, with an outcome and a reason for every field, and the rule that a journal of Evidence Capture is not read as items by any source, only cited by a locator and the digest of an entry.

import { BUILT_SOURCES, RESERVED_SOURCES } from "./catalog.ts";
BUILT_SOURCES.some((n) => RESERVED_SOURCES.includes(n)); // false

Source: commons/planning/src/physical/catalog.ts

0 of 16 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

physical.BUILT_SOURCESconstno test imports it
const BUILT_SOURCES: readonly ["issues", "event-files", "markdown", "comments", "githost"]

The sources built.

physical.RESERVED_SOURCESconstno test imports it
const RESERVED_SOURCES: readonly ["sarif", "tests", "dependabot", "renovate", "icalendar", "linear", "jira", "quality-system", "pentest"]

The sources whose names are reserved: not written until the specification of what each reads has been read and cited (0037-planning FR-031).

physical.RegisterProblemtypeno test imports it
type RegisterProblem = { readonly kind: "reserved" | "duplicate"; readonly name: string };

Why a source cannot be registered.

physical.registerSourcefunctionno test imports it
function registerSource(list: readonly Source[], source: Source): Result<readonly Source[], RegisterProblem>

A list of sources with source added, or why it cannot be: a name reserved for the later phase, or one already there.

physical.SOURCE_ROWSconstno test imports it
const SOURCE_ROWS: readonly SourceRow[]

The rows of the matrix, one for each source built: every field ends expressed, carried or unexpressed with its reason.

physical.isJournalPathconstno test imports it
const isJournalPath: (path: string) => boolean

Whether a path is a day's journal of Evidence Capture: no source reads it as items and none changes it.

physical.CitationProblemtypeno test imports it
type CitationProblem = { readonly kind: "not-a-journal" | "bad-line" | "bad-digest"; readonly message: string };

Why an entry cannot be cited.

physical.citeJournalEntryfunctionno test imports it
function citeJournalEntry(path: string, line: number, digest: string): Result<{ readonly locator: Locator; readonly fingerprint: string; }, CitationProblem>

The locator and the fingerprint of the citation of one entry of a journal: the day's file and the line, and the entry's own digest. A journal is cited and never read as items.

BUILT_SOURCESconstno test imports it
const BUILT_SOURCES: readonly ["issues", "event-files", "markdown", "comments", "githost"]

The sources built.

RESERVED_SOURCESconstno test imports it
const RESERVED_SOURCES: readonly ["sarif", "tests", "dependabot", "renovate", "icalendar", "linear", "jira", "quality-system", "pentest"]

The sources whose names are reserved: not written until the specification of what each reads has been read and cited (0037-planning FR-031).

RegisterProblemtypeno test imports it
type RegisterProblem = { readonly kind: "reserved" | "duplicate"; readonly name: string };

Why a source cannot be registered.

registerSourcefunctionno test imports it
function registerSource(list: readonly Source[], source: Source): Result<readonly Source[], RegisterProblem>

A list of sources with source added, or why it cannot be: a name reserved for the later phase, or one already there.

SOURCE_ROWSconstno test imports it
const SOURCE_ROWS: readonly SourceRow[]

The rows of the matrix, one for each source built: every field ends expressed, carried or unexpressed with its reason.

isJournalPathconstno test imports it
const isJournalPath: (path: string) => boolean

Whether a path is a day's journal of Evidence Capture: no source reads it as items and none changes it.

CitationProblemtypeno test imports it
type CitationProblem = { readonly kind: "not-a-journal" | "bad-line" | "bad-digest"; readonly message: string };

Why an entry cannot be cited.

citeJournalEntryfunctionno test imports it
function citeJournalEntry(path: string, line: number, digest: string): Result<{ readonly locator: Locator; readonly fingerprint: string; }, CitationProblem>

The locator and the fingerprint of the citation of one entry of a journal: the day's file and the line, and the entry's own digest. A journal is cited and never read as items.

Titles, headings, exports, tables, columns and requirements. Esc closes.