IF Commons GitHub

dialect

Written to: 3 requirements: 3 proved, 0 partly, 0 failing, 0 with no test recorded. 0004-native-pinned-dialect FR-001, 0004-native-pinned-dialect FR-002, 0004-native-pinned-dialect FR-003

The dialect: its guarantees as data (for Archon and for Toolchain), the plan file it renders from an order and a plan, the steps that check and apply it through the program of the dialect, and the observation that gives Archon what is installed. A tool that is installed as pinned is observed as its own desired state, so that Archon's plan says nothing is to be done.

import { nativePinned } from "./dialect.ts";
// nativePinned({ policy }).guarantees.destroy === true

Source: commons/archon-dialect-native-pinned/src/dialect.ts

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

DIALECT_IDconst
const DIALECT_ID: "native-pinned"

The id of the dialect.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

TOOL_DIALECTconst
const TOOL_DIALECT: ToolDialect

The dialect as Toolchain reads it: how exactly it pins, how it checks, where it installs, what it reaches, and that it never builds from source.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

jobOffunction
function jobOf(r: Requirement): ToolJob | undefined

The job a tool requirement of Toolchain asks of this dialect, or nothing where it asks another dialect or is not one.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

DialectOptionstypeno test imports it
type DialectOptions = {
  readonly policy: Policy;
  /** The platform the tools are installed on; this computer's by default. */
  readonly platform?: string;
  /** The folder the files of a render are written in, below the working folder; `.archon` by default. */
  readonly renderRoot?: string;
};

What a dialect is made with.

nativePinnedfunction
function nativePinned(o: DialectOptions): Dialect

The dialect, as the port of Archon takes it.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

observeRequirementsfunction
function observeRequirements(requirements: readonly Requirement[], store: Store, o: { readonly policy: Policy; readonly path?: string | undefined; readonly ask?: Ask | undefined; }): Promise<ReadonlyMap<RequirementId, JsonValue>>

What Archon is given of what is installed: the desired state itself for a tool that is installed as pinned, a state that differs for one that is installed otherwise, nothing for one that is absent.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

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