@appium/docutils 0.3.13 → 0.4.0
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/appium-docs.js +0 -0
- package/build/lib/cli/check.d.ts.map +1 -1
- package/build/lib/cli/check.js +1 -1
- package/build/lib/cli/check.js.map +1 -1
- package/build/lib/cli/command/init.d.ts +22 -0
- package/build/lib/cli/command/init.d.ts.map +1 -1
- package/build/lib/cli/command/init.js +22 -0
- package/build/lib/cli/command/init.js.map +1 -1
- package/build/lib/cli/index.d.ts +2 -2
- package/build/lib/cli/index.d.ts.map +1 -1
- package/build/lib/cli/index.js +22 -3
- package/build/lib/cli/index.js.map +1 -1
- package/build/lib/init.d.ts +24 -10
- package/build/lib/init.d.ts.map +1 -1
- package/build/lib/init.js +31 -2
- package/build/lib/init.js.map +1 -1
- package/build/lib/scaffold.d.ts +1 -1
- package/build/lib/scaffold.d.ts.map +1 -1
- package/build/lib/scaffold.js +11 -3
- package/build/lib/scaffold.js.map +1 -1
- package/lib/cli/check.ts +4 -1
- package/lib/cli/command/init.ts +22 -0
- package/lib/cli/index.ts +27 -4
- package/lib/init.ts +49 -2
- package/lib/scaffold.ts +11 -4
- package/package.json +7 -7
- package/requirements.txt +1 -1
package/bin/appium-docs.js
CHANGED
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAgCnC;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvE,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,
|
|
1
|
+
{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAgCnC;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvE,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAkCxB"}
|
package/build/lib/cli/check.js
CHANGED
|
@@ -49,7 +49,7 @@ async function checkMissingPaths(opts, group, argv) {
|
|
|
49
49
|
const missingPaths = await filterMissing(pathsToCheck);
|
|
50
50
|
if (missingPaths.length) {
|
|
51
51
|
return missingPaths
|
|
52
|
-
.map(({ id, path }) => `
|
|
52
|
+
.map(({ id, path }) => `Default or specified path via --${lodash_1.default.kebabCase(id)} (${path}) does not exist`)
|
|
53
53
|
.join('\n');
|
|
54
54
|
}
|
|
55
55
|
return true;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"check.js","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAyC;AACzC,oDAAuB;AAEvB,sCAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,OAAO,CAAC,CAAC;AAE/B;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAC,KAAwB;IACnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAC,EAAE,EAAE,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,CAAC,CAAC,CAC7E,CAAC;IACF,MAAM,OAAO,GAAG,gBAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3C,OAAO,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9D,CAAC;AAgBD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAO,EACP,KAAa,EACb,IAA6B;IAE7B,MAAM,WAAW,GAAG,gBAAC,CAAC,IAAI,CACxB,gBAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAY,EAAE,EAAU,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,KAAK,IAAI,EAAE,IAAI,IAAI,CAAe,CAC/F,CAAC;IAEF,gGAAgG;IAChG,0FAA0F;IAC1F,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QACpD,OAAO,sCAAsC,CAAC;KAC/C;IAED,MAAM,YAAY,GAAsB,gBAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClE,EAAE;QACF,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,4CAA4C;KACrE,CAAC,CAAC,CAAC;IAEJ,GAAG,CAAC,KAAK,CACP,kCAAkC,EAClC,cAAI,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,EAC3C,gBAAC,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAC5B,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;IAEvD,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,OAAO,YAAY;aAChB,GAAG,
|
|
1
|
+
{"version":3,"file":"check.js","sourceRoot":"","sources":["../../../lib/cli/check.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAyC;AACzC,oDAAuB;AAEvB,sCAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,OAAO,CAAC,CAAC;AAE/B;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAC,KAAwB;IACnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAC,EAAE,EAAE,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,YAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,CAAC,CAAC,CAC7E,CAAC;IACF,MAAM,OAAO,GAAG,gBAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC3C,OAAO,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9D,CAAC;AAgBD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAO,EACP,KAAa,EACb,IAA6B;IAE7B,MAAM,WAAW,GAAG,gBAAC,CAAC,IAAI,CACxB,gBAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAY,EAAE,EAAU,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,KAAK,IAAI,EAAE,IAAI,IAAI,CAAe,CAC/F,CAAC;IAEF,gGAAgG;IAChG,0FAA0F;IAC1F,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QACpD,OAAO,sCAAsC,CAAC;KAC/C;IAED,MAAM,YAAY,GAAsB,gBAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClE,EAAE;QACF,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,4CAA4C;KACrE,CAAC,CAAC,CAAC;IAEJ,GAAG,CAAC,KAAK,CACP,kCAAkC,EAClC,cAAI,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,EAC3C,gBAAC,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAC5B,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;IAEvD,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,OAAO,YAAY;aAChB,GAAG,CACF,CAAC,EAAC,EAAE,EAAE,IAAI,EAAC,EAAE,EAAE,CACb,mCAAmC,gBAAC,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,kBAAkB,CAChF;aACA,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAtCD,8CAsCC"}
|
|
@@ -15,6 +15,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
15
15
|
readonly nargs: 1;
|
|
16
16
|
readonly requiresArg: true;
|
|
17
17
|
readonly type: "string";
|
|
18
|
+
readonly implies: "mkdocs";
|
|
18
19
|
};
|
|
19
20
|
readonly dir: {
|
|
20
21
|
readonly default: ".";
|
|
@@ -44,6 +45,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
44
45
|
readonly group: InitCommandGroup.MkDocs;
|
|
45
46
|
readonly requiresArg: true;
|
|
46
47
|
readonly type: "string";
|
|
48
|
+
readonly implies: "mkdocs";
|
|
47
49
|
};
|
|
48
50
|
readonly mkdocs: {
|
|
49
51
|
readonly default: true;
|
|
@@ -59,6 +61,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
59
61
|
readonly normalize: true;
|
|
60
62
|
readonly requiresArg: true;
|
|
61
63
|
readonly type: "string";
|
|
64
|
+
readonly implies: "mkdocs";
|
|
62
65
|
};
|
|
63
66
|
readonly 'package-json': {
|
|
64
67
|
readonly defaultDescription: "./package.json";
|
|
@@ -83,6 +86,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
83
86
|
readonly normalize: true;
|
|
84
87
|
readonly requiresArg: true;
|
|
85
88
|
readonly type: "string";
|
|
89
|
+
readonly implies: "python";
|
|
86
90
|
};
|
|
87
91
|
readonly 'repo-name': {
|
|
88
92
|
readonly defaultDescription: "(derived from --repo-url)";
|
|
@@ -91,6 +95,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
91
95
|
readonly nargs: 1;
|
|
92
96
|
readonly requiresArg: true;
|
|
93
97
|
readonly type: "string";
|
|
98
|
+
readonly implies: "mkdocs";
|
|
94
99
|
};
|
|
95
100
|
readonly 'repo-url': {
|
|
96
101
|
readonly defaultDescription: "(from package.json)";
|
|
@@ -99,6 +104,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
99
104
|
readonly nargs: 1;
|
|
100
105
|
readonly requiresArg: true;
|
|
101
106
|
readonly type: "string";
|
|
107
|
+
readonly implies: "mkdocs";
|
|
102
108
|
};
|
|
103
109
|
readonly 'site-description': {
|
|
104
110
|
readonly defaultDescription: "(from package.json)";
|
|
@@ -107,6 +113,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
107
113
|
readonly nargs: 1;
|
|
108
114
|
readonly requiresArg: true;
|
|
109
115
|
readonly type: "string";
|
|
116
|
+
readonly implies: "mkdocs";
|
|
110
117
|
};
|
|
111
118
|
readonly 'site-name': {
|
|
112
119
|
readonly defaultDescription: "(extension package name)";
|
|
@@ -115,6 +122,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
115
122
|
readonly nargs: 1;
|
|
116
123
|
readonly requiresArg: true;
|
|
117
124
|
readonly type: "string";
|
|
125
|
+
readonly implies: "mkdocs";
|
|
118
126
|
};
|
|
119
127
|
readonly 'tsconfig-json': {
|
|
120
128
|
readonly defaultDescription: "./tsconfig.json";
|
|
@@ -124,12 +132,14 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
124
132
|
readonly normalize: true;
|
|
125
133
|
readonly requiresArg: true;
|
|
126
134
|
readonly type: "string";
|
|
135
|
+
readonly implies: "typescript";
|
|
127
136
|
};
|
|
128
137
|
readonly typedoc: {
|
|
129
138
|
readonly default: true;
|
|
130
139
|
readonly description: "Create typedoc.json if needed";
|
|
131
140
|
readonly group: InitCommandGroup.Behavior;
|
|
132
141
|
readonly type: "boolean";
|
|
142
|
+
readonly implies: "entry-point";
|
|
133
143
|
};
|
|
134
144
|
readonly 'typedoc-json': {
|
|
135
145
|
readonly defaultDescription: "./typedoc.json";
|
|
@@ -139,6 +149,17 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
139
149
|
readonly normalize: true;
|
|
140
150
|
readonly requiresArg: true;
|
|
141
151
|
readonly type: "string";
|
|
152
|
+
readonly implies: "typedoc";
|
|
153
|
+
};
|
|
154
|
+
readonly 'entry-point': {
|
|
155
|
+
readonly alias: "e";
|
|
156
|
+
readonly describe: "Source entry point of extension";
|
|
157
|
+
readonly group: InitCommandGroup.Paths;
|
|
158
|
+
readonly nargs: 1;
|
|
159
|
+
readonly normalize: false;
|
|
160
|
+
readonly requiresArg: true;
|
|
161
|
+
readonly type: "string";
|
|
162
|
+
readonly implies: "typedoc";
|
|
142
163
|
};
|
|
143
164
|
readonly typescript: {
|
|
144
165
|
readonly default: true;
|
|
@@ -152,6 +173,7 @@ declare const _default: CommandModule<object, InferredOptionTypes<{
|
|
|
152
173
|
readonly group: InitCommandGroup.Behavior;
|
|
153
174
|
readonly type: "boolean";
|
|
154
175
|
readonly conflicts: "force";
|
|
176
|
+
readonly implies: "python";
|
|
155
177
|
};
|
|
156
178
|
}>>;
|
|
157
179
|
export default _default;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAQvE,aAAK,gBAAgB;IACnB,MAAM,mBAAmB;IACzB,KAAK,kBAAkB;IACvB,QAAQ,6BAA6B;CACtC
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAU,MAAM,OAAO,CAAC;AAQvE,aAAK,gBAAgB;IACnB,MAAM,mBAAmB;IACzB,KAAK,kBAAkB;IACvB,QAAQ,6BAA6B;CACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkLD,wBAawC"}
|
|
@@ -31,6 +31,7 @@ const opts = {
|
|
|
31
31
|
nargs: 1,
|
|
32
32
|
requiresArg: true,
|
|
33
33
|
type: 'string',
|
|
34
|
+
implies: 'mkdocs',
|
|
34
35
|
},
|
|
35
36
|
dir: {
|
|
36
37
|
default: '.',
|
|
@@ -60,6 +61,7 @@ const opts = {
|
|
|
60
61
|
group: InitCommandGroup.MkDocs,
|
|
61
62
|
requiresArg: true,
|
|
62
63
|
type: 'string',
|
|
64
|
+
implies: 'mkdocs',
|
|
63
65
|
},
|
|
64
66
|
mkdocs: {
|
|
65
67
|
default: true,
|
|
@@ -75,6 +77,7 @@ const opts = {
|
|
|
75
77
|
normalize: true,
|
|
76
78
|
requiresArg: true,
|
|
77
79
|
type: 'string',
|
|
80
|
+
implies: 'mkdocs',
|
|
78
81
|
},
|
|
79
82
|
'package-json': {
|
|
80
83
|
defaultDescription: './package.json',
|
|
@@ -99,6 +102,7 @@ const opts = {
|
|
|
99
102
|
normalize: true,
|
|
100
103
|
requiresArg: true,
|
|
101
104
|
type: 'string',
|
|
105
|
+
implies: 'python',
|
|
102
106
|
},
|
|
103
107
|
'repo-name': {
|
|
104
108
|
defaultDescription: '(derived from --repo-url)',
|
|
@@ -107,6 +111,7 @@ const opts = {
|
|
|
107
111
|
nargs: 1,
|
|
108
112
|
requiresArg: true,
|
|
109
113
|
type: 'string',
|
|
114
|
+
implies: 'mkdocs',
|
|
110
115
|
},
|
|
111
116
|
'repo-url': {
|
|
112
117
|
defaultDescription: '(from package.json)',
|
|
@@ -115,6 +120,7 @@ const opts = {
|
|
|
115
120
|
nargs: 1,
|
|
116
121
|
requiresArg: true,
|
|
117
122
|
type: 'string',
|
|
123
|
+
implies: 'mkdocs',
|
|
118
124
|
},
|
|
119
125
|
'site-description': {
|
|
120
126
|
defaultDescription: '(from package.json)',
|
|
@@ -123,6 +129,7 @@ const opts = {
|
|
|
123
129
|
nargs: 1,
|
|
124
130
|
requiresArg: true,
|
|
125
131
|
type: 'string',
|
|
132
|
+
implies: 'mkdocs',
|
|
126
133
|
},
|
|
127
134
|
'site-name': {
|
|
128
135
|
defaultDescription: '(extension package name)',
|
|
@@ -131,6 +138,7 @@ const opts = {
|
|
|
131
138
|
nargs: 1,
|
|
132
139
|
requiresArg: true,
|
|
133
140
|
type: 'string',
|
|
141
|
+
implies: 'mkdocs',
|
|
134
142
|
},
|
|
135
143
|
'tsconfig-json': {
|
|
136
144
|
defaultDescription: './tsconfig.json',
|
|
@@ -140,12 +148,14 @@ const opts = {
|
|
|
140
148
|
normalize: true,
|
|
141
149
|
requiresArg: true,
|
|
142
150
|
type: 'string',
|
|
151
|
+
implies: 'typescript',
|
|
143
152
|
},
|
|
144
153
|
typedoc: {
|
|
145
154
|
default: true,
|
|
146
155
|
description: 'Create typedoc.json if needed',
|
|
147
156
|
group: InitCommandGroup.Behavior,
|
|
148
157
|
type: 'boolean',
|
|
158
|
+
implies: 'entry-point',
|
|
149
159
|
},
|
|
150
160
|
'typedoc-json': {
|
|
151
161
|
defaultDescription: './typedoc.json',
|
|
@@ -155,6 +165,17 @@ const opts = {
|
|
|
155
165
|
normalize: true,
|
|
156
166
|
requiresArg: true,
|
|
157
167
|
type: 'string',
|
|
168
|
+
implies: 'typedoc',
|
|
169
|
+
},
|
|
170
|
+
'entry-point': {
|
|
171
|
+
alias: 'e',
|
|
172
|
+
describe: 'Source entry point of extension',
|
|
173
|
+
group: InitCommandGroup.Paths,
|
|
174
|
+
nargs: 1,
|
|
175
|
+
normalize: false,
|
|
176
|
+
requiresArg: true,
|
|
177
|
+
type: 'string',
|
|
178
|
+
implies: 'typedoc',
|
|
158
179
|
},
|
|
159
180
|
typescript: {
|
|
160
181
|
default: true,
|
|
@@ -168,6 +189,7 @@ const opts = {
|
|
|
168
189
|
group: InitCommandGroup.Behavior,
|
|
169
190
|
type: 'boolean',
|
|
170
191
|
conflicts: 'force',
|
|
192
|
+
implies: 'python',
|
|
171
193
|
},
|
|
172
194
|
};
|
|
173
195
|
exports.default = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,oDAAuB;AAEvB,qCAAgC;AAChC,yCAAuC;AACvC,qCAAqC;AACrC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAE9B,IAAK,gBAIJ;AAJD,WAAK,gBAAgB;IACnB,6CAAyB,CAAA;IACzB,2CAAuB,CAAA;IACvB,yDAAqC,CAAA;AACvC,CAAC,EAJI,gBAAgB,KAAhB,gBAAgB,QAIpB;AAED;;;;GAIG;AACH,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../lib/cli/command/init.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,oDAAuB;AAEvB,qCAAgC;AAChC,yCAAuC;AACvC,qCAAqC;AACrC,oCAA2C;AAE3C,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAE9B,IAAK,gBAIJ;AAJD,WAAK,gBAAgB;IACnB,6CAAyB,CAAA;IACzB,2CAAuB,CAAA;IACvB,yDAAqC,CAAA;AACvC,CAAC,EAJI,gBAAgB,KAAhB,gBAAgB,QAIpB;AAED;;;;GAIG;AACH,MAAM,IAAI,GAAG;IACX,SAAS,EAAE;QACT,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,GAAG,EAAE;QACH,OAAO,EAAE,GAAG;QACZ,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,sBAAsB;QACnC,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,SAAS,EAAE,IAAI;QACf,IAAI,EAAE,QAAQ;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,mCAAmC;QAC7C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,CAAC,KAAwB,EAAE,EAAE,CAAC,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC;QACxD,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,YAAY,EAAE;QACZ,kBAAkB,EAAE,cAAc;QAClC,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,+BAA+B;QACzC,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,aAAa,EAAE;QACb,kBAAkB,EAAE,sBAAsB;QAC1C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,2BAA2B;QAC/C,WAAW,EAAE,8BAA8B;QAC3C,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,UAAU,EAAE;QACV,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,qBAAqB;QACzC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,0BAA0B;QAC9C,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,gBAAgB,CAAC,MAAM;QAC9B,KAAK,EAAE,CAAC;QACR,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,QAAQ;KAClB;IACD,eAAe,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,QAAQ,EAAE,uCAAuC;QACjD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,YAAY;KACtB;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,aAAa;KACvB;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,gBAAgB;QACpC,QAAQ,EAAE,sCAAsC;QAChD,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,IAAI;QACf,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,SAAS;KACnB;IACD,aAAa,EAAE;QACb,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,iCAAiC;QAC3C,KAAK,EAAE,gBAAgB,CAAC,KAAK;QAC7B,KAAK,EAAE,CAAC;QACR,SAAS,EAAE,KAAK;QAChB,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,SAAS;KACnB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;KAChB;IACD,OAAO,EAAE;QACP,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,iDAAiD;QAC3D,KAAK,EAAE,gBAAgB,CAAC,QAAQ;QAChC,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,OAAO;QAClB,OAAO,EAAE,QAAQ;KAClB;CACyC,CAAC;AAI7C,kBAAe;IACb,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,uCAAuC;IACjD,OAAO,CAAC,KAAK;QACX,OAAO,KAAK;aACT,OAAO,CAAC,IAAI,CAAC;aACb,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAA,yBAAiB,EAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAClF,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,IAAI;QAChB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,IAAA,WAAI,EAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;CACoC,CAAC"}
|
package/build/lib/cli/index.d.ts
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
export declare function main(argv?: string[]): Promise<{
|
|
3
3
|
[x: string]: unknown;
|
|
4
4
|
verbose: boolean | undefined;
|
|
5
|
-
logLevel: "
|
|
6
|
-
"log-level": "
|
|
5
|
+
logLevel: "info" | "silent" | "error" | "warn" | "debug";
|
|
6
|
+
"log-level": "info" | "silent" | "error" | "warn" | "debug";
|
|
7
7
|
config: string | undefined;
|
|
8
8
|
noConfig: boolean | undefined;
|
|
9
9
|
"no-config": boolean | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";AAwBA,wBAAsB,IAAI,CAAC,IAAI,WAAwB;;;;;;;;;;GAuFtD"}
|
package/build/lib/cli/index.js
CHANGED
|
@@ -11,17 +11,18 @@ exports.main = void 0;
|
|
|
11
11
|
* @module
|
|
12
12
|
*/
|
|
13
13
|
const logger_1 = require("../logger");
|
|
14
|
+
const support_1 = require("@appium/support");
|
|
14
15
|
const lodash_1 = __importDefault(require("lodash"));
|
|
16
|
+
const read_pkg_1 = require("read-pkg");
|
|
15
17
|
const helpers_1 = require("yargs/helpers");
|
|
16
18
|
const yargs_1 = __importDefault(require("yargs/yargs"));
|
|
17
19
|
const constants_1 = require("../constants");
|
|
18
20
|
const error_1 = require("../error");
|
|
19
21
|
const command_1 = require("./command");
|
|
20
22
|
const config_1 = require("./config");
|
|
21
|
-
const support_1 = require("@appium/support");
|
|
22
|
-
const read_pkg_1 = require("read-pkg");
|
|
23
23
|
const pkg = (0, read_pkg_1.sync)({ cwd: support_1.fs.findRoot(__dirname) });
|
|
24
24
|
const log = (0, logger_1.getLogger)('cli');
|
|
25
|
+
const IMPLICATIONS_FAILED_REGEX = /implications\s+failed:\n\s*(.+)\s->\s(.+)$/i;
|
|
25
26
|
async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
|
|
26
27
|
const config = await (0, config_1.findConfig)(argv);
|
|
27
28
|
const y = (0, yargs_1.default)(argv);
|
|
@@ -69,13 +70,31 @@ async function main(argv = (0, helpers_1.hideBin)(process.argv)) {
|
|
|
69
70
|
* Custom failure handler so we can log nicely.
|
|
70
71
|
*/
|
|
71
72
|
(msg, error) => {
|
|
73
|
+
/**
|
|
74
|
+
* yargs' default output if an "implication" fails (e.g., arg _A_ requires arg _B_) leaves much to be desired.
|
|
75
|
+
*
|
|
76
|
+
* @remarks Unfortunately, we do not have access to the parsed arguments object, since it may have failed parsing.
|
|
77
|
+
* @param msg Implication failure message
|
|
78
|
+
* @returns Whether the message was an implication failure
|
|
79
|
+
*/
|
|
80
|
+
const handleImplicationFailure = (msg) => {
|
|
81
|
+
let match;
|
|
82
|
+
if (!(match = msg?.match(IMPLICATIONS_FAILED_REGEX))) {
|
|
83
|
+
return false;
|
|
84
|
+
}
|
|
85
|
+
const [, arg, missingArg] = match;
|
|
86
|
+
log.error(`Argument "--${arg}" requires "--${missingArg}"; note that "--${arg}" may be enabled by default`);
|
|
87
|
+
return true;
|
|
88
|
+
};
|
|
72
89
|
// if it is a DocutilsError, it has nothing to do with the CLI
|
|
73
90
|
if (error instanceof error_1.DocutilsError) {
|
|
74
91
|
log.error(error.message);
|
|
75
92
|
}
|
|
76
93
|
else {
|
|
77
94
|
y.showHelp();
|
|
78
|
-
|
|
95
|
+
if (!handleImplicationFailure(msg)) {
|
|
96
|
+
log.error(`\n\n${msg ?? error.message}`);
|
|
97
|
+
}
|
|
79
98
|
}
|
|
80
99
|
y.exit(1, error);
|
|
81
100
|
})
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;AACA,+BAA+B;;;;;;AAE/B;;;GAGG;AAEH,sCAAoC;AAEpC,oDAAuB;AACvB,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/cli/index.ts"],"names":[],"mappings":";;AACA,+BAA+B;;;;;;AAE/B;;;GAGG;AAEH,sCAAoC;AAEpC,6CAAmC;AACnC,oDAAuB;AACvB,uCAAyC;AACzC,2CAAsC;AACtC,wDAAgC;AAChC,4CAAsE;AACtE,oCAAuC;AACvC,uCAAgD;AAChD,qCAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,eAAO,EAAC,EAAC,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAC,CAAC,CAAC;AACnD,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;AAC7B,MAAM,yBAAyB,GAAG,6CAA6C,CAAC;AAEzE,KAAK,UAAU,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,CAAC,GAAG,IAAA,eAAK,EAAC,IAAI,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;SACX,UAAU,CAAC,oBAAQ,CAAC;SACpB,OAAO,CAAC,eAAK,CAAC;SACd,OAAO,CAAC,cAAI,CAAC;SACb,OAAO,CAAC,kBAAQ,CAAC;SACjB,OAAO,CAAC;QACP,OAAO,EAAE;YACP,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;SACxC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;YACrD,QAAQ,EAAE,oBAAoB;YAC9B,OAAO,EAAE,6BAAiB;YAC1B,MAAM,EAAE,gBAAC,CAAC,QAAmD;SAC9D;QACD,MAAM,EAAE;YACN,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qBAAqB;YAC/B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,IAAI;YACjB,kBAAkB,EAAE,4BAA4B;SACjD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,+BAA+B;SAC1C;KACF,CAAC;SACD,UAAU;IACT;;OAEG;IACH,GAAG,EAAE;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,OAAO,aAAa,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC;IACzE,CAAC,CACF;SACA,MAAM,CAAC,yBAAyB,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC;SAChD,IAAI;IACH;;OAEG;IACH,CAAC,GAAkB,EAAE,KAAK,EAAE,EAAE;QAC5B;;;;;;WAMG;QACH,MAAM,wBAAwB,GAAG,CAAC,GAAkB,EAAW,EAAE;YAC/D,IAAI,KAA0C,CAAC;YAC/C,IAAI,CAAC,CAAC,KAAK,GAAG,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC,EAAE;gBACpD,OAAO,KAAK,CAAC;aACd;YACD,MAAM,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC;YAClC,GAAG,CAAC,KAAK,CACP,eAAe,GAAG,iBAAiB,UAAU,mBAAmB,GAAG,6BAA6B,CACjG,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,8DAA8D;QAC9D,IAAI,KAAK,YAAY,qBAAa,EAAE;YAClC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC1B;aAAM;YACL,CAAC,CAAC,QAAQ,EAAE,CAAC;YAEb,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE;gBAClC,GAAG,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;aAC1C;SACF;QACD,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACnB,CAAC,CACF;SACA,MAAM,CAAC,MAAM,CAAC;QACf,qEAAqE;SACpE,aAAa,CAAC,CAAC,CAAC;QACjB,gDAAgD;SAC/C,MAAM,EAAE;SACR,UAAU,EAAE,CAAC;AAClB,CAAC;AAvFD,oBAuFC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,2FAA2F;IAC3F,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,GAAG,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;CACJ"}
|
package/build/lib/init.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @module
|
|
5
5
|
*/
|
|
6
|
-
import { Simplify } from 'type-fest';
|
|
6
|
+
import { PackageJson, Simplify } from 'type-fest';
|
|
7
7
|
import { ScaffoldTaskOptions } from './scaffold';
|
|
8
8
|
import { TsConfigJson } from './model';
|
|
9
9
|
/**
|
|
@@ -13,9 +13,9 @@ export declare const initTsConfigJson: import("./scaffold").ScaffoldTask<InitTsC
|
|
|
13
13
|
/**
|
|
14
14
|
* Function which scaffolds a `typedoc.json` file
|
|
15
15
|
*/
|
|
16
|
-
export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<
|
|
16
|
+
export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, import("type-fest/source/jsonify").JsonifyObject<{
|
|
17
|
+
$schema?: string | undefined;
|
|
17
18
|
includes?: string | undefined;
|
|
18
|
-
logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
|
|
19
19
|
options?: string | undefined;
|
|
20
20
|
tsconfig?: string | undefined;
|
|
21
21
|
entryPoints?: string[] | undefined;
|
|
@@ -24,7 +24,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
24
24
|
externalPattern?: string[] | undefined;
|
|
25
25
|
excludeExternals?: boolean | undefined;
|
|
26
26
|
excludeNotDocumented?: boolean | undefined;
|
|
27
|
-
excludeNotDocumentedKinds?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
27
|
+
excludeNotDocumentedKinds?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
28
28
|
excludeInternal?: boolean | undefined;
|
|
29
29
|
excludePrivate?: boolean | undefined;
|
|
30
30
|
excludeProtected?: boolean | undefined;
|
|
@@ -33,7 +33,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
33
33
|
out?: string | undefined;
|
|
34
34
|
json?: string | undefined;
|
|
35
35
|
pretty?: boolean | undefined;
|
|
36
|
-
emit?: "
|
|
36
|
+
emit?: "docs" | "both" | "none" | undefined;
|
|
37
37
|
theme?: string | undefined;
|
|
38
38
|
lightHighlightTheme?: import("shiki").Theme | undefined;
|
|
39
39
|
darkHighlightTheme?: import("shiki").Theme | undefined;
|
|
@@ -65,7 +65,7 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
65
65
|
defaultCategory?: string | undefined;
|
|
66
66
|
categoryOrder?: string[] | undefined;
|
|
67
67
|
sort?: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" | "kind")[] | undefined;
|
|
68
|
-
kindSortOrder?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
68
|
+
kindSortOrder?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
69
69
|
visibilityFilters?: {
|
|
70
70
|
[tag: `@${string}`]: boolean;
|
|
71
71
|
protected?: boolean | undefined;
|
|
@@ -82,14 +82,22 @@ export declare const initTypeDocJson: import("./scaffold").ScaffoldTask<Scaffold
|
|
|
82
82
|
version?: boolean | undefined;
|
|
83
83
|
showConfig?: boolean | undefined;
|
|
84
84
|
plugin?: string[] | undefined;
|
|
85
|
+
logLevel?: import("typedoc").LogLevel | "Verbose" | "Info" | "Warn" | "Error" | undefined;
|
|
85
86
|
treatWarningsAsErrors?: boolean | undefined;
|
|
86
87
|
treatValidationWarningsAsErrors?: boolean | undefined;
|
|
87
88
|
intentionallyNotExported?: string[] | undefined;
|
|
88
89
|
validation?: boolean | Partial<import("typedoc").ValidationOptions> | undefined;
|
|
89
|
-
requiredToBeDocumented?: ("Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "
|
|
90
|
-
$schema?: string | undefined;
|
|
90
|
+
requiredToBeDocumented?: ("Reference" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[] | undefined;
|
|
91
91
|
extends?: string | undefined;
|
|
92
92
|
}>>;
|
|
93
|
+
/**
|
|
94
|
+
* Function which scaffolds a `package.json` file
|
|
95
|
+
*
|
|
96
|
+
* This only amends prop `typedoc.entryPoint` to the `package.json` file.
|
|
97
|
+
*
|
|
98
|
+
* If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
|
|
99
|
+
*/
|
|
100
|
+
export declare const initTypeDocPkgJson: import("./scaffold").ScaffoldTask<InitTypeDocOptions, PackageJson>;
|
|
93
101
|
/**
|
|
94
102
|
* Function which scaffolds an `mkdocs.yml` file
|
|
95
103
|
*/
|
|
@@ -137,8 +145,10 @@ export interface InitMkDocsOptions extends ScaffoldTaskOptions {
|
|
|
137
145
|
* This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
|
|
138
146
|
* console output which would need mitigation.
|
|
139
147
|
*/
|
|
140
|
-
export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, }?: InitOptions): Promise<void>;
|
|
141
|
-
export
|
|
148
|
+
export declare function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, entryPoint: typeDocEntryPoint, }?: InitOptions): Promise<void>;
|
|
149
|
+
export interface InitTypeDocOptions extends ScaffoldTaskOptions {
|
|
150
|
+
typeDocEntryPoint?: string;
|
|
151
|
+
}
|
|
142
152
|
export interface InitTsConfigOptions extends ScaffoldTaskOptions {
|
|
143
153
|
/**
|
|
144
154
|
* List of source files (globs supported); typically `src` or `lib`
|
|
@@ -197,5 +207,9 @@ export type InitOptions = Simplify<Omit<InitPythonOptions & InitTsConfigOptions
|
|
|
197
207
|
* If `true`, upgrade only
|
|
198
208
|
*/
|
|
199
209
|
upgrade?: boolean;
|
|
210
|
+
/**
|
|
211
|
+
* Path to entry point of extension (source; not "main" field)
|
|
212
|
+
*/
|
|
213
|
+
entryPoint?: string;
|
|
200
214
|
}>;
|
|
201
215
|
//# sourceMappingURL=init.d.ts.map
|
package/build/lib/init.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAaH,OAAO,EAAC,WAAW,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAqB,mBAAmB,EAAC,MAAM,YAAY,CAAC;AAEnE,OAAO,EAAY,YAAY,EAAc,MAAM,SAAS,CAAC;AAkD7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,sEAyB5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAI3B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,oEAW9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;GAmDtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,UAAU,EACV,MAAc,EACd,OAAe,GAChB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,EACP,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,iBAAiB,GAC9B,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoDlC;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAChC,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAC/F;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CACF,CAAC"}
|
package/build/lib/init.js
CHANGED
|
@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
31
31
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
32
32
|
};
|
|
33
33
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
34
|
-
exports.init = exports.initPython = exports.initMkDocs = exports.initTypeDocJson = exports.initTsConfigJson = void 0;
|
|
34
|
+
exports.init = exports.initPython = exports.initMkDocs = exports.initTypeDocPkgJson = exports.initTypeDocJson = exports.initTsConfigJson = void 0;
|
|
35
35
|
const JSON5 = __importStar(require("json5"));
|
|
36
36
|
const constants_1 = require("./constants");
|
|
37
37
|
const yaml_1 = __importDefault(require("yaml"));
|
|
@@ -70,8 +70,17 @@ const BASE_TSCONFIG_JSON = Object.freeze({
|
|
|
70
70
|
outDir: 'build',
|
|
71
71
|
},
|
|
72
72
|
});
|
|
73
|
+
/**
|
|
74
|
+
* Data for the base `package.json` file.
|
|
75
|
+
* We expect `package.json` to exist, and we are not in the business of creating it.
|
|
76
|
+
* However, we will need to add a `typedoc.entryPoint` prop to it.
|
|
77
|
+
*/
|
|
78
|
+
const BASE_PACKAGE_JSON = Object.freeze({});
|
|
73
79
|
const log = (0, logger_1.getLogger)('init');
|
|
74
80
|
const dryRunLog = (0, logger_1.getLogger)('dry-run', log);
|
|
81
|
+
/**
|
|
82
|
+
* Files included, by default, in `tsconfig.json`
|
|
83
|
+
*/
|
|
75
84
|
const DEFAULT_INCLUDE = ['lib', 'test', 'index.js'];
|
|
76
85
|
/**
|
|
77
86
|
* Function which scaffolds a `tsconfig.json` file
|
|
@@ -101,6 +110,19 @@ exports.initTsConfigJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_T
|
|
|
101
110
|
* Function which scaffolds a `typedoc.json` file
|
|
102
111
|
*/
|
|
103
112
|
exports.initTypeDocJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_TYPEDOC_JSON, BASE_TYPEDOC_JSON, 'TypeDoc configuration');
|
|
113
|
+
/**
|
|
114
|
+
* Function which scaffolds a `package.json` file
|
|
115
|
+
*
|
|
116
|
+
* This only amends prop `typedoc.entryPoint` to the `package.json` file.
|
|
117
|
+
*
|
|
118
|
+
* If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
|
|
119
|
+
*/
|
|
120
|
+
exports.initTypeDocPkgJson = (0, scaffold_1.createScaffoldTask)(constants_1.NAME_PACKAGE_JSON, BASE_PACKAGE_JSON, 'Package configuration for TypeDoc', {
|
|
121
|
+
transform: (content, opts) => ({
|
|
122
|
+
...content,
|
|
123
|
+
typedoc: { entryPoint: opts.typeDocEntryPoint },
|
|
124
|
+
}),
|
|
125
|
+
});
|
|
104
126
|
/**
|
|
105
127
|
* Function which scaffolds an `mkdocs.yml` file
|
|
106
128
|
*/
|
|
@@ -187,7 +209,7 @@ exports.initPython = initPython;
|
|
|
187
209
|
* This runs tasks in serial; it _could_ run in parallel, but it has deleterious effects upon
|
|
188
210
|
* console output which would need mitigation.
|
|
189
211
|
*/
|
|
190
|
-
async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, } = {}) {
|
|
212
|
+
async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPath, packageJson: packageJsonPath, overwrite, include, mkdocs, mkdocsYml: mkdocsYmlPath, siteName, repoName, repoUrl, copyright, dryRun, cwd, pythonPath, upgrade, typedocJson: typeDocJsonPath, entryPoint: typeDocEntryPoint, } = {}) {
|
|
191
213
|
if (!typescript && typedoc) {
|
|
192
214
|
log.warn('Initialization of tsconfig.json disabled. TypeDoc requires a tsconfig.json; please ensure it exists');
|
|
193
215
|
}
|
|
@@ -209,6 +231,13 @@ async function init({ typescript, typedoc, python, tsconfigJson: tsconfigJsonPat
|
|
|
209
231
|
dryRun,
|
|
210
232
|
cwd,
|
|
211
233
|
});
|
|
234
|
+
await (0, exports.initTypeDocPkgJson)({
|
|
235
|
+
packageJson: packageJsonPath,
|
|
236
|
+
overwrite: true,
|
|
237
|
+
dryRun,
|
|
238
|
+
cwd,
|
|
239
|
+
typeDocEntryPoint,
|
|
240
|
+
});
|
|
212
241
|
}
|
|
213
242
|
if (python) {
|
|
214
243
|
await initPython({ pythonPath, dryRun, upgrade });
|
package/build/lib/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../lib/init.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,6CAA+B;AAC/B,2CAOqB;AACrB,gDAAwB;AACxB,+CAAkC;AAElC,mCAAsC;AACtC,yCAAmE;AACnE,qCAAmC;AAEnC,oDAAuB;AACvB,6BAA+D;AAE/D;;GAEG;AACH,MAAM,eAAe,GAAwB,MAAM,CAAC,MAAM,CAAC;IACzD,OAAO,EAAE,iDAAiD;IAC1D,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,iBAAiB,GAA0B,MAAM,CAAC,MAAM,CAAC;IAC7D,OAAO,EAAE,iCAAiC;IAC1C,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,UAAU;IAC9B,KAAK,EAAE,QAAQ;IACf,MAAM,EAAE,MAAM;IACd,WAAW,EAAE,CAAC,GAAG,CAAC;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,kBAAkB,GAA2B,MAAM,CAAC,MAAM,CAAC;IAC/D,OAAO,EAAE,uCAAuC;IAChD,OAAO,EAAE,gCAAgC;IACzC,eAAe,EAAE;QACf,MAAM,EAAE,OAAO;KAChB;CACF,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,iBAAiB,GAA0B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAEnE,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;AACpD;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAA,6BAAkB,EAChD,8BAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B;IACE;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,EAAC,OAAO,EAAC,EAAE,EAAE;QAChC,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACtB,OAAO,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC;SAChC;QACD,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE,gBAAC,CAAC,IAAI,CAAC,OAAO,CAAC;SACzB,CAAC;IACJ,CAAC;IACD,WAAW,EAAE,KAAK,CAAC,KAAK;IACxB,SAAS,EAAE,mBAAc;CAC1B,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,6BAAkB,EAC/C,6BAAiB,EACjB,iBAAiB,EACjB,uBAAuB,CACxB,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,kBAAkB,GAAG,IAAA,6BAAkB,EAClD,6BAAiB,EACjB,iBAAiB,EACjB,mCAAmC,EACnC;IACE,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAC3B,CAAC;QACC,GAAG,OAAO;QACV,OAAO,EAAE,EAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAC;KAC9B,CAAA;CACpB,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,6BAAkB,EAC1C,2BAAe,EACf,eAAe,EACf,sBAAsB,EACtB;IACE,WAAW,EAAE,cAAI,CAAC,KAAK;IACvB,SAAS,EAAE,kBAAa;IACxB,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;YACb,QAAQ,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,OAAO,GAAuB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC;QACnE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC;YAC9B,IAAI,OAAO,EAAE;gBACX,GAAG,CAAC,IAAI,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;aAC3D;SACF;QACD,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;QAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAC,QAAQ,EAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;YAClC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClC,QAAQ,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,QAAQ,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,uCAAuC,EAAE,QAAQ,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;QACvE,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,GAAG,CAAC,WAAW,CAAC;YAClC,IAAI,eAAe,EAAE;gBACnB,GAAG,CAAC,IAAI,CAAC,kDAAkD,EAAE,eAAe,CAAC,CAAC;aAC/E;SACF;QACD,OAAO;YACL,GAAG,OAAO;YACV,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,gBAAgB,EAAE,eAAe;SAClC,CAAC;IACJ,CAAC;CACF,CACF,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,UAAU,EACV,MAAM,GAAG,KAAK,EACd,OAAO,GAAG,KAAK,MACM,EAAE;IACvB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,eAAU,GAAE,CAAC,IAAI,uBAAW,CAAC;IAE/D,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,iCAAqB,CAAC,CAAC;IACnE,IAAI,OAAO,EAAE;QACX,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACxB;IACD,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC5E;SAAM;QACL,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAClE,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC9C,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;YAC3D,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,MAAM,CAAC;YAC9B,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,MAAM,IAAI,qBAAa,CAAC,kDAAkD,MAAM,EAAE,CAAC,CAAC;aACrF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,qBAAa,CACrB,kDAAmD,GAAa,CAAC,OAAO,EAAE,CAC3E,CAAC;SACH;KACF;IACD,GAAG,CAAC,OAAO,CAAC,mEAAmE,CAAC,CAAC;AACnF,CAAC;AA7BD,gCA6BC;AAaD;;;;;GAKG;AACI,KAAK,UAAU,IAAI,CAAC,EACzB,UAAU,EACV,OAAO,EACP,MAAM,EACN,YAAY,EAAE,gBAAgB,EAC9B,WAAW,EAAE,eAAe,EAC5B,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EAAE,aAAa,EACxB,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,MAAM,EACN,GAAG,EACH,UAAU,EACV,OAAO,EACP,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,iBAAiB,MACd,EAAE;IACjB,IAAI,CAAC,UAAU,IAAI,OAAO,EAAE;QAC1B,GAAG,CAAC,IAAI,CACN,qGAAqG,CACtG,CAAC;KACH;IAED,IAAI,UAAU,IAAI,CAAC,OAAO,EAAE;QAC1B,MAAM,IAAA,wBAAgB,EAAC;YACrB,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,OAAO;YACP,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;KACJ;IAED,IAAI,OAAO,IAAI,CAAC,OAAO,EAAE;QACvB,MAAM,IAAA,uBAAe,EAAC;YACpB,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;QACH,MAAM,IAAA,0BAAkB,EAAC;YACvB,WAAW,EAAE,eAAe;YAC5B,SAAS,EAAE,IAAI;YACf,MAAM;YACN,GAAG;YACH,iBAAiB;SAClB,CAAC,CAAC;KACJ;IAED,IAAI,MAAM,EAAE;QACV,MAAM,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;KACjD;IAED,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;QACtB,MAAM,IAAA,kBAAU,EAAC;YACf,IAAI,EAAE,aAAa;YACnB,GAAG;YACH,QAAQ;YACR,OAAO;YACP,QAAQ;YACR,SAAS;YACT,WAAW,EAAE,eAAe;YAC5B,SAAS;YACT,MAAM;SACP,CAAC,CAAC;KACJ;AACH,CAAC;AAxED,oBAwEC"}
|
package/build/lib/scaffold.d.ts
CHANGED
|
@@ -28,7 +28,7 @@ export declare function createScaffoldTask<Opts extends ScaffoldTaskOptions, T e
|
|
|
28
28
|
* Optional function which can be used to post-process the content of a file. Usually used to merge
|
|
29
29
|
* various options with existing content
|
|
30
30
|
*/
|
|
31
|
-
export type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (content: Readonly<T>, opts: TaskSpecificOpts<Opts>, pkg: NormalizedPackageJson) => T;
|
|
31
|
+
export type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (content: Readonly<T>, opts: TaskSpecificOpts<Opts>, pkg: Readonly<NormalizedPackageJson>) => T;
|
|
32
32
|
/**
|
|
33
33
|
* A function which deserializes a string into a JS value.
|
|
34
34
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAC,MAAM,WAAW,CAAC;AA8BhD;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,mBAAmB,IAAI,IAAI,CACnE,IAAI,EACJ,MAAM,mBAAmB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,IAAI,CACjF,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,EACvF,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,CAAC,EACjB,WAAW,EAAE,MAAM,EACnB,EACE,SAAsB,EACtB,WAAwB,EACxB,SAAyB,GAC1B,GAAE,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAM,GACzC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAC,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAE,UAAU,EAAC,MAAM,WAAW,CAAC;AA8BhD;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,mBAAmB,IAAI,IAAI,CACnE,IAAI,EACJ,MAAM,mBAAmB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,IAAI,CACjF,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,UAAU,EACvF,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,CAAC,EACjB,WAAW,EAAE,MAAM,EACnB,EACE,SAAsB,EACtB,WAAwB,EACxB,SAAyB,GAC1B,GAAE,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAM,GACzC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CA8EvB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS,IAAI,CAC3F,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EACpB,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,EAC5B,GAAG,EAAE,QAAQ,CAAC,qBAAqB,CAAC,KACjC,CAAC,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,MAAM,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI,SAAS,mBAAmB,EAAE,CAAC,SAAS,SAAS;IAC9F;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7C;;OAEG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC1C;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
|
package/build/lib/scaffold.js
CHANGED
|
@@ -47,6 +47,7 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
47
47
|
const relativeDest = relativePath(dest);
|
|
48
48
|
log.debug('Initializing %s', relativeDest);
|
|
49
49
|
let shouldWriteDest = false;
|
|
50
|
+
let isNew = false;
|
|
50
51
|
let destContent;
|
|
51
52
|
let result;
|
|
52
53
|
try {
|
|
@@ -61,12 +62,13 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
61
62
|
shouldWriteDest = true;
|
|
62
63
|
log.debug('Creating new file %s', relativeDest);
|
|
63
64
|
destContent = {};
|
|
65
|
+
isNew = true;
|
|
64
66
|
}
|
|
65
67
|
const defaults = transform(defaultContent, opts, pkg);
|
|
66
68
|
const finalDestContent = lodash_1.default.defaultsDeep({}, destContent, defaults);
|
|
67
69
|
shouldWriteDest = shouldWriteDest || !lodash_1.default.isEqual(destContent, finalDestContent);
|
|
68
70
|
if (shouldWriteDest) {
|
|
69
|
-
log.info('Changes needed
|
|
71
|
+
log.info('Changes needed in %s', relativeDest);
|
|
70
72
|
log.debug('Original %s: %O', relativeDest, destContent);
|
|
71
73
|
log.debug('Final %s: %O', relativeDest, finalDestContent);
|
|
72
74
|
const patch = makePatch(dest, destContent, finalDestContent, serialize);
|
|
@@ -77,6 +79,12 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
77
79
|
}
|
|
78
80
|
try {
|
|
79
81
|
await (0, fs_1.safeWriteFile)(dest, finalDestContent, overwrite);
|
|
82
|
+
if (isNew) {
|
|
83
|
+
log.success('Initialized %s', description);
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
log.success('Updated %s', description);
|
|
87
|
+
}
|
|
80
88
|
}
|
|
81
89
|
catch (e) {
|
|
82
90
|
const err = e;
|
|
@@ -93,9 +101,9 @@ function createScaffoldTask(defaultFilename, defaultContent, description, { tran
|
|
|
93
101
|
}
|
|
94
102
|
}
|
|
95
103
|
else {
|
|
96
|
-
log.info('No changes
|
|
104
|
+
log.info('No changes necessary for %s', relativeDest);
|
|
97
105
|
}
|
|
98
|
-
log.success(
|
|
106
|
+
log.success(`${description}: done`);
|
|
99
107
|
return { path: dest, content: finalDestContent };
|
|
100
108
|
};
|
|
101
109
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAmC;AACnC,qCAAmC;AACnC,0DAA6B;AAC7B,+BAAiC;AAGjC,mCAAsC;AACtC,iCAAgC;AAChC,oDAAuB;AACvB,6BAAmE;AACnE,2CAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,OAAmB,EACnB,OAAmB,EACnB,aAAwC,kBAAa;IAErD,OAAO,IAAA,kBAAW,EAChB,QAAQ,EACR,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EACnD,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CACpD,CAAC;AACJ,CAAC;AAmBD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,eAAuB,EACvB,cAAiB,EACjB,WAAmB,EACnB,EACE,SAAS,GAAG,gBAAC,CAAC,QAAQ,EACtB,WAAW,GAAG,IAAI,CAAC,KAAK,EACxB,SAAS,GAAG,kBAAa,MACa,EAAE;IAE1C,OAAO,KAAK,EAAE,EACZ,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,GAAG,IAAI,EACF,EAAkC,EAAE;QACzC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAC1C,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EACrD,IAAI,CACL,CAAC;QACF,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,WAAc,CAAC;QACnB,IAAI,MAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,WAAW,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;gBAChC,MAAM,GAAG,CAAC;aACX;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAChD,WAAW,GAAG,EAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../lib/scaffold.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,6CAAmC;AACnC,qCAAmC;AACnC,0DAA6B;AAC7B,+BAAiC;AAGjC,mCAAsC;AACtC,iCAAgC;AAChC,oDAAuB;AACvB,6BAAmE;AACnE,2CAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;AAC9B,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAE5C;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,OAAmB,EACnB,OAAmB,EACnB,aAAwC,kBAAa;IAErD,OAAO,IAAA,kBAAW,EAChB,QAAQ,EACR,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EACnD,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CACpD,CAAC;AACJ,CAAC;AAmBD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,eAAuB,EACvB,cAAiB,EACjB,WAAmB,EACnB,EACE,SAAS,GAAG,gBAAC,CAAC,QAAQ,EACtB,WAAW,GAAG,IAAI,CAAC,KAAK,EACxB,SAAS,GAAG,kBAAa,MACa,EAAE;IAE1C,OAAO,KAAK,EAAE,EACZ,SAAS,GAAG,KAAK,EACjB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,WAAW,EAAE,eAAe,EAC5B,IAAI,EACJ,MAAM,GAAG,KAAK,EACd,GAAG,IAAI,EACF,EAAkC,EAAE;QACzC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,IAAA,oBAAe,EAC1C,eAAe,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,EACrD,IAAI,CACL,CAAC;QACF,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,IAAI,WAAc,CAAC;QACnB,IAAI,MAA6B,CAAC;QAClC,IAAI;YACF,WAAW,GAAG,WAAW,CAAC,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;gBAChC,MAAM,GAAG,CAAC;aACX;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAChD,WAAW,GAAG,EAAO,CAAC;YACtB,KAAK,GAAG,IAAI,CAAC;SACd;QAED,MAAM,QAAQ,GAAM,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,gBAAgB,GAAM,gBAAC,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEtE,eAAe,GAAG,eAAe,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAE/E,IAAI,eAAe,EAAE;YACnB,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAC/C,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACxD,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;YAExE,IAAI,MAAM,EAAE;gBACV,SAAS,CAAC,IAAI,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;gBACjE,MAAM,GAAG,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;gBACjD,OAAO,MAAM,CAAC;aACf;YAED,IAAI;gBACF,MAAM,IAAA,kBAAa,EAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;gBACvD,IAAI,KAAK,EAAE;oBACT,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;iBAC5C;qBAAM;oBACL,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;iBACxC;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,GAAG,GAAG,CAA0B,CAAC;gBACvC,iDAAiD;gBACjD,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;oBAChC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,gCAAgC,CAAC,CAAC;oBAC1D,GAAG,CAAC,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;iBAChD;qBAAM;oBACL,MAAM,IAAI,qBAAa,CAAC,sBAAsB,YAAY,aAAa,GAAG,CAAC,OAAO,EAAE,EAAE;wBACpF,KAAK,EAAE,GAAG;qBACX,CAAC,CAAC;iBACJ;aACF;SACF;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,YAAY,CAAC,CAAC;SACvD;QACD,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,QAAQ,CAAC,CAAC;QACpC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAC,CAAC;IACjD,CAAC,CAAC;AACJ,CAAC;AAvFD,gDAuFC"}
|
package/lib/cli/check.ts
CHANGED
|
@@ -79,7 +79,10 @@ export async function checkMissingPaths<T extends Record<string, Options>>(
|
|
|
79
79
|
|
|
80
80
|
if (missingPaths.length) {
|
|
81
81
|
return missingPaths
|
|
82
|
-
.map(
|
|
82
|
+
.map(
|
|
83
|
+
({id, path}) =>
|
|
84
|
+
`Default or specified path via --${_.kebabCase(id)} (${path}) does not exist`
|
|
85
|
+
)
|
|
83
86
|
.join('\n');
|
|
84
87
|
}
|
|
85
88
|
|
package/lib/cli/command/init.ts
CHANGED
|
@@ -30,6 +30,7 @@ const opts = {
|
|
|
30
30
|
nargs: 1,
|
|
31
31
|
requiresArg: true,
|
|
32
32
|
type: 'string',
|
|
33
|
+
implies: 'mkdocs',
|
|
33
34
|
},
|
|
34
35
|
dir: {
|
|
35
36
|
default: '.',
|
|
@@ -59,6 +60,7 @@ const opts = {
|
|
|
59
60
|
group: InitCommandGroup.MkDocs,
|
|
60
61
|
requiresArg: true,
|
|
61
62
|
type: 'string',
|
|
63
|
+
implies: 'mkdocs',
|
|
62
64
|
},
|
|
63
65
|
mkdocs: {
|
|
64
66
|
default: true,
|
|
@@ -74,6 +76,7 @@ const opts = {
|
|
|
74
76
|
normalize: true,
|
|
75
77
|
requiresArg: true,
|
|
76
78
|
type: 'string',
|
|
79
|
+
implies: 'mkdocs',
|
|
77
80
|
},
|
|
78
81
|
'package-json': {
|
|
79
82
|
defaultDescription: './package.json',
|
|
@@ -98,6 +101,7 @@ const opts = {
|
|
|
98
101
|
normalize: true,
|
|
99
102
|
requiresArg: true,
|
|
100
103
|
type: 'string',
|
|
104
|
+
implies: 'python',
|
|
101
105
|
},
|
|
102
106
|
'repo-name': {
|
|
103
107
|
defaultDescription: '(derived from --repo-url)',
|
|
@@ -106,6 +110,7 @@ const opts = {
|
|
|
106
110
|
nargs: 1,
|
|
107
111
|
requiresArg: true,
|
|
108
112
|
type: 'string',
|
|
113
|
+
implies: 'mkdocs',
|
|
109
114
|
},
|
|
110
115
|
'repo-url': {
|
|
111
116
|
defaultDescription: '(from package.json)',
|
|
@@ -114,6 +119,7 @@ const opts = {
|
|
|
114
119
|
nargs: 1,
|
|
115
120
|
requiresArg: true,
|
|
116
121
|
type: 'string',
|
|
122
|
+
implies: 'mkdocs',
|
|
117
123
|
},
|
|
118
124
|
'site-description': {
|
|
119
125
|
defaultDescription: '(from package.json)',
|
|
@@ -122,6 +128,7 @@ const opts = {
|
|
|
122
128
|
nargs: 1,
|
|
123
129
|
requiresArg: true,
|
|
124
130
|
type: 'string',
|
|
131
|
+
implies: 'mkdocs',
|
|
125
132
|
},
|
|
126
133
|
'site-name': {
|
|
127
134
|
defaultDescription: '(extension package name)',
|
|
@@ -130,6 +137,7 @@ const opts = {
|
|
|
130
137
|
nargs: 1,
|
|
131
138
|
requiresArg: true,
|
|
132
139
|
type: 'string',
|
|
140
|
+
implies: 'mkdocs',
|
|
133
141
|
},
|
|
134
142
|
'tsconfig-json': {
|
|
135
143
|
defaultDescription: './tsconfig.json',
|
|
@@ -139,12 +147,14 @@ const opts = {
|
|
|
139
147
|
normalize: true,
|
|
140
148
|
requiresArg: true,
|
|
141
149
|
type: 'string',
|
|
150
|
+
implies: 'typescript',
|
|
142
151
|
},
|
|
143
152
|
typedoc: {
|
|
144
153
|
default: true,
|
|
145
154
|
description: 'Create typedoc.json if needed',
|
|
146
155
|
group: InitCommandGroup.Behavior,
|
|
147
156
|
type: 'boolean',
|
|
157
|
+
implies: 'entry-point',
|
|
148
158
|
},
|
|
149
159
|
'typedoc-json': {
|
|
150
160
|
defaultDescription: './typedoc.json',
|
|
@@ -154,6 +164,17 @@ const opts = {
|
|
|
154
164
|
normalize: true,
|
|
155
165
|
requiresArg: true,
|
|
156
166
|
type: 'string',
|
|
167
|
+
implies: 'typedoc',
|
|
168
|
+
},
|
|
169
|
+
'entry-point': {
|
|
170
|
+
alias: 'e',
|
|
171
|
+
describe: 'Source entry point of extension',
|
|
172
|
+
group: InitCommandGroup.Paths,
|
|
173
|
+
nargs: 1,
|
|
174
|
+
normalize: false,
|
|
175
|
+
requiresArg: true,
|
|
176
|
+
type: 'string',
|
|
177
|
+
implies: 'typedoc',
|
|
157
178
|
},
|
|
158
179
|
typescript: {
|
|
159
180
|
default: true,
|
|
@@ -167,6 +188,7 @@ const opts = {
|
|
|
167
188
|
group: InitCommandGroup.Behavior,
|
|
168
189
|
type: 'boolean',
|
|
169
190
|
conflicts: 'force',
|
|
191
|
+
implies: 'python',
|
|
170
192
|
},
|
|
171
193
|
} as const satisfies Record<string, Options>;
|
|
172
194
|
|
package/lib/cli/index.ts
CHANGED
|
@@ -8,19 +8,20 @@
|
|
|
8
8
|
|
|
9
9
|
import {getLogger} from '../logger';
|
|
10
10
|
|
|
11
|
+
import {fs} from '@appium/support';
|
|
11
12
|
import _ from 'lodash';
|
|
13
|
+
import {sync as readPkg} from 'read-pkg';
|
|
12
14
|
import {hideBin} from 'yargs/helpers';
|
|
13
15
|
import yargs from 'yargs/yargs';
|
|
14
16
|
import {DEFAULT_LOG_LEVEL, LogLevelMap, NAME_BIN} from '../constants';
|
|
15
17
|
import {DocutilsError} from '../error';
|
|
16
18
|
import {build, init, validate} from './command';
|
|
17
19
|
import {findConfig} from './config';
|
|
18
|
-
import {fs} from '@appium/support';
|
|
19
|
-
import {sync as readPkg} from 'read-pkg';
|
|
20
20
|
|
|
21
21
|
const pkg = readPkg({cwd: fs.findRoot(__dirname)});
|
|
22
|
-
|
|
23
22
|
const log = getLogger('cli');
|
|
23
|
+
const IMPLICATIONS_FAILED_REGEX = /implications\s+failed:\n\s*(.+)\s->\s(.+)$/i;
|
|
24
|
+
|
|
24
25
|
export async function main(argv = hideBin(process.argv)) {
|
|
25
26
|
const config = await findConfig(argv);
|
|
26
27
|
|
|
@@ -70,12 +71,34 @@ export async function main(argv = hideBin(process.argv)) {
|
|
|
70
71
|
* Custom failure handler so we can log nicely.
|
|
71
72
|
*/
|
|
72
73
|
(msg: string | null, error) => {
|
|
74
|
+
/**
|
|
75
|
+
* yargs' default output if an "implication" fails (e.g., arg _A_ requires arg _B_) leaves much to be desired.
|
|
76
|
+
*
|
|
77
|
+
* @remarks Unfortunately, we do not have access to the parsed arguments object, since it may have failed parsing.
|
|
78
|
+
* @param msg Implication failure message
|
|
79
|
+
* @returns Whether the message was an implication failure
|
|
80
|
+
*/
|
|
81
|
+
const handleImplicationFailure = (msg: string | null): boolean => {
|
|
82
|
+
let match: RegExpMatchArray | null | undefined;
|
|
83
|
+
if (!(match = msg?.match(IMPLICATIONS_FAILED_REGEX))) {
|
|
84
|
+
return false;
|
|
85
|
+
}
|
|
86
|
+
const [, arg, missingArg] = match;
|
|
87
|
+
log.error(
|
|
88
|
+
`Argument "--${arg}" requires "--${missingArg}"; note that "--${arg}" may be enabled by default`
|
|
89
|
+
);
|
|
90
|
+
return true;
|
|
91
|
+
};
|
|
92
|
+
|
|
73
93
|
// if it is a DocutilsError, it has nothing to do with the CLI
|
|
74
94
|
if (error instanceof DocutilsError) {
|
|
75
95
|
log.error(error.message);
|
|
76
96
|
} else {
|
|
77
97
|
y.showHelp();
|
|
78
|
-
|
|
98
|
+
|
|
99
|
+
if (!handleImplicationFailure(msg)) {
|
|
100
|
+
log.error(`\n\n${msg ?? error.message}`);
|
|
101
|
+
}
|
|
79
102
|
}
|
|
80
103
|
y.exit(1, error);
|
|
81
104
|
}
|
package/lib/init.ts
CHANGED
|
@@ -11,10 +11,11 @@ import {
|
|
|
11
11
|
NAME_PYTHON,
|
|
12
12
|
REQUIREMENTS_TXT_PATH,
|
|
13
13
|
NAME_TYPEDOC_JSON,
|
|
14
|
+
NAME_PACKAGE_JSON,
|
|
14
15
|
} from './constants';
|
|
15
16
|
import YAML from 'yaml';
|
|
16
17
|
import {exec} from 'teen_process';
|
|
17
|
-
import {Simplify} from 'type-fest';
|
|
18
|
+
import {PackageJson, Simplify} from 'type-fest';
|
|
18
19
|
import {DocutilsError} from './error';
|
|
19
20
|
import {createScaffoldTask, ScaffoldTaskOptions} from './scaffold';
|
|
20
21
|
import {getLogger} from './logger';
|
|
@@ -54,9 +55,19 @@ const BASE_TSCONFIG_JSON: Readonly<TsConfigJson> = Object.freeze({
|
|
|
54
55
|
},
|
|
55
56
|
});
|
|
56
57
|
|
|
58
|
+
/**
|
|
59
|
+
* Data for the base `package.json` file.
|
|
60
|
+
* We expect `package.json` to exist, and we are not in the business of creating it.
|
|
61
|
+
* However, we will need to add a `typedoc.entryPoint` prop to it.
|
|
62
|
+
*/
|
|
63
|
+
const BASE_PACKAGE_JSON: Readonly<PackageJson> = Object.freeze({});
|
|
64
|
+
|
|
57
65
|
const log = getLogger('init');
|
|
58
66
|
const dryRunLog = getLogger('dry-run', log);
|
|
59
67
|
|
|
68
|
+
/**
|
|
69
|
+
* Files included, by default, in `tsconfig.json`
|
|
70
|
+
*/
|
|
60
71
|
const DEFAULT_INCLUDE = ['lib', 'test', 'index.js'];
|
|
61
72
|
/**
|
|
62
73
|
* Function which scaffolds a `tsconfig.json` file
|
|
@@ -97,6 +108,26 @@ export const initTypeDocJson = createScaffoldTask<InitTypeDocOptions, TypeDocJso
|
|
|
97
108
|
'TypeDoc configuration'
|
|
98
109
|
);
|
|
99
110
|
|
|
111
|
+
/**
|
|
112
|
+
* Function which scaffolds a `package.json` file
|
|
113
|
+
*
|
|
114
|
+
* This only amends prop `typedoc.entryPoint` to the `package.json` file.
|
|
115
|
+
*
|
|
116
|
+
* If, strangely, `package.json` did not exist, then it will now contain _only_ that prop.
|
|
117
|
+
*/
|
|
118
|
+
export const initTypeDocPkgJson = createScaffoldTask<InitTypeDocOptions, PackageJson>(
|
|
119
|
+
NAME_PACKAGE_JSON,
|
|
120
|
+
BASE_PACKAGE_JSON,
|
|
121
|
+
'Package configuration for TypeDoc',
|
|
122
|
+
{
|
|
123
|
+
transform: (content, opts) =>
|
|
124
|
+
({
|
|
125
|
+
...content,
|
|
126
|
+
typedoc: {entryPoint: opts.typeDocEntryPoint},
|
|
127
|
+
} as PackageJson),
|
|
128
|
+
}
|
|
129
|
+
);
|
|
130
|
+
|
|
100
131
|
/**
|
|
101
132
|
* Function which scaffolds an `mkdocs.yml` file
|
|
102
133
|
*/
|
|
@@ -224,6 +255,7 @@ export async function init({
|
|
|
224
255
|
pythonPath,
|
|
225
256
|
upgrade,
|
|
226
257
|
typedocJson: typeDocJsonPath,
|
|
258
|
+
entryPoint: typeDocEntryPoint,
|
|
227
259
|
}: InitOptions = {}): Promise<void> {
|
|
228
260
|
if (!typescript && typedoc) {
|
|
229
261
|
log.warn(
|
|
@@ -250,6 +282,13 @@ export async function init({
|
|
|
250
282
|
dryRun,
|
|
251
283
|
cwd,
|
|
252
284
|
});
|
|
285
|
+
await initTypeDocPkgJson({
|
|
286
|
+
packageJson: packageJsonPath,
|
|
287
|
+
overwrite: true, // <-- always overwrite
|
|
288
|
+
dryRun,
|
|
289
|
+
cwd,
|
|
290
|
+
typeDocEntryPoint,
|
|
291
|
+
});
|
|
253
292
|
}
|
|
254
293
|
|
|
255
294
|
if (python) {
|
|
@@ -271,7 +310,10 @@ export async function init({
|
|
|
271
310
|
}
|
|
272
311
|
}
|
|
273
312
|
|
|
274
|
-
export
|
|
313
|
+
export interface InitTypeDocOptions extends ScaffoldTaskOptions {
|
|
314
|
+
typeDocEntryPoint?: string;
|
|
315
|
+
}
|
|
316
|
+
|
|
275
317
|
export interface InitTsConfigOptions extends ScaffoldTaskOptions {
|
|
276
318
|
/**
|
|
277
319
|
* List of source files (globs supported); typically `src` or `lib`
|
|
@@ -334,5 +376,10 @@ export type InitOptions = Simplify<
|
|
|
334
376
|
* If `true`, upgrade only
|
|
335
377
|
*/
|
|
336
378
|
upgrade?: boolean;
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Path to entry point of extension (source; not "main" field)
|
|
382
|
+
*/
|
|
383
|
+
entryPoint?: string;
|
|
337
384
|
}
|
|
338
385
|
>;
|
package/lib/scaffold.ts
CHANGED
|
@@ -92,6 +92,7 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
92
92
|
const relativeDest = relativePath(dest);
|
|
93
93
|
log.debug('Initializing %s', relativeDest);
|
|
94
94
|
let shouldWriteDest = false;
|
|
95
|
+
let isNew = false;
|
|
95
96
|
let destContent: T;
|
|
96
97
|
let result: ScaffoldTaskResult<T>;
|
|
97
98
|
try {
|
|
@@ -105,6 +106,7 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
105
106
|
shouldWriteDest = true;
|
|
106
107
|
log.debug('Creating new file %s', relativeDest);
|
|
107
108
|
destContent = {} as T;
|
|
109
|
+
isNew = true;
|
|
108
110
|
}
|
|
109
111
|
|
|
110
112
|
const defaults: T = transform(defaultContent, opts, pkg);
|
|
@@ -113,7 +115,7 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
113
115
|
shouldWriteDest = shouldWriteDest || !_.isEqual(destContent, finalDestContent);
|
|
114
116
|
|
|
115
117
|
if (shouldWriteDest) {
|
|
116
|
-
log.info('Changes needed
|
|
118
|
+
log.info('Changes needed in %s', relativeDest);
|
|
117
119
|
log.debug('Original %s: %O', relativeDest, destContent);
|
|
118
120
|
log.debug('Final %s: %O', relativeDest, finalDestContent);
|
|
119
121
|
const patch = makePatch(dest, destContent, finalDestContent, serialize);
|
|
@@ -126,6 +128,11 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
126
128
|
|
|
127
129
|
try {
|
|
128
130
|
await safeWriteFile(dest, finalDestContent, overwrite);
|
|
131
|
+
if (isNew) {
|
|
132
|
+
log.success('Initialized %s', description);
|
|
133
|
+
} else {
|
|
134
|
+
log.success('Updated %s', description);
|
|
135
|
+
}
|
|
129
136
|
} catch (e) {
|
|
130
137
|
const err = e as NodeJS.ErrnoException;
|
|
131
138
|
// this should only be thrown if `force` is false
|
|
@@ -139,9 +146,9 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
139
146
|
}
|
|
140
147
|
}
|
|
141
148
|
} else {
|
|
142
|
-
log.info('No changes
|
|
149
|
+
log.info('No changes necessary for %s', relativeDest);
|
|
143
150
|
}
|
|
144
|
-
log.success(
|
|
151
|
+
log.success(`${description}: done`);
|
|
145
152
|
return {path: dest, content: finalDestContent};
|
|
146
153
|
};
|
|
147
154
|
}
|
|
@@ -153,7 +160,7 @@ export function createScaffoldTask<Opts extends ScaffoldTaskOptions, T extends J
|
|
|
153
160
|
export type ScaffoldTaskTransformer<Opts extends ScaffoldTaskOptions, T extends JsonValue> = (
|
|
154
161
|
content: Readonly<T>,
|
|
155
162
|
opts: TaskSpecificOpts<Opts>,
|
|
156
|
-
pkg: NormalizedPackageJson
|
|
163
|
+
pkg: Readonly<NormalizedPackageJson>
|
|
157
164
|
) => T;
|
|
158
165
|
|
|
159
166
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appium/docutils",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Documentation generation utilities for Appium and related projects",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -49,9 +49,9 @@
|
|
|
49
49
|
"start": "node ./build/lib/cli/index.js"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@appium/support": "^4.0.
|
|
52
|
+
"@appium/support": "^4.0.2",
|
|
53
53
|
"@appium/tsconfig": "^0.3.0",
|
|
54
|
-
"@appium/typedoc-plugin-appium": "^0.6.
|
|
54
|
+
"@appium/typedoc-plugin-appium": "^0.6.5",
|
|
55
55
|
"@sliphua/lilconfig-ts-loader": "3.2.2",
|
|
56
56
|
"@types/which": "3.0.0",
|
|
57
57
|
"chalk": "4.1.2",
|
|
@@ -65,15 +65,15 @@
|
|
|
65
65
|
"log-symbols": "4.1.0",
|
|
66
66
|
"pkg-dir": "5.0.0",
|
|
67
67
|
"read-pkg": "5.2.0",
|
|
68
|
-
"semver": "7.5.
|
|
68
|
+
"semver": "7.5.1",
|
|
69
69
|
"source-map-support": "0.5.21",
|
|
70
70
|
"teen_process": "2.0.2",
|
|
71
|
-
"type-fest": "3.
|
|
71
|
+
"type-fest": "3.11.1",
|
|
72
72
|
"typedoc": "0.23.28",
|
|
73
73
|
"typedoc-plugin-markdown": "3.14.0",
|
|
74
74
|
"typedoc-plugin-resolve-crossmodule-references": "0.3.3",
|
|
75
75
|
"typescript": "4.9.5",
|
|
76
|
-
"yaml": "2.
|
|
76
|
+
"yaml": "2.3.1",
|
|
77
77
|
"yargs": "17.7.2",
|
|
78
78
|
"yargs-parser": "21.1.1"
|
|
79
79
|
},
|
|
@@ -84,5 +84,5 @@
|
|
|
84
84
|
"publishConfig": {
|
|
85
85
|
"access": "public"
|
|
86
86
|
},
|
|
87
|
-
"gitHead": "
|
|
87
|
+
"gitHead": "d0ebbaa0c683eeba04d9d967af2d0fde76197950"
|
|
88
88
|
}
|
package/requirements.txt
CHANGED