edfcore 0.2.0 → 0.2.1
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/CHANGELOG.md +5 -0
- package/dist/cli-run.d.ts +1 -0
- package/dist/cli-run.d.ts.map +1 -1
- package/dist/cli-run.js +13 -1
- package/dist/cli-run.js.map +1 -1
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/package.json +1 -1
- package/src/cli-run.ts +13 -1
- package/src/constants.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,11 @@ alone does not tell you whether you were affected.
|
|
|
6
6
|
edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
|
|
7
7
|
defect; those are called out below.
|
|
8
8
|
|
|
9
|
+
## 0.2.1
|
|
10
|
+
|
|
11
|
+
- **Added** `--version` / `-v` to the CLI. Handled before the command check, so a bare
|
|
12
|
+
`--version` does not fall through to usage and exit 2.
|
|
13
|
+
|
|
9
14
|
## 0.2.0
|
|
10
15
|
|
|
11
16
|
Marks the feature set that accumulated across 0.1.7–0.1.19 — envelope decimation, the CLI,
|
package/dist/cli-run.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export interface Args {
|
|
|
16
16
|
readonly command: string | undefined;
|
|
17
17
|
readonly file: string | undefined;
|
|
18
18
|
readonly patient: boolean;
|
|
19
|
+
readonly version: boolean;
|
|
19
20
|
readonly limit: number | undefined;
|
|
20
21
|
}
|
|
21
22
|
export declare function parseArgs(argv: readonly string[]): Args;
|
package/dist/cli-run.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-run.d.ts","sourceRoot":"","sources":["../src/cli-run.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"cli-run.d.ts","sourceRoot":"","sources":["../src/cli-run.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAWH,iDAAiD;AACjD,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAkBD,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAsBvD;AAQD,wBAAsB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CA0FnE"}
|
package/dist/cli-run.js
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
* binary. This way the exit codes and the output are ordinary unit tests.
|
|
8
8
|
*/
|
|
9
9
|
import { countAnnotationsByText } from './annotations-query.js';
|
|
10
|
+
import { VERSION } from './constants.js';
|
|
10
11
|
import { formatDiagnostics } from './diagnostics/format.js';
|
|
11
12
|
import { formatHeader } from './format-header.js';
|
|
12
13
|
import { formatValidationReport } from './format-report.js';
|
|
@@ -24,16 +25,21 @@ Options
|
|
|
24
25
|
--patient include patient identification (header, json)
|
|
25
26
|
--limit <n> individual diagnostics to print (default 20)
|
|
26
27
|
|
|
28
|
+
--version print the version and exit
|
|
29
|
+
|
|
27
30
|
Exit codes: 0 success, 1 the file is unreadable or failed validation, 2 bad usage.
|
|
28
31
|
`;
|
|
29
32
|
export function parseArgs(argv) {
|
|
30
33
|
const positional = [];
|
|
31
34
|
let patient = false;
|
|
35
|
+
let version = false;
|
|
32
36
|
let limit;
|
|
33
37
|
for (let i = 0; i < argv.length; i += 1) {
|
|
34
38
|
const arg = argv[i];
|
|
35
39
|
if (arg === '--patient')
|
|
36
40
|
patient = true;
|
|
41
|
+
else if (arg === '--version' || arg === '-v')
|
|
42
|
+
version = true;
|
|
37
43
|
else if (arg === '--limit') {
|
|
38
44
|
const value = Number(argv[i + 1]);
|
|
39
45
|
// A NaN limit would disable the cap silently, which is the opposite of what was asked for.
|
|
@@ -46,7 +52,7 @@ export function parseArgs(argv) {
|
|
|
46
52
|
else if (arg !== undefined && !arg.startsWith('-'))
|
|
47
53
|
positional.push(arg);
|
|
48
54
|
}
|
|
49
|
-
return { command: positional[0], file: positional[1], patient, limit };
|
|
55
|
+
return { command: positional[0], file: positional[1], patient, version, limit };
|
|
50
56
|
}
|
|
51
57
|
async function open(io, file) {
|
|
52
58
|
// Read whole rather than fileSource: a CLI invocation is one pass over one file, and holding
|
|
@@ -55,6 +61,12 @@ async function open(io, file) {
|
|
|
55
61
|
}
|
|
56
62
|
export async function runCli(args, io) {
|
|
57
63
|
const { command, file } = args;
|
|
64
|
+
// Before the command check: `edfcore --version` has no command, and a bare --version must not
|
|
65
|
+
// fall through to the usage text and exit 2.
|
|
66
|
+
if (args.version) {
|
|
67
|
+
io.out(`${VERSION}\n`);
|
|
68
|
+
return 0;
|
|
69
|
+
}
|
|
58
70
|
if (command === undefined || command === 'help' || command === '--help') {
|
|
59
71
|
io.out(USAGE);
|
|
60
72
|
return command === undefined ? 2 : 0;
|
package/dist/cli-run.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-run.js","sourceRoot":"","sources":["../src/cli-run.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AASlD,MAAM,KAAK,GAAG
|
|
1
|
+
{"version":3,"file":"cli-run.js","sourceRoot":"","sources":["../src/cli-run.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AASlD,MAAM,KAAK,GAAG;;;;;;;;;;;;;;CAcb,CAAC;AAUF,MAAM,UAAU,SAAS,CAAC,IAAuB;IAC/C,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,KAAyB,CAAC;IAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,GAAG,KAAK,WAAW;YAAE,OAAO,GAAG,IAAI,CAAC;aACnC,IAAI,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,GAAG,IAAI,CAAC;aACxD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAClC,2FAA2F;YAC3F,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,UAAU,CAAC,0CAA0C,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxF,CAAC;YACD,KAAK,GAAG,KAAK,CAAC;YACd,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAClF,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,EAAS,EAAE,IAAY;IACzC,6FAA6F;IAC7F,2EAA2E;IAC3E,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAU,EAAE,EAAS;IAChD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAC/B,8FAA8F;IAC9F,6CAA6C;IAC7C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACvB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,MAAM,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACxE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACd,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,EAAE,CAAC,GAAG,CAAC,WAAW,OAAO,sBAAsB,KAAK,EAAE,CAAC,CAAC;QACxD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACvC,EAAE,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAClF,IAAI,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5C,EAAE,CAAC,GAAG,CACJ,KAAK,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,IAAI,CACzF,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;QAED,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YACzE,EAAE,CAAC,GAAG,CACJ,GAAG,sBAAsB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,IAAI,CAChG,CAAC;YACF,2EAA2E;YAC3E,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACvC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,eAAe,CAAC,SAAS,EAAE;gBACvD,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,WAAW;aACpC,CAAC,CAAC;YACH,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAC3B,OAAO,CAAC,CAAC;YACX,CAAC;YACD,EAAE,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,oBAAoB,CAAC,CAAC;YAClD,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClE,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACvC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;YAC7B,EAAE,CAAC,GAAG,CACJ,GAAG,IAAI,CAAC,SAAS,CACf;gBACE,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;gBACnD,WAAW,EAAE,SAAS,CAAC,QAAQ,CAAC,WAAW;gBAC3C,mFAAmF;gBACnF,iEAAiE;gBACjE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/D,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;oBACvC,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;oBACzC,YAAY,EAAE,MAAM,CAAC,YAAY;oBACjC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;iBAC5C,CAAC,CAAC;gBACH,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aACrF,EACD,IAAI,EACJ,CAAC,CACF,IAAI,CACN,CAAC;YACF,OAAO,CAAC,CAAC;QACX,CAAC;QAED;YACE,EAAE,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC;YAC1E,OAAO,CAAC,CAAC;IACb,CAAC;AACH,CAAC"}
|
package/dist/constants.d.ts
CHANGED
|
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
|
|
|
109
109
|
readonly reserved: 224;
|
|
110
110
|
};
|
|
111
111
|
/** Published package version. Kept in sync with package.json by a test. */
|
|
112
|
-
export declare const VERSION = "0.2.
|
|
112
|
+
export declare const VERSION = "0.2.1";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/package.json
CHANGED
package/src/cli-run.ts
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
import { countAnnotationsByText } from './annotations-query.js';
|
|
11
|
+
import { VERSION } from './constants.js';
|
|
11
12
|
import { formatDiagnostics } from './diagnostics/format.js';
|
|
12
13
|
import { formatHeader } from './format-header.js';
|
|
13
14
|
import { formatValidationReport } from './format-report.js';
|
|
@@ -33,6 +34,8 @@ Options
|
|
|
33
34
|
--patient include patient identification (header, json)
|
|
34
35
|
--limit <n> individual diagnostics to print (default 20)
|
|
35
36
|
|
|
37
|
+
--version print the version and exit
|
|
38
|
+
|
|
36
39
|
Exit codes: 0 success, 1 the file is unreadable or failed validation, 2 bad usage.
|
|
37
40
|
`;
|
|
38
41
|
|
|
@@ -40,17 +43,20 @@ export interface Args {
|
|
|
40
43
|
readonly command: string | undefined;
|
|
41
44
|
readonly file: string | undefined;
|
|
42
45
|
readonly patient: boolean;
|
|
46
|
+
readonly version: boolean;
|
|
43
47
|
readonly limit: number | undefined;
|
|
44
48
|
}
|
|
45
49
|
|
|
46
50
|
export function parseArgs(argv: readonly string[]): Args {
|
|
47
51
|
const positional: string[] = [];
|
|
48
52
|
let patient = false;
|
|
53
|
+
let version = false;
|
|
49
54
|
let limit: number | undefined;
|
|
50
55
|
|
|
51
56
|
for (let i = 0; i < argv.length; i += 1) {
|
|
52
57
|
const arg = argv[i];
|
|
53
58
|
if (arg === '--patient') patient = true;
|
|
59
|
+
else if (arg === '--version' || arg === '-v') version = true;
|
|
54
60
|
else if (arg === '--limit') {
|
|
55
61
|
const value = Number(argv[i + 1]);
|
|
56
62
|
// A NaN limit would disable the cap silently, which is the opposite of what was asked for.
|
|
@@ -62,7 +68,7 @@ export function parseArgs(argv: readonly string[]): Args {
|
|
|
62
68
|
} else if (arg !== undefined && !arg.startsWith('-')) positional.push(arg);
|
|
63
69
|
}
|
|
64
70
|
|
|
65
|
-
return { command: positional[0], file: positional[1], patient, limit };
|
|
71
|
+
return { command: positional[0], file: positional[1], patient, version, limit };
|
|
66
72
|
}
|
|
67
73
|
|
|
68
74
|
async function open(io: CliIo, file: string) {
|
|
@@ -73,6 +79,12 @@ async function open(io: CliIo, file: string) {
|
|
|
73
79
|
|
|
74
80
|
export async function runCli(args: Args, io: CliIo): Promise<number> {
|
|
75
81
|
const { command, file } = args;
|
|
82
|
+
// Before the command check: `edfcore --version` has no command, and a bare --version must not
|
|
83
|
+
// fall through to the usage text and exit 2.
|
|
84
|
+
if (args.version) {
|
|
85
|
+
io.out(`${VERSION}\n`);
|
|
86
|
+
return 0;
|
|
87
|
+
}
|
|
76
88
|
if (command === undefined || command === 'help' || command === '--help') {
|
|
77
89
|
io.out(USAGE);
|
|
78
90
|
return command === undefined ? 2 : 0;
|
package/src/constants.ts
CHANGED