repo-adapter-api:adapter-outputs

repo-adapter-api:adapter-outputs@0.0.0

AdapterCommandInvocation

FieldTypeRequiredDefaultDescription
programstringYesThe shell the host started to run the command, by its executable's file name without a directory
argslist[string]No[]The arguments the shell was started with, in order: its own flags, then the command line it was given to run

AdapterCommandDescriptor

FieldTypeRequiredDefaultDescription
executablestringYesThe program the adapter asked the host to run, as the adapter named it
argslist[string]No[]The arguments the adapter asked for it to be run with, in order

AdapterCommandExecution

FieldTypeRequiredDefaultDescription
adapterstringYesThe shell adapter that ran the command, by name: the shell the host is configured to run commands through
commandstringYesThe command line the shell was given: the program and its arguments, quoted as that shell reads them
invocationAdapterCommandInvocationYesThe process the host started to run it: the shell's executable and the arguments it was started with
exitCodeintegerYesThe exit code the process ended with; 0 is success
stdoutstringYesWhat the command wrote to standard output, cut to its tail where it is longer than a response field holds. Empty where the output was streamed to the terminal as it ran and not captured.
stderrstringYesWhat the command wrote to standard error, cut to its tail where it is longer than a response field holds. Empty where the output was streamed to the terminal as it ran and not captured.

AdapterExecutionSummary

FieldTypeRequiredDefaultDescription
stdoutstringYesThe standard output of every command that ran, in the order they ran, joined by newlines and cut to its tail where it is longer than a response field holds. Empty where the output was streamed and not captured.
stderrstringYesThe standard error of every command that ran, in the order they ran, joined by newlines and cut to its tail where it is longer than a response field holds. Empty where the output was streamed and not captured.
exitCodeintegerYesThe exit code of the first command that failed, after which no later one is run, or 0 where every command passed or there was nothing to run
durationMsintegerNoHow long the run took, in whole milliseconds, where the command reporting it timed one: every repository it crossed into included, since a recursive run is one run. Absent where nothing timed it
commandslist[AdapterCommandDescriptor]No[]Every command the adapter asked for, in the order it asked, whether or not the run reached it. Empty where there was nothing to run.

AdapterResult

FieldTypeRequiredDefaultDescription
adapterAdapterExecutionSummaryYesThe run as a whole: the commands the adapter asked for, their combined output and the exit code the run ended with
adapterResultslist[AdapterCommandExecution]No[]One record for each command that was started, in the order they ran, ending at the first that failed. Empty where no command ran, which is how a run that had nothing to do is told from one that did something.

AdapterUnavailable

FieldTypeRequiredDefaultDescription
messagestringNo"Repo adapter command is unavailable for the selected modules/repo adapters."Why nothing ran: which command no repo adapter of the selected modules implements

PackagedFile

FieldTypeRequiredDefaultDescription
sourcepathYesWhere the file is on disk when the application is packaged
destinationstringYesThe directory the application looks for the file in once it is running, written with forward slashes and counted from the directory the code reading it is imported from, which is not the repository root where packages sit under a directory of their own

PackagingInputs

FieldTypeRequiredDefaultDescription
modulesLoadedByNamelist[string]No[]Modules the application loads by name at run time, which no import statement names
packagesLoadedByNamelist[string]No[]Packages whose every module, at any depth, is loaded by name at run time: discovered rather than imported
fileslist[PackagedFile]No[]Files the application reads after it has started, and where it looks for each
excludedPackageslist[string]No[]Packages that are not part of the application: nothing in or beneath one belongs in the artifact, whatever import or entry above reaches it
obtainedPackageRootslist[path]No[]Directories the application's obtained packages are imported from: code that is part of the application and was fetched into the tree rather than written or installed there, so nothing a packager already searches leads to it

VendoredRequirementsFile

FieldTypeRequiredDefaultDescription
pathpathYesWhere the file goes, relative to the consuming repository root
contentstringYesWhat the file holds, rendered whole

AdapterOutput

One of the types AdapterResult, AdapterUnavailable.