IF Commons GitHub

physical/verbs/common

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0004-anyfs-cli-surfaces FR-006, 0004-anyfs-cli-surfaces FR-007

How a verb of the program is declared on Headless (commons anyfs-cli 0004-anyfs-cli-surfaces FR-006, FR-007; commons headless 0003-headless-output, 0004-headless-cli): a verb is declared once with its words, options, operands and examples, and its action's traits come from the facts table of the governance (VERBS), so that what the command line, the tool server and the documentation say of it is one fact. What every verb that works through the POSIX view shares is here: binding its words to stores, --explain, --strict, the lines of -v, and the walk of a directory.

import { traitsOf } from "./common.ts";
traitsOf("rm").effect; // "destructive"

Source: commons/anyfs-cli/src/physical/verbs/common.ts

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

traitsOffunctionno test imports it
function traitsOf(id: VerbId): ActionTraits

The traits of a verb as an action: its facts and its reach, from the one table.

defineVerbfunctionno test imports it
function defineVerb<S extends Spec>(host: Host, d: VerbDefinition<S>): Command<S>

A verb from its declaration: its summary and traits are the table's.

POSIX_OPTIONSconstno test imports it
const POSIX_OPTIONS: { explain: FlagOption<"default", never>; strict: FlagOption<"default", never>; }

The options every verb that works through the POSIX view takes.

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