Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
module-kit
command
Command module-kit is the authors' CLI of NovaTrail's module format (architecture 3.7 in spec; architecture 3.6): check checks a module, and warns of a picture that is not opaque; build builds its package as files; index builds the module index of a release of modules; and diff compares a new version of a module with the published ones, by the library of this module.
|
Command module-kit is the authors' CLI of NovaTrail's module format (architecture 3.7 in spec; architecture 3.6): check checks a module, and warns of a picture that is not opaque; build builds its package as files; index builds the module index of a release of modules; and diff compares a new version of a module with the published ones, by the library of this module. |
|
internal
|
|
|
canonical
Package canonical writes the canonical text of a JSON value — of a package, a module index and an open view — and stops with an error on a value the format cannot hold (format/README.md, section 25; R09).
|
Package canonical writes the canonical text of a JSON value — of a package, a module index and an open view — and stops with an error on a value the format cannot hold (format/README.md, section 25; R09). |
|
normal
Package normal normalizes a text as the check kinds of the module format and its leak check do, and reads a number in the notation that a kind takes (format/README.md, sections 15 and 20): the steps 1 to 7 of a number and the units of step 6, the normal form of a choice, and a number in notation as an exact rational.
|
Package normal normalizes a text as the check kinds of the module format and its leak check do, and reads a number in the notation that a kind takes (format/README.md, sections 15 and 20): the steps 1 to 7 of a number and the units of step 6, the normal form of a choice, and a number in notation as an exact rational. |
|
random
Package random is the generator of the format and its places of randomness, written from the constants of the format's text rather than taken from math/rand/v2, with an error on an argument outside a function's domain (format/README.md, section 22; R59 spec; R10).
|
Package random is the generator of the format and its places of randomness, written from the constants of the format's text rather than taken from math/rand/v2, with an error on an argument outside a function's domain (format/README.md, section 22; R59 spec; R10). |
|
sandbox
Package sandbox runs the Starlark of the format — the predicate of a check, the expressions of a template and its solver — in go.starlark.net at the version the format names, in its one dialect, with the format's limits of steps and module-kit's clocks, on the caller's goroutine and with its context (format/README.md, sections 15, 23 and 24; R88 spec; R11; architecture 3.4).
|
Package sandbox runs the Starlark of the format — the predicate of a check, the expressions of a template and its solver — in go.starlark.net at the version the format names, in its one dialect, with the format's limits of steps and module-kit's clocks, on the caller's goroutine and with its context (format/README.md, sections 15, 23 and 24; R88 spec; R11; architecture 3.4). |
|
schema
Package schema checks a value against the JSON Schema 2020-12 schemas of the format version the library reads, reporting every keyword that fails with its place (format/README.md, sections 5 and 8), and builds the open view of a value from the marks x-open in the same schemas (section 6).
|
Package schema checks a value against the JSON Schema 2020-12 schemas of the format version the library reads, reporting every keyword that fails with its place (format/README.md, sections 5 and 8), and builds the open view of a value from the marks x-open in the same schemas (section 6). |
|
semver
Package semver reads a version of a module, X.Y.Z, and orders two of them by Semantic Versioning 2.0.0, as the format writes a version: three decimal numerals with no leading zero, and no pre-release and no build metadata (format/README.md, sections 26 and 27; R46 spec).
|
Package semver reads a version of a module, X.Y.Z, and orders two of them by Semantic Versioning 2.0.0, as the format writes a version: three decimal numerals with no leading zero, and no pre-release and no build metadata (format/README.md, sections 26 and 27; R46 spec). |
|
vectors
Package vectors runs every example and test vector of the module format — spec.Format, at the version go.mod requires — and the vectors of the observation, observation/v1/ of contracts.Vectors, against module-kit: an implementation that does not pass them does not conform (format/README.md, sections 1, 8 and 9; contracts/README.md, section 10).
|
Package vectors runs every example and test vector of the module format — spec.Format, at the version go.mod requires — and the vectors of the observation, observation/v1/ of contracts.Vectors, against module-kit: an implementation that does not pass them does not conform (format/README.md, sections 1, 8 and 9; contracts/README.md, section 10). |
|
yaml
Package yaml reads a file of a module, YAML 1.2.2 under its Core schema, into a JSON value, and refuses a file that breaks a rule yaml.*, naming the rule and its place, or that is not YAML 1.2.2 at all (format/README.md, section 4; R45 spec).
|
Package yaml reads a file of a module, YAML 1.2.2 under its Core schema, into a JSON value, and refuses a file that breaks a rule yaml.*, naming the rule and its place, or that is not YAML 1.2.2 at all (format/README.md, section 4; R45 spec). |
|
Package leak finds the keys and the leak phrases of a task in a text: in the tutor's words before they reach the device, for api, and in the texts of a module that a learner sees before solving, for the check of a module, which holds task.no-leaks and lesson.no-leaks by it (format/README.md, section 20; R54 spec, R57 spec; R30).
|
Package leak finds the keys and the leak phrases of a task in a text: in the tutor's words before they reach the device, for api, and in the texts of a module that a learner sees before solving, for the check of a module, which holds task.no-leaks and lesson.no-leaks by it (format/README.md, section 20; R54 spec, R57 spec; R30). |
|
Package module reads an author's module and checks it as the module format says: its layout and the version of the format it names, each file against the schema of its part, and the format rules of each part, between parts and of the whole module — the tiers of the skill graph, the templates with every instance and solver, and the leak check of the texts a learner sees before solving among them (format/README.md, sections 2 and 4–24).
|
Package module reads an author's module and checks it as the module format says: its layout and the version of the format it names, each file against the schema of its part, and the format rules of each part, between parts and of the whole module — the tiers of the skill graph, the templates with every instance and solver, and the leak check of the texts a learner sees before solving among them (format/README.md, sections 2 and 4–24). |
|
Package moduleindex builds the module index of a release from the previous index, the release's packages, its tag and its withdrawals, refusing by the rules module-index.*; reads an index of any version of the format by the places every version keeps; and picks the version of a module for a new attempt: the newest by semver that is not withdrawn and lies in the format's window (format/README.md, sections 2 and 26; R63 spec; R16).
|
Package moduleindex builds the module index of a release from the previous index, the release's packages, its tag and its withdrawals, refusing by the rules module-index.*; reads an index of any version of the format by the places every version keeps; and picks the version of a module for a new attempt: the newest by semver that is not withdrawn and lies in the format's window (format/README.md, sections 2 and 26; R63 spec; R16). |
|
Package modulepackage builds the package of a checked module — its canonical view, the listing of its device part and its inventory, with their digests — and reads a package as files by the chain of digests from the digest an index gives: inventory, then parts, then files (format/README.md, section 25; R62 spec).
|
Package modulepackage builds the package of a checked module — its canonical view, the listing of its device part and its inventory, with their digests — and reads a package as files by the chain of digests from the digest an index gives: inventory, then parts, then files (format/README.md, section 25; R62 spec). |
|
Package moduleversion compares a new version of a module with its published ones: it finds the part of the version that the change asks for, by the table of format/README.md, section 27, and reports every change at its place (R89 spec, R101 spec; R13, R36).
|
Package moduleversion compares a new version of a module with its published ones: it finds the part of the version that the change asks for, by the table of format/README.md, section 27, and reports every change at its place (R89 spec, R101 spec; R13, R36). |
|
Package observation holds what module-kit does with an observation, novatrail.observation.v1: which one is valid, how the observations of two readers join into one, answer slot by answer slot, which verdict the observation gives with the options tapped beside it, and how the submission of an essay ends (contracts/README.md, section 10; R86 spec; R29).
|
Package observation holds what module-kit does with an observation, novatrail.observation.v1: which one is valid, how the observations of two readers join into one, answer slot by answer slot, which verdict the observation gives with the options tapped beside it, and how the submission of an essay ends (contracts/README.md, section 10; R86 spec; R29). |
|
Package openview builds the open view of a part of a module and of an instance of a template — what the learner's app receives: the part without its closed fields — from the marks x-open in the schemas of the format, and the digest of the open view of a task and of an instance (format/README.md, section 6; R05 spec; R93 spec).
|
Package openview builds the open view of a part of a module and of an instance of a template — what the learner's app receives: the part without its closed fields — from the marks x-open in the schemas of the format, and the digest of the open view of a task and of an instance (format/README.md, section 6; R05 spec; R93 spec). |
|
Package picture reads the pictures of a module for what the format asks of them but does not refuse: a picture SHOULD have an opaque background, and module-kit warns of one with a pixel that is not fully opaque (format/README.md, section 14; the second amendment of 2026-11-01 to R51 in spec).
|
Package picture reads the pictures of a module for what the format asks of them but does not refuse: a picture SHOULD have an opaque background, and module-kit warns of one with a pixel that is not fully opaque (format/README.md, section 14; the second amendment of 2026-11-01 to R51 in spec). |
|
Package template fills the templates of tasks: it counts the instances of a template, runs its solver on them, builds each one with its numbers, and picks the instance of an attempt from the attempt's seed (format/README.md, sections 22–24; R60 spec, R61 spec).
|
Package template fills the templates of tasks: it counts the instances of a template, runs its solver on them, builds each one with its numbers, and picks the instance of an attempt from the attempt's seed (format/README.md, sections 22–24; R60 spec, R61 spec). |
|
Package verdict gives the verdict of an answer slot and of an item on the values read in them, by the check kinds of the module format and their normalization, with the reason of a value that cannot be read and the trap of a wrong one (format/README.md, section 15).
|
Package verdict gives the verdict of an answer slot and of an item on the values read in them, by the check kinds of the module format and their normalization, with the reason of a value that cannot be read and the trap of a wrong one (format/README.md, section 15). |
Click to show internal directories.
Click to hide internal directories.