@travetto/doc 2.2.0 → 2.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/bin/cli-doc.ts +10 -4
- package/package.json +3 -3
package/bin/cli-doc.ts
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
1
|
import * as path from 'path';
|
|
2
2
|
import * as fs from 'fs/promises';
|
|
3
3
|
|
|
4
|
-
import { BasePlugin } from '@travetto/cli/src/plugin-base';
|
|
4
|
+
import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
|
|
5
5
|
import { EnvInit } from '@travetto/base/bin/init';
|
|
6
6
|
import { PathUtil } from '@travetto/boot';
|
|
7
7
|
|
|
8
|
+
type Options = {
|
|
9
|
+
input: OptionConfig<string>;
|
|
10
|
+
output: OptionConfig<string[]>;
|
|
11
|
+
format: OptionConfig<string>;
|
|
12
|
+
watch: OptionConfig<boolean>;
|
|
13
|
+
};
|
|
14
|
+
|
|
8
15
|
/**
|
|
9
16
|
* Command line support for generating module docs.
|
|
10
17
|
*/
|
|
11
|
-
export class DocPlugin extends BasePlugin {
|
|
18
|
+
export class DocPlugin extends BasePlugin<Options> {
|
|
12
19
|
name = 'doc';
|
|
13
20
|
|
|
14
|
-
|
|
15
|
-
getOptions() {
|
|
21
|
+
getOptions(): Options {
|
|
16
22
|
return {
|
|
17
23
|
input: this.option({ desc: 'Input File', def: 'doc.ts' }),
|
|
18
24
|
output: this.listOption({ desc: 'Output files' }),
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/doc",
|
|
3
3
|
"displayName": "Documentation",
|
|
4
|
-
"version": "2.2.
|
|
4
|
+
"version": "2.2.1",
|
|
5
5
|
"description": "Documentation support for the travetto framework",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"docs",
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
"directory": "module/doc"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@travetto/base": "^2.2.
|
|
28
|
+
"@travetto/base": "^2.2.1",
|
|
29
29
|
"prismjs": "^1.28.0"
|
|
30
30
|
},
|
|
31
31
|
"optionalPeerDependencies": {
|
|
32
|
-
"@travetto/cli": "^2.2.
|
|
32
|
+
"@travetto/cli": "^2.2.1"
|
|
33
33
|
},
|
|
34
34
|
"private": false,
|
|
35
35
|
"publishConfig": {
|