Skip to main content

Module add

Module add 

Source
Expand description

add <module>: a module of the game’s engine turned on (ADR-0009 §6). It:

  1. turns on the module’s feature of the shuyi crate in the game’s Cargo.toml, keeping its layout (catalog::turn_on);
  2. copies the module’s skill into the game’s skills (.claude/skills), if the game keeps them (catalog::copy_skill);
  3. gives the first paragraph of the module’s README: what it is for;
  4. says so when the game already has one of its alternatives on, with the README’s section on using both (BESIDE);
  5. gives the line to add when the game’s code never installs the modules it turns on (shuyi::enabled_modules), and the line for the game’s formats() when the module adds formats.

Run twice, the second run changes nothing and says so (changed: false). A name that is no module of the engine fails with codes::UNKNOWN_MODULE and the names there are.

Structs§

AddInput
What add turns on.
AddOutput
What add did, and what is left to the game.

Constants§

BESIDE
The anchor of a module README’s section on sitting beside its alternatives, and moving between them (its fifth, ADR-0009 §4): ## Beside its alternatives.

Functions§

add
add on the game of project, in the engine it builds with.
add_in
add on the game at game, with the engine’s catalog.
parse_args
Reads add’s arguments (not --json).
text
What add did, for people.
usage
add’s usage.