IF Commons GitHub

desired

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0002-workspace-model FR-021

What the manifest wants, as the plan reads it (commons 0002-workspace-model FR-021, 0003-host FR-013): the repositories with the settings of their own local Git configuration, the worktrees, and the generated files with the SHA-256 of their bytes. The target state of the source state.

The settings are only ever those of a repository's local configuration, never the global or the system's: core.hooksPath (the absolute path of <home>/.ergonex/hooks, with / between segments), the commit signing the policy requires (commit.gpgsign, gpg.format, user.signingkey), user.name and user.email where the manifest names them, and on Windows core.longpaths. Pure: the root and the platform are arguments.

Source: commons/ergonex/src/desired.ts

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

digestsOffunctionno test imports it
function digestsOf(files: readonly GeneratedFile[]): Promise<ReadonlyMap<string, Sha256>>

The digest of a set of files by path, which verify and render compare with the disk and the record.

DesiredFactstypeno test imports it
type DesiredFacts = {
  /** The root, as an absolute path with `/` between segments (`C:/Users/a/workspaces` on Windows). */
  readonly homePosix: string;
  readonly windows: boolean;
};

What the settings depend on besides the manifest.

desiredOffunctionno test imports it
function desiredOf(manifest: Manifest, files: readonly GeneratedFile[], facts: DesiredFacts): Promise<Desired>

What the manifest and its generated files want.

settingsOffunction
function settingsOf(manifest: Manifest, facts: DesiredFacts): Readonly<Record<string, string>>

The settings of every managed repository's local configuration, key to value.

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

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