impl-tool checkout scan
Report what a checkout and its submodules hold that no remote does
- Command version
0.0.0- Command configuration
impl-tool:impl-tool.checkout.scan@0.0.0
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--path | path | No | "." | Directory to scan (default: current directory) |
--issue | string | No | Scan every checkout this issue's work can be sitting in -- its worktree and any other checkout among its directories -- and list every directory that is the issue's, instead of scanning one directory. Never inferred from the directory, because a command asked whether one checkout is clean must not quietly answer about another |
It also takes the global arguments.
Output
It answers with a scan.orphanedWorkReport.
Examples
impl-tool checkout scanReport what the current checkout and its submodules hold that no remote does.
impl-tool checkout scan --issue PROJ-0000123Report the same for every directory the issue's work can be sitting in -- its worktree and anything beside it named for the issue.
Errors
| Code | Meaning | Remedy |
|---|---|---|
TARGET_PATH_NOT_DIRECTORY | The path --path names is not a directory. | Pass --path naming the checkout to act on, or leave it out to act on the current directory. |
NO_CHECKOUT_FOR_ISSUE | No checkout of the issue named exists in any tree scanned. | Check the issue id, or prepare its checkout with issue prepare. |
SCAN_FAILED | Walking the trees for checkouts failed; the message carries the failure. | Repair what the message names and run checkout scan again. |
CHECKOUT_UNREADABLE | A checkout could not be read, so whether it holds work nothing else has is not known. | Inspect the checkout the message names with git and repair it, or remove it once its work is known to be safe. |
ORPHANED_WORK | A checkout holds work -- uncommitted changes, or commits no remote has -- that nothing else holds. | Commit and push the work, or discard it deliberately, before the checkout is removed. |
Also every code of cli:cli
| Code | Meaning | Remedy |
|---|---|---|
REPO_ROOT_VALIDATION_FAILED | The repository root the run was given, by --repo-root or by the directory it was started in, is not a directory that can be acted on. | Run the command from inside the repository, or pass --repo-root naming its root. |
RUNTIME_CONFIG_FAILED | A runtime configuration file the run reads -- the application's cli.config.yml at one of its scopes -- does not load, or sets an argument default a scope may not set. | Correct the file the message names; config init writes one that loads. |
COMMAND_CONFIG_FAILED | The configuration the command itself is declared by does not load, so the command cannot be run. This is a fault in the application as it was built, not in anything the person running it supplied. | Report it against the application's release, with the message; reinstalling the release with update --force replaces a damaged copy. |
MANIFEST_VALIDATION_FAILED | The command reads the repository's manifest.yml, and none was found at the root, or the one found does not load. | Run the command in a repository that has a manifest, pass --manifest naming one, or correct the manifest where the message says it does not load. |
APP_CONFIG_FAILED | The application's own configuration file in the repository does not load against the type the application declares for it. | Correct the file the message names; config init writes one that loads. |
INPUT_VALIDATION_FAILED | An argument the command line gave is not one the command accepts once it is read -- the wrong type, a value outside its choices, or one a rule on the input refuses. | Give the argument as the command's --help describes it. |
OUTPUT_VALIDATION_FAILED | The command answered with data that does not match the output it declares, so the answer was withheld. This is a fault in the command, not in how it was run. | Report it against the application's release, with the command line that produced it. |
PIPE_STDIN_NOT_PIPED | The command was asked to take its input from stdin, by --from-stdin or by - as a document input's value, and nothing is piped to it -- stdin is a terminal, or there is none. | Pipe in the output of a command run with --response-format json, or give the input another value. |
SECRET_NOT_GIVEN | The command takes a secret input, which is never typed on the command line, and nothing was typed at its prompt or piped to its standard input. | Run the command at a terminal and type the value at the prompt, or pipe it to the command's standard input, one line for each secret it takes. |
SECRET_STDIN_CLAIMED | The command takes a secret input from standard input, and standard input already carries its piped inputs -- --from-stdin, or a document input given - -- so there is nothing to read the secret from. | Run the command at a terminal to be asked for the secret, or give its other inputs on the command line. |
PIPE_STDIN_CLAIMED_TWICE | --from-stdin was given beside a document input given - or -:<path>, so the piped answer would be both the command's inputs and one of them. | Keep one of the two forms. |
PIPE_FIELD_NOT_FOUND | A document input given -:<path> names a field the piped answer does not hold -- a key no mapping on the way has, or an index past the end of a list or into something that is no list -- or the text after -: is no path. | Name a field the command before the pipe answers with, as keys joined by . with [<n>] picking an item from a list, as releases[0].notes. |
ENVELOPE_UNREADABLE | What was piped to the command is not an envelope a command writes, so there is no answer in it to take as input. | Run the command before the pipe with --response-format json, and pipe nothing else between the two. |
PIPE_UPSTREAM_FAILED | The command before the pipe refused, so there is no answer to take as input and this command did not run. Its own errors follow this one in the envelope. | Repair what the errors after this one name, in the command before the pipe, and run the pipeline again. |
PIPE_ANSWER_NOT_INPUTS | --from-stdin takes the piped answer as the command's inputs by name, and the answer is no mapping, or carries a field the command declares no input for. | Pipe in a command whose answer holds only this command's inputs, or give the answer to one document input with - instead. |
UNHANDLED_EXCEPTION | The command failed in a way nothing anticipated, and the message is the failure's own text. | Report it against the application's release, with the command line and the message. |
APPLICATION_RELEASE_NAME_UNKNOWN | The application could not tell which release it is -- the project it was released with, or which of that project's applications it is -- so it cannot look its releases up. | Run the application as it was installed, from the directory toolchain install placed it in, or report it against the release. |
Exit codes
| Code | Meaning |
|---|---|
0 | The command answered; the envelope's status is success and errors is empty. |
1 | The command or the framework refused; the envelope's status is error and errors names each code, with its message. |
2 | The command line could not be read -- an unknown command, a missing or unknown argument -- so nothing ran and no envelope was written; the usage is printed instead. |
Types
scan.orphanedWorkReport
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workdir | string | Yes | The checkout the scan started from: the directory the command was pointed at, or with --issue the first of the issue's trees | |
checkouts | list[checkoutWork] | No | [] | One row for each checkout walked, a tree's top-level repository first and its submodules after it, saying what it holds that no remote does. With --issue, a tree that was looked for and not found is a row too |
folder | string | No | "" | The issue's folder under workspacesRoot. Empty without --issue, and where no workspacesRoot is configured |
directories | list[issueDirectory] | No | [] | With --issue, every directory that is the issue's: what is inside its folder, and whatever stands beside the folder under a name carrying the issue's id. Empty without --issue |
toolRoot | toolRootState | No | {} | With --issue, the state of the tools directory the issue's own executable is installed under. It holds no work, so it never fails the scan |