@fnndsc/brasa 0.56.2 → 0.56.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/buildinfo.json +1 -1
- package/dist/builtins/berth/berthCube.d.ts +3 -2
- package/dist/builtins/berth/berthCube.js +5 -10
- package/dist/builtins/berth/berthCube.js.map +1 -1
- package/dist/builtins/debug.d.ts +24 -3
- package/dist/builtins/debug.js +66 -13
- package/dist/builtins/debug.js.map +1 -1
- package/dist/builtins/fs/acl.args.d.ts +5 -38
- package/dist/builtins/fs/acl.args.js +6 -72
- package/dist/builtins/fs/acl.args.js.map +1 -1
- package/dist/builtins/fs/acl.d.ts +100 -10
- package/dist/builtins/fs/acl.js +222 -68
- package/dist/builtins/fs/acl.js.map +1 -1
- package/dist/builtins/fs/cat.args.d.ts +14 -15
- package/dist/builtins/fs/cat.args.js +13 -40
- package/dist/builtins/fs/cat.args.js.map +1 -1
- package/dist/builtins/fs/cat.d.ts +40 -3
- package/dist/builtins/fs/cat.js +89 -10
- package/dist/builtins/fs/cat.js.map +1 -1
- package/dist/builtins/fs/cd.d.ts +24 -6
- package/dist/builtins/fs/cd.js +71 -18
- package/dist/builtins/fs/cd.js.map +1 -1
- package/dist/builtins/fs/configWrite.d.ts +24 -8
- package/dist/builtins/fs/configWrite.js +77 -36
- package/dist/builtins/fs/configWrite.js.map +1 -1
- package/dist/builtins/fs/cp.d.ts +39 -4
- package/dist/builtins/fs/cp.js +120 -55
- package/dist/builtins/fs/cp.js.map +1 -1
- package/dist/builtins/fs/du.d.ts +59 -33
- package/dist/builtins/fs/du.js +111 -79
- package/dist/builtins/fs/du.js.map +1 -1
- package/dist/builtins/fs/edit.d.ts +19 -4
- package/dist/builtins/fs/edit.js +77 -16
- package/dist/builtins/fs/edit.js.map +1 -1
- package/dist/builtins/fs/find.d.ts +25 -0
- package/dist/builtins/fs/find.js +76 -5
- package/dist/builtins/fs/find.js.map +1 -1
- package/dist/builtins/fs/mkdir.d.ts +28 -18
- package/dist/builtins/fs/mkdir.js +95 -66
- package/dist/builtins/fs/mkdir.js.map +1 -1
- package/dist/builtins/fs/mv.d.ts +34 -4
- package/dist/builtins/fs/mv.js +129 -64
- package/dist/builtins/fs/mv.js.map +1 -1
- package/dist/builtins/fs/pull.args.d.ts +56 -17
- package/dist/builtins/fs/pull.args.js +16 -66
- package/dist/builtins/fs/pull.args.js.map +1 -1
- package/dist/builtins/fs/pull.d.ts +62 -0
- package/dist/builtins/fs/pull.js +86 -22
- package/dist/builtins/fs/pull.js.map +1 -1
- package/dist/builtins/fs/pwd.d.ts +19 -5
- package/dist/builtins/fs/pwd.js +62 -8
- package/dist/builtins/fs/pwd.js.map +1 -1
- package/dist/builtins/fs/rm.d.ts +58 -21
- package/dist/builtins/fs/rm.js +99 -82
- package/dist/builtins/fs/rm.js.map +1 -1
- package/dist/builtins/fs/rmdir.d.ts +29 -11
- package/dist/builtins/fs/rmdir.js +87 -36
- package/dist/builtins/fs/rmdir.js.map +1 -1
- package/dist/builtins/fs/touch.d.ts +44 -9
- package/dist/builtins/fs/touch.js +91 -27
- package/dist/builtins/fs/touch.js.map +1 -1
- package/dist/builtins/fs/tree.d.ts +36 -9
- package/dist/builtins/fs/tree.js +126 -36
- package/dist/builtins/fs/tree.js.map +1 -1
- package/dist/builtins/fs/upload.d.ts +22 -3
- package/dist/builtins/fs/upload.js +82 -14
- package/dist/builtins/fs/upload.js.map +1 -1
- package/dist/builtins/fs/xattr.args.d.ts +12 -33
- package/dist/builtins/fs/xattr.args.js +17 -95
- package/dist/builtins/fs/xattr.args.js.map +1 -1
- package/dist/builtins/fs/xattr.d.ts +98 -8
- package/dist/builtins/fs/xattr.js +163 -24
- package/dist/builtins/fs/xattr.js.map +1 -1
- package/dist/builtins/games/bytes.d.ts +201 -5
- package/dist/builtins/games/bytes.js +255 -54
- package/dist/builtins/games/bytes.js.map +1 -1
- package/dist/builtins/games/chimes.d.ts +180 -3
- package/dist/builtins/games/chimes.js +203 -26
- package/dist/builtins/games/chimes.js.map +1 -1
- package/dist/builtins/games/chrislab.d.ts +101 -3
- package/dist/builtins/games/chrislab.js +117 -17
- package/dist/builtins/games/chrislab.js.map +1 -1
- package/dist/builtins/games/cowsay.d.ts +93 -2
- package/dist/builtins/games/cowsay.js +90 -31
- package/dist/builtins/games/cowsay.js.map +1 -1
- package/dist/builtins/games/figlet.d.ts +70 -2
- package/dist/builtins/games/figlet.js +83 -6
- package/dist/builtins/games/figlet.js.map +1 -1
- package/dist/builtins/games/lab.d.ts +104 -5
- package/dist/builtins/games/lab.js +144 -6
- package/dist/builtins/games/lab.js.map +1 -1
- package/dist/builtins/games/lolcat.d.ts +61 -1
- package/dist/builtins/games/lolcat.js +59 -24
- package/dist/builtins/games/lolcat.js.map +1 -1
- package/dist/builtins/games/morse.d.ts +36 -1
- package/dist/builtins/games/morse.js +50 -2
- package/dist/builtins/games/morse.js.map +1 -1
- package/dist/builtins/games/numbers.d.ts +241 -5
- package/dist/builtins/games/numbers.js +298 -23
- package/dist/builtins/games/numbers.js.map +1 -1
- package/dist/builtins/games/play.d.ts +96 -6
- package/dist/builtins/games/play.js +137 -6
- package/dist/builtins/games/play.js.map +1 -1
- package/dist/builtins/games/qr.d.ts +40 -1
- package/dist/builtins/games/qr.js +51 -2
- package/dist/builtins/games/qr.js.map +1 -1
- package/dist/builtins/games/show.d.ts +131 -6
- package/dist/builtins/games/show.js +208 -20
- package/dist/builtins/games/show.js.map +1 -1
- package/dist/builtins/games/sky.d.ts +178 -4
- package/dist/builtins/games/sky.js +228 -12
- package/dist/builtins/games/sky.js.map +1 -1
- package/dist/builtins/games/text.d.ts +258 -7
- package/dist/builtins/games/text.js +310 -29
- package/dist/builtins/games/text.js.map +1 -1
- package/dist/builtins/games/trek.d.ts +67 -3
- package/dist/builtins/games/trek.js +63 -10
- package/dist/builtins/games/trek.js.map +1 -1
- package/dist/builtins/games/wtf.d.ts +58 -1
- package/dist/builtins/games/wtf.js +67 -6
- package/dist/builtins/games/wtf.js.map +1 -1
- package/dist/builtins/help.d.ts +38 -2
- package/dist/builtins/help.js +76 -769
- package/dist/builtins/help.js.map +1 -1
- package/dist/builtins/net/connect.d.ts +36 -3
- package/dist/builtins/net/connect.js +84 -26
- package/dist/builtins/net/connect.js.map +1 -1
- package/dist/builtins/net/cubepath.d.ts +49 -5
- package/dist/builtins/net/cubepath.js +69 -27
- package/dist/builtins/net/cubepath.js.map +1 -1
- package/dist/builtins/net/logout.d.ts +13 -4
- package/dist/builtins/net/logout.js +49 -3
- package/dist/builtins/net/logout.js.map +1 -1
- package/dist/builtins/net/netstat.d.ts +29 -4
- package/dist/builtins/net/netstat.js +64 -23
- package/dist/builtins/net/netstat.js.map +1 -1
- package/dist/builtins/net/pacs.d.ts +169 -15
- package/dist/builtins/net/pacs.js +92 -33
- package/dist/builtins/net/pacs.js.map +1 -1
- package/dist/builtins/net/query.args.d.ts +95 -0
- package/dist/builtins/net/query.args.js +26 -0
- package/dist/builtins/net/query.args.js.map +1 -0
- package/dist/builtins/net/query.d.ts +98 -5
- package/dist/builtins/net/query.js +89 -83
- package/dist/builtins/net/query.js.map +1 -1
- package/dist/builtins/net/status.d.ts +5 -3
- package/dist/builtins/net/status.js +5 -12
- package/dist/builtins/net/status.js.map +1 -1
- package/dist/builtins/parametersofplugin.d.ts +82 -3
- package/dist/builtins/parametersofplugin.js +79 -23
- package/dist/builtins/parametersofplugin.js.map +1 -1
- package/dist/builtins/proc.d.ts +210 -3
- package/dist/builtins/proc.js +210 -119
- package/dist/builtins/proc.js.map +1 -1
- package/dist/builtins/res/compute.d.ts +67 -3
- package/dist/builtins/res/compute.js +121 -35
- package/dist/builtins/res/compute.js.map +1 -1
- package/dist/builtins/res/dicom.d.ts +52 -3
- package/dist/builtins/res/dicom.js +82 -34
- package/dist/builtins/res/dicom.js.map +1 -1
- package/dist/builtins/res/expect.d.ts +52 -3
- package/dist/builtins/res/expect.js +92 -29
- package/dist/builtins/res/expect.js.map +1 -1
- package/dist/builtins/res/feed.d.ts +475 -3
- package/dist/builtins/res/feed.js +253 -158
- package/dist/builtins/res/feed.js.map +1 -1
- package/dist/builtins/res/files.d.ts +517 -3
- package/dist/builtins/res/files.js +124 -44
- package/dist/builtins/res/files.js.map +1 -1
- package/dist/builtins/res/gather.d.ts +113 -3
- package/dist/builtins/res/gather.js +153 -44
- package/dist/builtins/res/gather.js.map +1 -1
- package/dist/builtins/res/gather.process.d.ts +27 -19
- package/dist/builtins/res/gather.process.js +29 -59
- package/dist/builtins/res/gather.process.js.map +1 -1
- package/dist/builtins/res/group.d.ts +284 -3
- package/dist/builtins/res/group.js +147 -76
- package/dist/builtins/res/group.js.map +1 -1
- package/dist/builtins/res/image.d.ts +30 -2
- package/dist/builtins/res/image.js +62 -10
- package/dist/builtins/res/image.js.map +1 -1
- package/dist/builtins/res/play.d.ts +71 -9
- package/dist/builtins/res/play.js +124 -82
- package/dist/builtins/res/play.js.map +1 -1
- package/dist/builtins/res/plugininstance.d.ts +307 -2
- package/dist/builtins/res/plugininstance.js +122 -50
- package/dist/builtins/res/plugininstance.js.map +1 -1
- package/dist/builtins/res/pluginmeta.d.ts +244 -2
- package/dist/builtins/res/pluginmeta.js +98 -40
- package/dist/builtins/res/pluginmeta.js.map +1 -1
- package/dist/builtins/res/record.d.ts +37 -3
- package/dist/builtins/res/record.js +127 -57
- package/dist/builtins/res/record.js.map +1 -1
- package/dist/builtins/res/resourceList.d.ts +136 -0
- package/dist/builtins/res/resourceList.js +51 -0
- package/dist/builtins/res/resourceList.js.map +1 -0
- package/dist/builtins/res/tag.d.ts +244 -3
- package/dist/builtins/res/tag.js +97 -41
- package/dist/builtins/res/tag.js.map +1 -1
- package/dist/builtins/res/user.d.ts +122 -3
- package/dist/builtins/res/user.js +83 -21
- package/dist/builtins/res/user.js.map +1 -1
- package/dist/builtins/res/workflow.d.ts +244 -2
- package/dist/builtins/res/workflow.js +97 -40
- package/dist/builtins/res/workflow.js.map +1 -1
- package/dist/builtins/store.d.ts +85 -3
- package/dist/builtins/store.js +135 -68
- package/dist/builtins/store.js.map +1 -1
- package/dist/builtins/sys/apropos.d.ts +80 -5
- package/dist/builtins/sys/apropos.js +121 -15
- package/dist/builtins/sys/apropos.js.map +1 -1
- package/dist/builtins/sys/cal.d.ts +44 -5
- package/dist/builtins/sys/cal.js +57 -10
- package/dist/builtins/sys/cal.js.map +1 -1
- package/dist/builtins/sys/command.d.ts +20 -0
- package/dist/builtins/sys/command.js +31 -0
- package/dist/builtins/sys/command.js.map +1 -1
- package/dist/builtins/sys/context.d.ts +13 -3
- package/dist/builtins/sys/context.js +51 -4
- package/dist/builtins/sys/context.js.map +1 -1
- package/dist/builtins/sys/date.d.ts +56 -5
- package/dist/builtins/sys/date.js +63 -9
- package/dist/builtins/sys/date.js.map +1 -1
- package/dist/builtins/sys/echo.d.ts +63 -2
- package/dist/builtins/sys/echo.js +87 -8
- package/dist/builtins/sys/echo.js.map +1 -1
- package/dist/builtins/sys/fortune.d.ts +27 -2
- package/dist/builtins/sys/fortune.js +44 -2
- package/dist/builtins/sys/fortune.js.map +1 -1
- package/dist/builtins/sys/grep.d.ts +245 -11
- package/dist/builtins/sys/grep.js +418 -131
- package/dist/builtins/sys/grep.js.map +1 -1
- package/dist/builtins/sys/joblets.d.ts +66 -7
- package/dist/builtins/sys/joblets.js +101 -14
- package/dist/builtins/sys/joblets.js.map +1 -1
- package/dist/builtins/sys/motd.d.ts +37 -3
- package/dist/builtins/sys/motd.js +49 -8
- package/dist/builtins/sys/motd.js.map +1 -1
- package/dist/builtins/sys/notes.d.ts +75 -3
- package/dist/builtins/sys/notes.js +90 -29
- package/dist/builtins/sys/notes.js.map +1 -1
- package/dist/builtins/sys/physicalmode.d.ts +24 -3
- package/dist/builtins/sys/physicalmode.js +68 -14
- package/dist/builtins/sys/physicalmode.js.map +1 -1
- package/dist/builtins/sys/tasks.d.ts +74 -5
- package/dist/builtins/sys/tasks.js +102 -14
- package/dist/builtins/sys/tasks.js.map +1 -1
- package/dist/builtins/sys/textFilters.d.ts +673 -41
- package/dist/builtins/sys/textFilters.js +718 -263
- package/dist/builtins/sys/textFilters.js.map +1 -1
- package/dist/builtins/sys/timing.d.ts +24 -3
- package/dist/builtins/sys/timing.js +67 -14
- package/dist/builtins/sys/timing.js.map +1 -1
- package/dist/builtins/sys/variables.d.ts +70 -4
- package/dist/builtins/sys/variables.js +103 -31
- package/dist/builtins/sys/variables.js.map +1 -1
- package/dist/builtins/sys/version.d.ts +27 -2
- package/dist/builtins/sys/version.js +48 -3
- package/dist/builtins/sys/version.js.map +1 -1
- package/dist/builtins/sys/weather.d.ts +92 -15
- package/dist/builtins/sys/weather.js +71 -45
- package/dist/builtins/sys/weather.js.map +1 -1
- package/dist/builtins/sys/whoami.d.ts +38 -18
- package/dist/builtins/sys/whoami.js +112 -8
- package/dist/builtins/sys/whoami.js.map +1 -1
- package/dist/builtins/utils.d.ts +0 -37
- package/dist/builtins/utils.js +0 -86
- package/dist/builtins/utils.js.map +1 -1
- package/dist/chris/chrisCommands.js +58 -152
- package/dist/chris/chrisCommands.js.map +1 -1
- package/dist/chris/commandFallback.d.ts +12 -0
- package/dist/chris/commandFallback.js +47 -0
- package/dist/chris/commandFallback.js.map +1 -1
- package/dist/chris/filesystem.js +7 -5
- package/dist/chris/filesystem.js.map +1 -1
- package/dist/chris/help.js +0 -1018
- package/dist/chris/help.js.map +1 -1
- package/dist/chris/kinds.d.ts +21 -0
- package/dist/chris/kinds.js +114 -2
- package/dist/chris/kinds.js.map +1 -1
- package/dist/chris/mounts.d.ts +4 -4
- package/dist/chris/mounts.js +9 -16
- package/dist/chris/mounts.js.map +1 -1
- package/dist/chris/navigation.d.ts +2 -3
- package/dist/chris/navigation.js +6 -20
- package/dist/chris/navigation.js.map +1 -1
- package/dist/chris/pacsResources.d.ts +259 -0
- package/dist/chris/pacsResources.js +168 -0
- package/dist/chris/pacsResources.js.map +1 -0
- package/dist/core/commandDeclaration.d.ts +97 -7
- package/dist/core/commandDeclaration.js +21 -0
- package/dist/core/commandDeclaration.js.map +1 -1
- package/dist/core/commandParse.js +65 -17
- package/dist/core/commandParse.js.map +1 -1
- package/dist/core/commandRegistry.d.ts +4 -3
- package/dist/core/commandRegistry.js +36 -8
- package/dist/core/commandRegistry.js.map +1 -1
- package/dist/core/commandSchema.js +5 -2
- package/dist/core/commandSchema.js.map +1 -1
- package/dist/core/commandUsage.d.ts +15 -0
- package/dist/core/commandUsage.js +59 -7
- package/dist/core/commandUsage.js.map +1 -1
- package/dist/core/coreCommands.js +63 -212
- package/dist/core/coreCommands.js.map +1 -1
- package/dist/core/paths.d.ts +29 -1
- package/dist/core/paths.js +15 -2
- package/dist/core/paths.js.map +1 -1
- package/dist/core/preprocess.d.ts +3 -4
- package/dist/core/preprocess.js +4 -5
- package/dist/core/preprocess.js.map +1 -1
- package/dist/lib/completer/declared.js +7 -4
- package/dist/lib/completer/declared.js.map +1 -1
- package/dist/lib/completer/index.js +2 -7
- package/dist/lib/completer/index.js.map +1 -1
- package/dist/lib/parser.d.ts +0 -8
- package/dist/lib/parser.js +0 -11
- package/dist/lib/parser.js.map +1 -1
- package/dist/lib/vfs/vfs.d.ts +2 -1
- package/dist/lib/vfs/vfs.js +5 -4
- package/dist/lib/vfs/vfs.js.map +1 -1
- package/dist/notes.json +1 -1
- package/package.json +3 -3
|
@@ -18,7 +18,6 @@
|
|
|
18
18
|
*/
|
|
19
19
|
import chalk from 'chalk';
|
|
20
20
|
import { pacsQueries_list, pacsRetrieve_statusForQuery } from '@fnndsc/cumin';
|
|
21
|
-
import { args_checkHasHelpFlag, help_render } from '../help.js';
|
|
22
21
|
import { spinner } from '../../lib/spinner.js';
|
|
23
22
|
import { pacsQuery_createAndWait, queryExpr_parse } from './query.js';
|
|
24
23
|
import { queryId_extractFromFolder } from '@fnndsc/salsa';
|
|
@@ -174,23 +173,17 @@ function statusReport_render(report) {
|
|
|
174
173
|
* Reports per-series pull status for a PACS query: expected vs registered
|
|
175
174
|
* file counts, derived state, and the in-CUBE storage path.
|
|
176
175
|
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
176
|
+
* `pacs status` parses its line against the `pacs` declaration; this runs it.
|
|
177
|
+
*
|
|
178
|
+
* @param target - A query expression, a `/net/pacs/queries/...` path, or a
|
|
179
|
+
* numeric query id.
|
|
179
180
|
* @returns An envelope carrying the rendered report and a typed model of it.
|
|
180
181
|
* @example
|
|
181
182
|
* pacs status AccessionNumber:22119730
|
|
182
183
|
* pacs status /net/pacs/queries/AccessionNumber:22119730_qid:2833
|
|
183
184
|
* pacs status 2833
|
|
184
185
|
*/
|
|
185
|
-
export async function
|
|
186
|
-
if (args_checkHasHelpFlag(args, 'pacs')) {
|
|
187
|
-
return envelope_ok(help_render('pacs'));
|
|
188
|
-
}
|
|
189
|
-
const target = args.find((a) => !a.startsWith('--'));
|
|
190
|
-
if (!target) {
|
|
191
|
-
exitCode_set(1);
|
|
192
|
-
return envelope_error('', undefined, `${chalk.red('pacs status: Missing target. Usage: pacs status <expression | path | queryId>')}\n`);
|
|
193
|
-
}
|
|
186
|
+
export async function pacsStatus_run(target) {
|
|
194
187
|
const pacsserver = await pacsServer_resolve(null);
|
|
195
188
|
if (!pacsserver) {
|
|
196
189
|
exitCode_set(1);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../src/builtins/net/status.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAoF,MAAM,eAAe,CAAC;AAChK,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../src/builtins/net/status.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAoF,MAAM,eAAe,CAAC;AAChK,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAwB,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,uDAAuD;AACvD,MAAM,SAAS,GAAW,EAAE,CAAC;AAE7B;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,MAAc,EAAE,QAAgB;IAClD,MAAM,WAAW,GAAW,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAW,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAC3F,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAAC,MAAsC,EAAE,IAAY;IAC/E,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpD,IAAI,MAAM,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,yBAAyB,CAAC,OAA+B;IACtE,yEAAyE;IACzE,mEAAmE;IACnE,uDAAuD;IACvD,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC9C,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,OAAO,GAAyB,UAAU,CAAC,KAAK,CAAC;IACvD,MAAM,IAAI,GAA8B,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;IAEhE,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAY,GAAG,CAAC,KAAK,CAAC;QACpC,MAAM,EAAE,GAAW,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAAE,SAAS;QACpE,IAAI,MAA8B,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAA2B,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,MAAM,UAAU,GAAa,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAa,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,OAAO,GACX,UAAU,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YACrC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,GAAG,MAAM,CAAC;YAAE,MAAM,GAAG,EAAE,CAAC;IAC/D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,oBAAoB,CACjC,MAAc,EACd,UAAkB;IAElB,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACjD,CAAC;IAED,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAW,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACtE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,sCAAsC,MAAM,EAAE,EAAE,CAAC;IACnF,CAAC;IAED,MAAM,OAAO,GAAkC,eAAe,CAAC,MAAM,CAAC,CAAC;IACvE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,mDAAmD,MAAM,EAAE,EAAE,CAAC;IAChG,CAAC;IAED,MAAM,QAAQ,GAAkB,MAAM,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACzE,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAEhE,0EAA0E;IAC1E,sBAAsB;IACtB,OAAO,CAAC,KAAK,CAAC,qBAAqB,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAC3C,MAAM,EACN,UAAU,MAAM,EAAE,EAClB,UAAU,EACV,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAC5C,CAAC;IACF,OAAO,CAAC,IAAI,EAAE,CAAC;IACf,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,qBAAqB,MAAM,EAAE,EAAE,CAAC;IAC9E,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;AAClD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,MAA6B;IACxD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,WAAW,GAAW,CAAC,CAAC;IAC5B,IAAI,WAAW,GAAW,CAAC,CAAC;IAE5B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,gBAAgB,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;QAClG,MAAM,SAAS,GAAW,IAAI,CAAC,GAAG,CAChC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAuB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,iBAAiB,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,EACrG,CAAC,CACF,CAAC;QACF,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,WAAW,EAAE,CAAC;YACd,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ;gBAAE,WAAW,EAAE,CAAC;YAC9C,MAAM,IAAI,GAAW,CAAC,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC9F,MAAM,GAAG,GAAW,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;YACzE,MAAM,MAAM,GAAW,GAAG,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACnF,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,GAAG,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;YACxF,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,YAAY,GAAG,WAAW,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;IAC9E,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,WAAW,IAAI,WAAW,wBAAwB,CAAC,CAAC,CAAC;IAChF,IAAI,WAAW,GAAG,WAAW,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,+EAA+E,CAAC,CAAC,CAAC;IAC1G,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAc;IAEjD,MAAM,UAAU,GAAkB,MAAM,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,wEAAwE,CAAC,IAAI,CAAC,CAAC;IACnI,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;IACnF,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,oCAAoC,OAAO,KAAK,EAAE,IAAI,CAAC,CAAC;IACtE,MAAM,YAAY,GAAG,MAAM,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAChE,OAAO,CAAC,IAAI,EAAE,CAAC;IACf,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC;QACrB,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,wDAAwD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAC7H,CAAC;IAED,MAAM,MAAM,GAA0B,YAAY,CAAC,KAAK,CAAC;IACzD,MAAM,QAAQ,GAAW,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,OAAO,EAAE,CAAC,KAAK,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;IAC7F,OAAO,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AACtE,CAAC"}
|
|
@@ -1,14 +1,93 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @file
|
|
2
|
+
* @file `parametersofplugin`: the parameters a plugin takes, as a manual
|
|
3
|
+
* page, or the fields a parameter has.
|
|
4
|
+
*
|
|
5
|
+
* A plugin's own `/bin` entry reads them too: `pl-dircopy-v2.1.1 --parameters`
|
|
6
|
+
* asks this command for the plugin it names.
|
|
7
|
+
*
|
|
8
|
+
* Declared in one record (`parametersofpluginCommand`).
|
|
9
|
+
*
|
|
10
|
+
* Key components:
|
|
11
|
+
* - parametersofpluginCommand: the declaration.
|
|
12
|
+
* - builtin_parametersofplugin: the declaration run over words already split.
|
|
3
13
|
*
|
|
4
14
|
* @module
|
|
5
15
|
*/
|
|
6
16
|
import { type CommandEnvelope } from '@fnndsc/menu';
|
|
7
17
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
18
|
+
* `parametersofplugin [--plugin-id <id>] <list | fieldslist>`: the declaration.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* commands_register({ declarations: [parametersofpluginCommand] }, 'backend');
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export declare const parametersofpluginCommand: import("../core/commandDeclaration.js").CommandDeclaration<{
|
|
26
|
+
readonly options: {
|
|
27
|
+
readonly pluginId: {
|
|
28
|
+
readonly long: "plugin-id";
|
|
29
|
+
readonly summary: "The plugin's id; without it, the plugin of the current context";
|
|
30
|
+
readonly value: {
|
|
31
|
+
readonly name: "id";
|
|
32
|
+
readonly kind: "int";
|
|
33
|
+
readonly min: 1;
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
readonly subcommands: {
|
|
38
|
+
readonly list: {
|
|
39
|
+
readonly summary: "The plugin's parameters, as a manual page";
|
|
40
|
+
readonly options: {
|
|
41
|
+
readonly limit: {
|
|
42
|
+
readonly long: "limit";
|
|
43
|
+
readonly summary: "At most this many (default 20)";
|
|
44
|
+
readonly value: {
|
|
45
|
+
readonly name: "n";
|
|
46
|
+
readonly kind: "int";
|
|
47
|
+
readonly min: 1;
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
readonly offset: {
|
|
51
|
+
readonly long: "offset";
|
|
52
|
+
readonly summary: "Start this many in";
|
|
53
|
+
readonly value: {
|
|
54
|
+
readonly name: "n";
|
|
55
|
+
readonly kind: "int";
|
|
56
|
+
readonly min: 0;
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
readonly fields: {
|
|
60
|
+
readonly long: "fields";
|
|
61
|
+
readonly summary: "The fields to show, comma-separated (fieldslist names them)";
|
|
62
|
+
readonly value: {
|
|
63
|
+
readonly name: "field,…";
|
|
64
|
+
readonly kind: "word";
|
|
65
|
+
};
|
|
66
|
+
};
|
|
67
|
+
readonly search: {
|
|
68
|
+
readonly long: "search";
|
|
69
|
+
readonly summary: "Filter by field:value, comma-separated";
|
|
70
|
+
readonly value: {
|
|
71
|
+
readonly name: "field:value";
|
|
72
|
+
readonly kind: "word";
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
readonly fieldslist: {
|
|
78
|
+
readonly summary: "Name the fields a parameter has";
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
}>;
|
|
82
|
+
/**
|
|
83
|
+
* `parametersofplugin` over words already split: the declaration's parse and handler.
|
|
10
84
|
*
|
|
11
85
|
* @param args - Arguments passed to the command.
|
|
12
86
|
* @returns An envelope carrying the rendered parameters or fields.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* await builtin_parametersofplugin(['list', '--plugin-id', '42']);
|
|
91
|
+
* ```
|
|
13
92
|
*/
|
|
14
93
|
export declare function builtin_parametersofplugin(args: string[]): Promise<CommandEnvelope>;
|
|
@@ -1,38 +1,61 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @file
|
|
2
|
+
* @file `parametersofplugin`: the parameters a plugin takes, as a manual
|
|
3
|
+
* page, or the fields a parameter has.
|
|
4
|
+
*
|
|
5
|
+
* A plugin's own `/bin` entry reads them too: `pl-dircopy-v2.1.1 --parameters`
|
|
6
|
+
* asks this command for the plugin it names.
|
|
7
|
+
*
|
|
8
|
+
* Declared in one record (`parametersofpluginCommand`).
|
|
9
|
+
*
|
|
10
|
+
* Key components:
|
|
11
|
+
* - parametersofpluginCommand: the declaration.
|
|
12
|
+
* - builtin_parametersofplugin: the declaration run over words already split.
|
|
3
13
|
*
|
|
4
14
|
* @module
|
|
5
15
|
*/
|
|
6
16
|
import chalk from 'chalk';
|
|
7
|
-
import { commandArgs_process } from './utils.js';
|
|
8
17
|
import { PluginContextGroupHandler } from '@fnndsc/chili/plugins/pluginGroupHandler.js';
|
|
9
|
-
import {
|
|
18
|
+
import { envelope_error } from '@fnndsc/menu';
|
|
10
19
|
import { exitCode_set } from '../core/handlerRun.js';
|
|
20
|
+
import { command_declare } from '../core/commandDeclaration.js';
|
|
21
|
+
import { declaredCommand_run } from '../core/commandParse.js';
|
|
22
|
+
/** What a `parametersofplugin` line may hold. */
|
|
23
|
+
const PARAMETERSOFPLUGIN_GRAMMAR = {
|
|
24
|
+
options: {
|
|
25
|
+
pluginId: { long: 'plugin-id', summary: "The plugin's id; without it, the plugin of the current context", value: { name: 'id', kind: 'int', min: 1 } },
|
|
26
|
+
},
|
|
27
|
+
subcommands: {
|
|
28
|
+
list: {
|
|
29
|
+
summary: "The plugin's parameters, as a manual page",
|
|
30
|
+
options: {
|
|
31
|
+
limit: { long: 'limit', summary: 'At most this many (default 20)', value: { name: 'n', kind: 'int', min: 1 } },
|
|
32
|
+
offset: { long: 'offset', summary: 'Start this many in', value: { name: 'n', kind: 'int', min: 0 } },
|
|
33
|
+
fields: { long: 'fields', summary: 'The fields to show, comma-separated (fieldslist names them)', value: { name: 'field,…', kind: 'word' } },
|
|
34
|
+
search: { long: 'search', summary: 'Filter by field:value, comma-separated', value: { name: 'field:value', kind: 'word' } },
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
fieldslist: { summary: 'Name the fields a parameter has' },
|
|
38
|
+
},
|
|
39
|
+
};
|
|
11
40
|
/**
|
|
12
|
-
*
|
|
13
|
-
* This command displays information about plugin parameters.
|
|
41
|
+
* Runs one `parametersofplugin` line.
|
|
14
42
|
*
|
|
15
|
-
* @param args -
|
|
16
|
-
* @returns
|
|
43
|
+
* @param args - The line, parsed.
|
|
44
|
+
* @returns The parameters or the fields, or the error.
|
|
17
45
|
*/
|
|
18
|
-
|
|
19
|
-
const parsedArgs = commandArgs_process(args);
|
|
20
|
-
const subcommand = parsedArgs._[0]; // e.g., 'list', 'fieldslist'
|
|
21
|
-
const pluginIdFromArgs = parsedArgs['plugin-id'];
|
|
22
|
-
if (!subcommand) {
|
|
23
|
-
return envelope_ok(`${chalk.red('Usage: parametersofplugin <list|fieldslist> [--plugin-id <id>] ...')}\n`);
|
|
24
|
-
}
|
|
46
|
+
async function parametersofplugin_run(args) {
|
|
25
47
|
try {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
if (subcommand === 'list') {
|
|
29
|
-
// Use the specialized man-page style listing for parameters
|
|
30
|
-
return await handler.parameters_listManRender(parsedArgs);
|
|
31
|
-
}
|
|
32
|
-
else if (subcommand === 'fieldslist') {
|
|
48
|
+
const handler = await PluginContextGroupHandler.handler_create('parametersofplugin', args.options.pluginId);
|
|
49
|
+
if (args.subcommand === 'fieldslist')
|
|
33
50
|
return await handler.parameters_fieldsRender();
|
|
34
|
-
}
|
|
35
|
-
|
|
51
|
+
const { limit, offset, fields, search } = args.options;
|
|
52
|
+
const options = {
|
|
53
|
+
...(limit !== undefined ? { limit: String(limit) } : {}),
|
|
54
|
+
...(offset !== undefined ? { offset: String(offset) } : {}),
|
|
55
|
+
...(fields !== undefined ? { fields } : {}),
|
|
56
|
+
...(search !== undefined ? { search } : {}),
|
|
57
|
+
};
|
|
58
|
+
return await handler.parameters_listManRender(options);
|
|
36
59
|
}
|
|
37
60
|
catch (error) {
|
|
38
61
|
const msg = error instanceof Error ? error.message : String(error);
|
|
@@ -40,4 +63,37 @@ export async function builtin_parametersofplugin(args) {
|
|
|
40
63
|
return envelope_error('', undefined, `${chalk.red(`Error in parametersofplugin: ${msg}`)}\n`);
|
|
41
64
|
}
|
|
42
65
|
}
|
|
66
|
+
/**
|
|
67
|
+
* `parametersofplugin [--plugin-id <id>] <list | fieldslist>`: the declaration.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* commands_register({ declarations: [parametersofpluginCommand] }, 'backend');
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
export const parametersofpluginCommand = command_declare({
|
|
75
|
+
name: 'parametersofplugin',
|
|
76
|
+
grammar: PARAMETERSOFPLUGIN_GRAMMAR,
|
|
77
|
+
help: {
|
|
78
|
+
summary: 'The parameters a plugin takes, as a manual page',
|
|
79
|
+
description: "List a plugin's parameters as a manual page: each flag, its type, its default and its help. --plugin-id names the plugin by its id; without it, the plugin of the current context is read. fieldslist names the fields a parameter has. A plugin's /bin entry answers the same: pl-dircopy-v2.1.1 --parameters.",
|
|
80
|
+
category: 'Resources',
|
|
81
|
+
examples: ['parametersofplugin list --plugin-id 42', 'parametersofplugin fieldslist', 'pl-dircopy-v2.1.1 --parameters'],
|
|
82
|
+
},
|
|
83
|
+
handler: parametersofplugin_run,
|
|
84
|
+
});
|
|
85
|
+
/**
|
|
86
|
+
* `parametersofplugin` over words already split: the declaration's parse and handler.
|
|
87
|
+
*
|
|
88
|
+
* @param args - Arguments passed to the command.
|
|
89
|
+
* @returns An envelope carrying the rendered parameters or fields.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* await builtin_parametersofplugin(['list', '--plugin-id', '42']);
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
export async function builtin_parametersofplugin(args) {
|
|
97
|
+
return declaredCommand_run(parametersofpluginCommand, args);
|
|
98
|
+
}
|
|
43
99
|
//# sourceMappingURL=parametersofplugin.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parametersofplugin.js","sourceRoot":"","sources":["../../src/builtins/parametersofplugin.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"parametersofplugin.js","sourceRoot":"","sources":["../../src/builtins/parametersofplugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AACxF,OAAO,EAAwB,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,eAAe,EAA8C,MAAM,+BAA+B,CAAC;AAC5G,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D,iDAAiD;AACjD,MAAM,0BAA0B,GAAG;IACjC,OAAO,EAAE;QACP,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,gEAAgE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;KACvJ;IACD,WAAW,EAAE;QACX,IAAI,EAAE;YACJ,OAAO,EAAE,2CAA2C;YACpD,OAAO,EAAE;gBACP,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,gCAAgC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC9G,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;gBACpG,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,6DAA6D,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;gBAC5I,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,wCAAwC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;aAC5H;SACF;QACD,UAAU,EAAE,EAAE,OAAO,EAAE,iCAAiC,EAAE;KAC3D;CACgC,CAAC;AAEpC;;;;;GAKG;AACH,KAAK,UAAU,sBAAsB,CAAC,IAAyD;IAC7F,IAAI,CAAC;QACH,MAAM,OAAO,GAA8B,MAAM,yBAAyB,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvI,IAAI,IAAI,CAAC,UAAU,KAAK,YAAY;YAAE,OAAO,MAAM,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACrF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvD,MAAM,OAAO,GAAe;YAC1B,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5C,CAAC;QACF,OAAO,MAAM,OAAO,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,GAAG,GAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3E,YAAY,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,gCAAgC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IAChG,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,eAAe,CAAC;IACvD,IAAI,EAAE,oBAAoB;IAC1B,OAAO,EAAE,0BAA0B;IACnC,IAAI,EAAE;QACJ,OAAO,EAAE,iDAAiD;QAC1D,WAAW,EAAE,iTAAiT;QAC9T,QAAQ,EAAE,WAAW;QACrB,QAAQ,EAAE,CAAC,wCAAwC,EAAE,+BAA+B,EAAE,gCAAgC,CAAC;KACxH;IACD,OAAO,EAAE,sBAAsB;CAChC,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,IAAc;IAC7D,OAAO,mBAAmB,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC"}
|
package/dist/builtins/proc.d.ts
CHANGED
|
@@ -7,9 +7,216 @@ import { type ProcUniverseModel, type CommandEnvelope } from '@fnndsc/menu';
|
|
|
7
7
|
*/
|
|
8
8
|
export declare function procUniverseModel_build(): ProcUniverseModel;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* `proc <jobs|stat|feeds|seen|universe|layout|refresh|retry|find|here|jump|watch|unwatch>`: the declaration.
|
|
11
11
|
*
|
|
12
|
-
* @
|
|
13
|
-
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* commands_register({ declarations: [procCommand] }, 'backend');
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export declare const procCommand: import("../core/commandDeclaration.js").CommandDeclaration<{
|
|
18
|
+
readonly bare: {
|
|
19
|
+
readonly summary: "Rebuild the entire proc cache (as refresh)";
|
|
20
|
+
};
|
|
21
|
+
readonly subcommands: {
|
|
22
|
+
readonly jobs: {
|
|
23
|
+
readonly summary: "List all feeds with their counter fields (default 20), or inspect the field names";
|
|
24
|
+
readonly operands: readonly [{
|
|
25
|
+
readonly name: "view";
|
|
26
|
+
readonly kind: "enum";
|
|
27
|
+
readonly values: readonly ["list", "inspect"];
|
|
28
|
+
readonly optional: true;
|
|
29
|
+
readonly summary: "list (the default), or inspect: every field name";
|
|
30
|
+
}];
|
|
31
|
+
readonly options: {
|
|
32
|
+
readonly fields: {
|
|
33
|
+
readonly long: "fields";
|
|
34
|
+
readonly summary: "Select columns";
|
|
35
|
+
readonly value: {
|
|
36
|
+
readonly name: "f,f";
|
|
37
|
+
readonly kind: "word";
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
readonly sort: {
|
|
41
|
+
readonly long: "sort";
|
|
42
|
+
readonly summary: "Sort by field";
|
|
43
|
+
readonly value: {
|
|
44
|
+
readonly name: "field";
|
|
45
|
+
readonly kind: "word";
|
|
46
|
+
};
|
|
47
|
+
};
|
|
48
|
+
readonly reverse: {
|
|
49
|
+
readonly long: "reverse";
|
|
50
|
+
readonly summary: "Reverse the sort";
|
|
51
|
+
};
|
|
52
|
+
readonly table: {
|
|
53
|
+
readonly long: "table";
|
|
54
|
+
readonly summary: "Tabular output";
|
|
55
|
+
};
|
|
56
|
+
readonly csv: {
|
|
57
|
+
readonly long: "csv";
|
|
58
|
+
readonly summary: "CSV output";
|
|
59
|
+
};
|
|
60
|
+
readonly all: {
|
|
61
|
+
readonly long: "all";
|
|
62
|
+
readonly summary: "All feeds (no limit)";
|
|
63
|
+
};
|
|
64
|
+
readonly limit: {
|
|
65
|
+
readonly long: "limit";
|
|
66
|
+
readonly summary: "Feeds to show (default 20)";
|
|
67
|
+
readonly value: {
|
|
68
|
+
readonly name: "n";
|
|
69
|
+
readonly kind: "int";
|
|
70
|
+
readonly min: 1;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
readonly search: {
|
|
74
|
+
readonly long: "search";
|
|
75
|
+
readonly summary: "Filter by title substring";
|
|
76
|
+
readonly value: {
|
|
77
|
+
readonly name: "term";
|
|
78
|
+
readonly kind: "word";
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
readonly force: {
|
|
82
|
+
readonly long: "force";
|
|
83
|
+
readonly summary: "Wait for warm-up, then answer from the complete index";
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
readonly stat: {
|
|
88
|
+
readonly summary: "Show the cache summary, or one feed's raw counters and topology state";
|
|
89
|
+
readonly operands: readonly [{
|
|
90
|
+
readonly optional: true;
|
|
91
|
+
readonly name: "feed";
|
|
92
|
+
readonly kind: "word";
|
|
93
|
+
readonly summary: "The feed: feed_N or its id";
|
|
94
|
+
}];
|
|
95
|
+
};
|
|
96
|
+
readonly feeds: {
|
|
97
|
+
readonly summary: "Find feeds by title, feed_N name or id; an id the roster lacks is asked of CUBE";
|
|
98
|
+
readonly operands: readonly [{
|
|
99
|
+
readonly name: "query";
|
|
100
|
+
readonly kind: "word";
|
|
101
|
+
readonly optional: true;
|
|
102
|
+
readonly summary: "Title substring, feed_N or id; none lists the whole roster";
|
|
103
|
+
}];
|
|
104
|
+
readonly options: {
|
|
105
|
+
readonly fresh: {
|
|
106
|
+
readonly long: "fresh";
|
|
107
|
+
readonly summary: "Walk the whole feed index now";
|
|
108
|
+
};
|
|
109
|
+
readonly new: {
|
|
110
|
+
readonly long: "new";
|
|
111
|
+
readonly summary: "Feeds shared with you since your last visit, not yet opened (NEW)";
|
|
112
|
+
};
|
|
113
|
+
readonly force: {
|
|
114
|
+
readonly long: "force";
|
|
115
|
+
readonly summary: "Wait for warm-up, then answer from the complete index";
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
readonly seen: {
|
|
120
|
+
readonly summary: "Take the NEW mark off feeds you have looked at";
|
|
121
|
+
readonly operands: readonly [{
|
|
122
|
+
readonly name: "feeds";
|
|
123
|
+
readonly kind: "word";
|
|
124
|
+
readonly repeat: true;
|
|
125
|
+
readonly summary: "feed_N or N, or all";
|
|
126
|
+
}];
|
|
127
|
+
};
|
|
128
|
+
readonly universe: {
|
|
129
|
+
readonly summary: "Every feed the index holds as it landed: size, status, pipeline shape; honest while warming";
|
|
130
|
+
};
|
|
131
|
+
readonly layout: {
|
|
132
|
+
readonly summary: "Where a surface last laid the universe out under a layout; put keeps one (node ids to [x, y, z], as JSON)";
|
|
133
|
+
readonly operands: readonly [{
|
|
134
|
+
readonly name: "layout";
|
|
135
|
+
readonly kind: "word";
|
|
136
|
+
readonly summary: "The layout's name; or put, to keep one";
|
|
137
|
+
}, {
|
|
138
|
+
readonly name: "name";
|
|
139
|
+
readonly kind: "word";
|
|
140
|
+
readonly optional: true;
|
|
141
|
+
readonly summary: "With put: the layout's name";
|
|
142
|
+
}, {
|
|
143
|
+
readonly name: "places";
|
|
144
|
+
readonly kind: "word";
|
|
145
|
+
readonly optional: true;
|
|
146
|
+
readonly summary: "With put: node ids to [x, y, z], as JSON";
|
|
147
|
+
}];
|
|
148
|
+
};
|
|
149
|
+
readonly refresh: {
|
|
150
|
+
readonly summary: "Rebuild the entire proc cache, or one feed's";
|
|
151
|
+
readonly operands: readonly [{
|
|
152
|
+
readonly optional: true;
|
|
153
|
+
readonly name: "feed";
|
|
154
|
+
readonly kind: "word";
|
|
155
|
+
readonly summary: "The feed: feed_N or its id";
|
|
156
|
+
}];
|
|
157
|
+
};
|
|
158
|
+
readonly retry: {
|
|
159
|
+
readonly summary: "Resume a failed topology sweep at its failed page";
|
|
160
|
+
};
|
|
161
|
+
readonly find: {
|
|
162
|
+
readonly summary: "Find a job: an instance id (available during warm-up), or a plugin name";
|
|
163
|
+
readonly operands: readonly [{
|
|
164
|
+
readonly name: "query";
|
|
165
|
+
readonly kind: "word";
|
|
166
|
+
readonly summary: "An instance id, or a plugin name substring";
|
|
167
|
+
}];
|
|
168
|
+
readonly options: {
|
|
169
|
+
readonly force: {
|
|
170
|
+
readonly long: "force";
|
|
171
|
+
readonly summary: "Wait for warm-up, then answer from the complete index";
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
readonly here: {
|
|
176
|
+
readonly summary: "Navigate from a CFS feed/output path to its matching job";
|
|
177
|
+
};
|
|
178
|
+
readonly jump: {
|
|
179
|
+
readonly summary: "Go to a feed or node by id or /proc name (feed_N, plugin_N); a number that is both is not guessed";
|
|
180
|
+
readonly operands: readonly [{
|
|
181
|
+
readonly name: "target";
|
|
182
|
+
readonly kind: "word";
|
|
183
|
+
readonly summary: "A feed id, node id, feed_N or plugin_N";
|
|
184
|
+
}];
|
|
185
|
+
readonly options: {
|
|
186
|
+
readonly where: {
|
|
187
|
+
readonly long: "where";
|
|
188
|
+
readonly summary: "Only answer where it is; the cwd stays";
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
readonly watch: {
|
|
193
|
+
readonly summary: "Keep a running feed live: sample it while it runs, push its DAG to every surface; none lists the watches";
|
|
194
|
+
readonly operands: readonly [{
|
|
195
|
+
readonly optional: true;
|
|
196
|
+
readonly name: "feed";
|
|
197
|
+
readonly kind: "word";
|
|
198
|
+
readonly summary: "The feed: feed_N or its id";
|
|
199
|
+
}];
|
|
200
|
+
};
|
|
201
|
+
readonly unwatch: {
|
|
202
|
+
readonly summary: "Release the watch on a feed";
|
|
203
|
+
readonly operands: readonly [{
|
|
204
|
+
readonly name: "feed";
|
|
205
|
+
readonly kind: "word";
|
|
206
|
+
readonly summary: "The feed: feed_N or its id";
|
|
207
|
+
}];
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
}>;
|
|
211
|
+
/**
|
|
212
|
+
* `proc` over words already split: the declaration's parse and handler.
|
|
213
|
+
*
|
|
214
|
+
* @param args - The words after `proc`.
|
|
215
|
+
* @returns An envelope carrying the subcommand's output, or the refusal of a bad line.
|
|
216
|
+
*
|
|
217
|
+
* @example
|
|
218
|
+
* ```ts
|
|
219
|
+
* await builtin_proc(['stat']);
|
|
220
|
+
* ```
|
|
14
221
|
*/
|
|
15
222
|
export declare function builtin_proc(args: string[]): Promise<CommandEnvelope>;
|