IF Commons GitHub

governance/catalog

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0002-toolchain-governance FR-007

A catalog: the tools of a fleet or a work, each once, with every need among them and no cycle, in an order where each tool comes after the tools it needs. It is the one place a pin and a hash are written.

import { defineCatalog } from "./catalog.ts";
// defineCatalog([jq, git]) is a Result of a catalog in the order of needs

Source: commons/toolchain/src/governance/catalog.ts

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

Catalogtype
type Catalog = {
  readonly tools: ReadonlyMap<ToolName, Tool>;
  /** The names in an order where each comes after the tools it needs. */
  readonly sequence: readonly ToolName[];
};

A catalog.

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

defineCatalogfunction
function defineCatalog(tools: readonly Tool[]): Result<Catalog, readonly string[]>

A catalog from tools, or every reason it is not one.

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

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