dev project crossings
Report what this repository declares or configures inside a repository it pins, and with --check fail when there is any
- Command version
0.0.0- Command configuration
dev-tool:dev.project.crossings@0.0.0
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--check, --no-check | boolean | No | false | Fail on any crossing, and on an allowance that excuses nothing. Without it the command reports and exits 0 |
--allow | list[string] | No | [] | A setting this repository may point inside a pinned repository with, spelled <document>:<setting> for every value it holds or <document>:<setting>=<value> for one. A setting is its key path, with a list entry that carries a name addressed as [name]. A repository keeps its standing list under argDefaults in its cli.config.yml, with each entry's reason written beside itRepeatable |
--exclude | list[string] | No | [] | Repository-relative paths or globs the scan does not read beyond the trees it skips anyway; repeatable. A pattern is read the way an ignore file's is -- a leading / roots it at the checkout, and without one it matches a directory of that name at any depth. The trees a toolchain fetches or writes into need no entry, because each is read from what declares it -- the repo adapter for what a language writes, the manifest for where this repository's build catalog is, and vendoredLibraries for where a package it obtains is unpacked. An entry here is what a repository wants skipped on top of thatRepeatable |
It also takes the global arguments.
Output
It answers with a crossings.crossingReport.
Types
crossings.crossingReport
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
crossings | list[crossings.crossing] | No | [] | Each module and configuration value reaching inside a pinned repository that no --allow entry covers. |
unusedAllowances | list[string] | No | [] | Each --allow entry matching no value inside a pinned repository. One left behind by the value it excused would excuse the next one written there. |
documentCount | integer | No | 0 | How many configuration documents were read, tracked or not. |
repositories | list[string] | No | [] | The pinned repositories' checkouts, as .gitmodules declares them. |
crossings.crossing
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
document | string | Yes | The document stating it, as a path from the repository root. | |
setting | string | Yes | The key path of the value inside that document, with a list entry that carries a name addressed as [name]. | |
value | string | Yes | The path the value names. | |
repository | string | Yes | The pinned repository's checkout the path lies in or names. | |
message | string | Yes | Why the value is refused, worded to be read after the document and setting it was found at. |