docgen-tool 3.4.0 → 3.5.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/dist/include/templates/main.html +2 -43
- package/dist/include/templates/pdfCover.html +2 -50
- package/dist/include/templates/pdfFooter.html +1 -14
- package/dist/include/templates/webCover.html +0 -30
- package/dist/package.json +6 -4
- package/dist/src/docgen/docgen.js +36 -61
- package/dist/src/docgen/fs/fs.js +9 -9
- package/dist/src/docgen/fs/markdown.js +11 -11
- package/dist/src/docgen/fs/meta.js +10 -7
- package/dist/src/docgen/fs/templates.js +6 -6
- package/dist/src/docgen/fs/write-pages.js +45 -34
- package/dist/src/docgen/meta/derive-parameters.js +29 -0
- package/dist/src/docgen/meta/sort-pages.js +26 -9
- package/dist/src/docgen/pdf/wkhtmltopdf/wkhtmltopdf.js +16 -16
- package/dist/src/docgen/scaffold/scaffold.js +2 -2
- package/dist/src/docgen/validation/validation.js +4 -3
- package/dist/src/docgen/views/components/copyright/copyright.js +17 -0
- package/dist/src/docgen/views/components/footer/footer.js +22 -0
- package/dist/src/docgen/views/components/pdf-footer/pdf-footer.js +30 -0
- package/dist/src/docgen/views/components/web-table-of-contents/web-table-of-contents.js +41 -0
- package/dist/src/docgen/views/html.js +11 -0
- package/dist/src/docgen/views/pages/cover/cover.js +71 -0
- package/dist/src/docgen/views/pages/cover/pdf-cover.js +24 -0
- package/dist/src/docgen/views/pages/main/main.js +59 -0
- package/dist/src/docgen/views/pages/process-pages.js +170 -0
- package/dist/src/docgen/{html → views}/redirect.js +9 -9
- package/package.json +6 -4
- package/dist/src/docgen/html/process-pages.js +0 -287
- package/dist/src/docgen/html/web-table-of-contents.js +0 -51
|
@@ -37,6 +37,7 @@ $(document).ready( function () {
|
|
|
37
37
|
//toggle visibility of table of contents
|
|
38
38
|
$("#dg-navigator").click(function()
|
|
39
39
|
{
|
|
40
|
+
console.log('navigator click');
|
|
40
41
|
$("#dg-toc").slideToggle("fast");
|
|
41
42
|
$(this).toggleClass("active");
|
|
42
43
|
});
|
|
@@ -54,47 +55,5 @@ MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX",
|
|
|
54
55
|
</script>
|
|
55
56
|
|
|
56
57
|
</head>
|
|
57
|
-
|
|
58
|
-
<body>
|
|
59
|
-
|
|
60
|
-
<div id="dg-toc"></div>
|
|
61
|
-
<div id="dg-navigator">Table of contents</div>
|
|
62
|
-
|
|
63
|
-
<header>
|
|
64
|
-
<div class="w-fixed-width header-container">
|
|
65
|
-
<div class="header">
|
|
66
|
-
<div class="headerLeftBlock">
|
|
67
|
-
<a class="dg-homelink" href="#">
|
|
68
|
-
<div id="dg-logo"></div>
|
|
69
|
-
</a>
|
|
70
|
-
<div id="headerLeftText">
|
|
71
|
-
<a class="dg-homelink" href="#">
|
|
72
|
-
<span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
|
|
73
|
-
</a>
|
|
74
|
-
</div>
|
|
75
|
-
</div>
|
|
76
|
-
<div id="headerRightBlock">
|
|
77
|
-
<span id="dg-backlink"></span>
|
|
78
|
-
</div>
|
|
79
|
-
</div>
|
|
80
|
-
</div>
|
|
81
|
-
</header>
|
|
82
|
-
|
|
83
|
-
<section id="dg-content">
|
|
84
|
-
|
|
85
|
-
</section>
|
|
86
|
-
|
|
87
|
-
<footer>
|
|
88
|
-
<div><p class="w-fixed-width"><span id="dg-web-footer">.</p></div>
|
|
89
|
-
<div class="w-fixed-width">
|
|
90
|
-
<p><span id="dg-copyright"></span></p>
|
|
91
|
-
<p>
|
|
92
|
-
<span id="dg-marking"></span>
|
|
93
|
-
<span id="dg-legalese"></span>
|
|
94
|
-
<span id="dg-attribution"></span>
|
|
95
|
-
</p>
|
|
96
|
-
</div>
|
|
97
|
-
</footer>
|
|
98
|
-
|
|
99
|
-
</body>
|
|
58
|
+
<body></body>
|
|
100
59
|
</html>
|
|
@@ -19,9 +19,8 @@ html {
|
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
#dg-pdfLogo {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
22
|
+
display: inline-block;
|
|
23
|
+
float: right;
|
|
25
24
|
}
|
|
26
25
|
|
|
27
26
|
#dg-coverInfo {
|
|
@@ -75,54 +74,7 @@ html {
|
|
|
75
74
|
font-size: 9px;
|
|
76
75
|
}
|
|
77
76
|
|
|
78
|
-
|
|
79
77
|
</style>
|
|
80
78
|
|
|
81
79
|
<script src="../require/styles/framework.js"></script>
|
|
82
80
|
|
|
83
|
-
</head>
|
|
84
|
-
<body>
|
|
85
|
-
|
|
86
|
-
<div class="w-clear-after"><div id="dg-pdfLogo"><img src="../files/images/logo.svg" /></div></div>
|
|
87
|
-
|
|
88
|
-
<table class="w-table w-fixed" id="dg-coverInfo">
|
|
89
|
-
<thead>
|
|
90
|
-
<tr>
|
|
91
|
-
<th colspan="3" id="dg-title"></th>
|
|
92
|
-
</tr>
|
|
93
|
-
</thead>
|
|
94
|
-
<tfoot>
|
|
95
|
-
</tfoot>
|
|
96
|
-
<tbody>
|
|
97
|
-
<tr>
|
|
98
|
-
<td><strong>Owner: </strong> <span id="dg-owner"></span></td>
|
|
99
|
-
<td><strong>Version: </strong> <span id="dg-version"></span></td>
|
|
100
|
-
<td><strong>Released: </strong> <span id="dg-release-date"></span></td>
|
|
101
|
-
</tr>
|
|
102
|
-
<tr>
|
|
103
|
-
<td><strong>Author: </strong> <span id="dg-author"></span></td>
|
|
104
|
-
<td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
|
|
105
|
-
</tr>
|
|
106
|
-
<tr class="dg-finalRow">
|
|
107
|
-
<td><strong>Module: </strong> <span id="dg-module"></span></td>
|
|
108
|
-
<td><strong>ID: </strong> <span id="dg-id"></span></td>
|
|
109
|
-
<td><strong>Link: </strong> <span id="dg-website"></span></td>
|
|
110
|
-
</tr>
|
|
111
|
-
<tr>
|
|
112
|
-
</tbody>
|
|
113
|
-
</table>
|
|
114
|
-
|
|
115
|
-
<h1>Summary</h1>
|
|
116
|
-
<p id="dg-summary"></p>
|
|
117
|
-
|
|
118
|
-
<div id="dg-footer">
|
|
119
|
-
<p><span id="dg-copyright"></span></p>
|
|
120
|
-
<p id="footnote">
|
|
121
|
-
<span id="dg-marking"></span>
|
|
122
|
-
<span id="dg-legalese"></span>
|
|
123
|
-
<span id="dg-attribution"></span>
|
|
124
|
-
</p>
|
|
125
|
-
</div>
|
|
126
|
-
|
|
127
|
-
</body>
|
|
128
|
-
</html>
|
|
@@ -27,7 +27,7 @@ a {
|
|
|
27
27
|
|
|
28
28
|
</style>
|
|
29
29
|
|
|
30
|
-
<script> /*from wkhtmltopdf
|
|
30
|
+
<script> /*from wkhtmltopdf documentation - substitutes in parameters like page numbers at runtime*/
|
|
31
31
|
function subst() {
|
|
32
32
|
var vars={};
|
|
33
33
|
var x=document.location.search.substring(1).split('&');
|
|
@@ -42,18 +42,5 @@ function subst() {
|
|
|
42
42
|
|
|
43
43
|
</head>
|
|
44
44
|
<body onload="subst()">
|
|
45
|
-
|
|
46
|
-
<div id="dg-footer">
|
|
47
|
-
<table><thead></thead><tfoot></tfoot><tbody>
|
|
48
|
-
<tr>
|
|
49
|
-
<td><span id="dg-title"></span> <span id="dg-web-title-version"></span></td>
|
|
50
|
-
<td><span id="dg-copyright"></span></td>
|
|
51
|
-
<td>Page <span class="page"></span> of <span class="topage"></span></td>
|
|
52
|
-
</tr>
|
|
53
|
-
</tbody></table>
|
|
54
|
-
</div>
|
|
55
|
-
|
|
56
45
|
</body>
|
|
57
46
|
</html>
|
|
58
|
-
|
|
59
|
-
|
|
@@ -41,33 +41,3 @@
|
|
|
41
41
|
}
|
|
42
42
|
|
|
43
43
|
</style>
|
|
44
|
-
|
|
45
|
-
<table class="w-table w-fixed" id="dg-coverInfo">
|
|
46
|
-
<thead>
|
|
47
|
-
<tr>
|
|
48
|
-
<th colspan="3" id="dg-title"></th>
|
|
49
|
-
</tr>
|
|
50
|
-
</thead>
|
|
51
|
-
<tfoot>
|
|
52
|
-
</tfoot>
|
|
53
|
-
<tbody>
|
|
54
|
-
<tr>
|
|
55
|
-
<td><strong>Owner: </strong> <span id="dg-owner"></span></td>
|
|
56
|
-
<td><strong>Version: </strong> <span id="dg-version"></span></td>
|
|
57
|
-
<td><strong>Released: </strong> <span id="dg-release-date"></span></td>
|
|
58
|
-
</tr>
|
|
59
|
-
<tr>
|
|
60
|
-
<td><strong>Author: </strong> <span id="dg-author"></span></td>
|
|
61
|
-
<td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
|
|
62
|
-
</tr>
|
|
63
|
-
<tr class="dg-finalRow">
|
|
64
|
-
<td><strong>Module: </strong> <span id="dg-module"></span></td>
|
|
65
|
-
<td><strong>ID: </strong> <span id="dg-id"></span></td>
|
|
66
|
-
<td><strong>Link: </strong> <span id="dg-website"></span></td>
|
|
67
|
-
</tr>
|
|
68
|
-
<tr>
|
|
69
|
-
</tbody>
|
|
70
|
-
</table>
|
|
71
|
-
|
|
72
|
-
<h1>Summary</h1>
|
|
73
|
-
<p id="dg-summary"></p>
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docgen-tool",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"description": "A tool for creating HTML and PDF documentation",
|
|
5
5
|
"main": "dist/docgen.ts",
|
|
6
6
|
"bin": {
|
|
@@ -34,21 +34,23 @@
|
|
|
34
34
|
"docgen": "prettier --write"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"chalk": "^4.1.0",
|
|
38
37
|
"cheerio": "^1.0.0-rc.12",
|
|
39
38
|
"cli-spinner": "^0.2.10",
|
|
40
39
|
"commander": "^11.0.0",
|
|
41
40
|
"fs-extra": "^11.1.1",
|
|
42
41
|
"husky": "^4.3.0",
|
|
43
|
-
"image-size": "^1.0.2",
|
|
44
42
|
"lint-staged": "^10.5.1",
|
|
43
|
+
"lodash": "^4.17.21",
|
|
45
44
|
"markdown-it": "^13.0.1",
|
|
46
|
-
"
|
|
45
|
+
"picocolors": "^1.0.0",
|
|
46
|
+
"react": "^18.2.0",
|
|
47
|
+
"react-dom": "^18.2.0",
|
|
47
48
|
"spawn-args": "^0.2.0",
|
|
48
49
|
"z-schema": "^6.0.1"
|
|
49
50
|
},
|
|
50
51
|
"devDependencies": {
|
|
51
52
|
"@types/node": "^20.3.1",
|
|
53
|
+
"@types/react": "^18.2.37",
|
|
52
54
|
"eslint": "^8.43.0",
|
|
53
55
|
"eslint-config-prettier": "^8.8.0",
|
|
54
56
|
"ncp": "^2.0.0",
|
|
@@ -40,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
42
|
exports.DocGen = void 0;
|
|
43
|
-
var
|
|
43
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
44
44
|
var path_1 = __importDefault(require("path"));
|
|
45
45
|
var fs_1 = require("./fs/fs");
|
|
46
46
|
var meta_1 = require("./fs/meta");
|
|
@@ -49,26 +49,15 @@ var markdown_1 = require("./fs/markdown");
|
|
|
49
49
|
var wkhtmltopdf_1 = require("./pdf/wkhtmltopdf/wkhtmltopdf");
|
|
50
50
|
var scaffold_1 = require("./scaffold/scaffold");
|
|
51
51
|
var sort_pages_1 = require("./meta/sort-pages");
|
|
52
|
-
var
|
|
53
|
-
var process_pages_1 = require("./
|
|
52
|
+
var derive_parameters_1 = require("./meta/derive-parameters");
|
|
53
|
+
var process_pages_1 = require("./views/pages/process-pages");
|
|
54
54
|
var write_pages_1 = require("./fs/write-pages");
|
|
55
|
-
var redirect_1 = require("./
|
|
55
|
+
var redirect_1 = require("./views/redirect");
|
|
56
56
|
var package_json_1 = require("../../package.json");
|
|
57
57
|
function DocGen(process) {
|
|
58
58
|
var _this = this;
|
|
59
59
|
var mainProcess = process;
|
|
60
60
|
var options;
|
|
61
|
-
var templates = {
|
|
62
|
-
main: '',
|
|
63
|
-
redirect: '',
|
|
64
|
-
webCover: '',
|
|
65
|
-
pdfCover: '',
|
|
66
|
-
pdfHeader: '',
|
|
67
|
-
pdfFooter: '',
|
|
68
|
-
};
|
|
69
|
-
var meta = {};
|
|
70
|
-
var pages = {};
|
|
71
|
-
var sortedPages = {};
|
|
72
61
|
this.getVersion = function () {
|
|
73
62
|
return package_json_1.version;
|
|
74
63
|
};
|
|
@@ -98,18 +87,18 @@ function DocGen(process) {
|
|
|
98
87
|
});
|
|
99
88
|
}); };
|
|
100
89
|
this.run = function () { return __awaiter(_this, void 0, void 0, function () {
|
|
101
|
-
var _a;
|
|
90
|
+
var templates, _a, contents, rawParameters, sortedPages, parameters, pages, hydratedPages;
|
|
102
91
|
return __generator(this, function (_b) {
|
|
103
92
|
switch (_b.label) {
|
|
104
93
|
case 0:
|
|
105
|
-
console.log(
|
|
94
|
+
console.log(picocolors_1.default.green(picocolors_1.default.bold('DocGen version ' + package_json_1.version)));
|
|
106
95
|
//delete and recreate the output directory
|
|
107
96
|
return [4 /*yield*/, (0, fs_1.cleanDirectory)(options.output, options.verbose)];
|
|
108
97
|
case 1:
|
|
109
98
|
//delete and recreate the output directory
|
|
110
99
|
_b.sent();
|
|
111
100
|
return [4 /*yield*/, (0, templates_1.loadTemplates)({
|
|
112
|
-
|
|
101
|
+
options: options,
|
|
113
102
|
mainProcess: mainProcess,
|
|
114
103
|
})];
|
|
115
104
|
case 2:
|
|
@@ -120,62 +109,43 @@ function DocGen(process) {
|
|
|
120
109
|
mainProcess: mainProcess,
|
|
121
110
|
})];
|
|
122
111
|
case 3:
|
|
123
|
-
|
|
124
|
-
sortedPages = (0, sort_pages_1.sortPages)({
|
|
112
|
+
_a = _b.sent(), contents = _a.contents, rawParameters = _a.rawParameters;
|
|
113
|
+
sortedPages = (0, sort_pages_1.sortPages)({ contents: contents });
|
|
114
|
+
parameters = (0, derive_parameters_1.deriveParameters)({
|
|
115
|
+
rawParameters: rawParameters,
|
|
116
|
+
setVersion: options.setVersion,
|
|
117
|
+
setReleaseDate: options.setReleaseDate,
|
|
118
|
+
homeLink: contents[0].pages[0],
|
|
119
|
+
});
|
|
125
120
|
return [4 /*yield*/, (0, markdown_1.loadMarkdown)({
|
|
126
|
-
|
|
127
|
-
contents:
|
|
128
|
-
inputPath: options.input,
|
|
121
|
+
options: options,
|
|
122
|
+
contents: contents,
|
|
129
123
|
mainProcess: mainProcess,
|
|
130
124
|
})];
|
|
131
125
|
case 4:
|
|
132
126
|
pages = _b.sent();
|
|
133
|
-
templates.main = (0, web_table_of_contents_1.generateWebTableOfContents)({
|
|
134
|
-
sortedPages: sortedPages,
|
|
135
|
-
name: meta.parameters.name,
|
|
136
|
-
mainTemplate: templates.main,
|
|
137
|
-
pdfEnabled: options.pdf,
|
|
138
|
-
});
|
|
139
|
-
(0, process_pages_1.insertParameters)({
|
|
140
|
-
inputPath: options.input,
|
|
141
|
-
parameters: meta.parameters,
|
|
142
|
-
setVersion: options.setVersion,
|
|
143
|
-
setReleaseDate: options.setReleaseDate,
|
|
144
|
-
templates: templates,
|
|
145
|
-
mathMathjax: options.mathMathjax,
|
|
146
|
-
mathKatex: options.mathKatex,
|
|
147
|
-
version: package_json_1.version,
|
|
148
|
-
homeLink: meta.contents[0].pages[0],
|
|
149
|
-
});
|
|
150
|
-
_a = templates;
|
|
151
127
|
return [4 /*yield*/, (0, process_pages_1.processPages)({
|
|
128
|
+
templates: templates,
|
|
152
129
|
pages: pages,
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
130
|
+
sortedPages: sortedPages,
|
|
131
|
+
parameters: parameters,
|
|
132
|
+
options: options,
|
|
133
|
+
contents: contents,
|
|
157
134
|
})];
|
|
158
135
|
case 5:
|
|
159
|
-
|
|
136
|
+
hydratedPages = _b.sent();
|
|
160
137
|
return [4 /*yield*/, (0, write_pages_1.writePages)({
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
templates: templates,
|
|
165
|
-
pages: pages,
|
|
166
|
-
pdfEnabled: options.pdf,
|
|
167
|
-
mathKatex: options.mathKatex,
|
|
168
|
-
verbose: options.verbose,
|
|
138
|
+
options: options,
|
|
139
|
+
contents: contents,
|
|
140
|
+
hydratedPages: hydratedPages,
|
|
169
141
|
mainProcess: mainProcess,
|
|
170
142
|
})];
|
|
171
143
|
case 6:
|
|
172
144
|
_b.sent();
|
|
173
145
|
return [4 /*yield*/, (0, redirect_1.createRedirect)({
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
homePage: meta.contents[0].pages[0],
|
|
178
|
-
verbose: options.verbose,
|
|
146
|
+
options: options,
|
|
147
|
+
redirectPage: hydratedPages.redirect,
|
|
148
|
+
homePage: contents[0].pages[0],
|
|
179
149
|
})];
|
|
180
150
|
case 7:
|
|
181
151
|
_b.sent();
|
|
@@ -183,12 +153,17 @@ function DocGen(process) {
|
|
|
183
153
|
return [4 /*yield*/, (0, wkhtmltopdf_1.checkPdfVersion)({ options: options, mainProcess: mainProcess })];
|
|
184
154
|
case 8:
|
|
185
155
|
_b.sent();
|
|
186
|
-
return [4 /*yield*/, (0, wkhtmltopdf_1.generatePdf)({
|
|
156
|
+
return [4 /*yield*/, (0, wkhtmltopdf_1.generatePdf)({
|
|
157
|
+
options: options,
|
|
158
|
+
parameters: parameters,
|
|
159
|
+
sortedPages: sortedPages,
|
|
160
|
+
mainProcess: mainProcess
|
|
161
|
+
})];
|
|
187
162
|
case 9:
|
|
188
163
|
_b.sent();
|
|
189
164
|
return [3 /*break*/, 11];
|
|
190
165
|
case 10:
|
|
191
|
-
console.log(
|
|
166
|
+
console.log(picocolors_1.default.green(picocolors_1.default.bold('Done!')));
|
|
192
167
|
_b.label = 11;
|
|
193
168
|
case 11: return [2 /*return*/];
|
|
194
169
|
}
|
package/dist/src/docgen/fs/fs.js
CHANGED
|
@@ -41,7 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
42
|
exports.removeDirectory = exports.makeDirectory = exports.cleanDirectory = exports.copyDirectory = exports.writeFile = exports.readFile = void 0;
|
|
43
43
|
var path_1 = __importDefault(require("path"));
|
|
44
|
-
var
|
|
44
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
45
45
|
var fs_1 = require("fs");
|
|
46
46
|
var fs_extra_1 = __importDefault(require("fs-extra"));
|
|
47
47
|
var readFile = function (filePath) { return __awaiter(void 0, void 0, void 0, function () {
|
|
@@ -58,7 +58,7 @@ var readFile = function (filePath) { return __awaiter(void 0, void 0, void 0, fu
|
|
|
58
58
|
case 2: return [2 /*return*/, (_a = (_b.sent())) === null || _a === void 0 ? void 0 : _a.replace(/^\uFEFF/, '')]; //remove the BOM (byte-order-mark) from UTF-8 files, if present
|
|
59
59
|
case 3:
|
|
60
60
|
error_1 = _b.sent();
|
|
61
|
-
console.log(
|
|
61
|
+
console.log(picocolors_1.default.red('Error reading file: ' + normalized));
|
|
62
62
|
return [3 /*break*/, 4];
|
|
63
63
|
case 4: return [2 /*return*/];
|
|
64
64
|
}
|
|
@@ -80,7 +80,7 @@ var writeFile = function (filePath, data) { return __awaiter(void 0, void 0, voi
|
|
|
80
80
|
return [3 /*break*/, 4];
|
|
81
81
|
case 3:
|
|
82
82
|
error_2 = _a.sent();
|
|
83
|
-
console.log(
|
|
83
|
+
console.log(picocolors_1.default.red('Error writing file: ' + normalized));
|
|
84
84
|
return [3 /*break*/, 4];
|
|
85
85
|
case 4: return [2 /*return*/];
|
|
86
86
|
}
|
|
@@ -103,12 +103,12 @@ var copyDirectory = function (source, destination, verbose) { return __awaiter(v
|
|
|
103
103
|
return [3 /*break*/, 4];
|
|
104
104
|
case 3:
|
|
105
105
|
error_3 = _a.sent();
|
|
106
|
-
console.log(
|
|
106
|
+
console.log(picocolors_1.default.red('Error copying directory: ' +
|
|
107
107
|
normalizedSource +
|
|
108
108
|
' to ' +
|
|
109
109
|
normalizedDestination));
|
|
110
110
|
if (verbose === true) {
|
|
111
|
-
console.log(
|
|
111
|
+
console.log(picocolors_1.default.red(error_3));
|
|
112
112
|
}
|
|
113
113
|
return [3 /*break*/, 4];
|
|
114
114
|
case 4: return [2 /*return*/];
|
|
@@ -134,9 +134,9 @@ var cleanDirectory = function (directoryPath, verbose) { return __awaiter(void 0
|
|
|
134
134
|
return [3 /*break*/, 5];
|
|
135
135
|
case 4:
|
|
136
136
|
error_4 = _a.sent();
|
|
137
|
-
console.log(
|
|
137
|
+
console.log(picocolors_1.default.red('Error recreating directory: ' + normalized));
|
|
138
138
|
if (verbose === true) {
|
|
139
|
-
console.log(
|
|
139
|
+
console.log(picocolors_1.default.red(error_4));
|
|
140
140
|
}
|
|
141
141
|
return [3 /*break*/, 5];
|
|
142
142
|
case 5: return [2 /*return*/];
|
|
@@ -166,9 +166,9 @@ var removeDirectory = function (directoryPath, verbose) { return __awaiter(void
|
|
|
166
166
|
return [3 /*break*/, 4];
|
|
167
167
|
case 3:
|
|
168
168
|
error_5 = _a.sent();
|
|
169
|
-
console.log(
|
|
169
|
+
console.log(picocolors_1.default.red('Error removing directory: ' + normalized));
|
|
170
170
|
if (verbose === true) {
|
|
171
|
-
console.log(
|
|
171
|
+
console.log(picocolors_1.default.red(error_5));
|
|
172
172
|
}
|
|
173
173
|
return [3 /*break*/, 4];
|
|
174
174
|
case 4: return [2 /*return*/];
|
|
@@ -40,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
42
|
exports.loadMarkdown = void 0;
|
|
43
|
-
var
|
|
43
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
44
44
|
var fs_1 = require("./fs");
|
|
45
45
|
var markdown_it_1 = __importDefault(require("markdown-it"));
|
|
46
46
|
var markdown = new markdown_it_1.default('commonmark').enable('table');
|
|
@@ -51,13 +51,13 @@ markdown.validateLink = function () {
|
|
|
51
51
|
return true;
|
|
52
52
|
};
|
|
53
53
|
var loadMarkdown = function (_a) {
|
|
54
|
-
var contents = _a.contents,
|
|
54
|
+
var contents = _a.contents, options = _a.options, mainProcess = _a.mainProcess;
|
|
55
55
|
return __awaiter(void 0, void 0, void 0, function () {
|
|
56
56
|
var pages, keys_1, files_1, error_1;
|
|
57
57
|
return __generator(this, function (_b) {
|
|
58
58
|
switch (_b.label) {
|
|
59
59
|
case 0:
|
|
60
|
-
console.log(
|
|
60
|
+
console.log(picocolors_1.default.green('Loading src files'));
|
|
61
61
|
pages = {};
|
|
62
62
|
_b.label = 1;
|
|
63
63
|
case 1:
|
|
@@ -67,12 +67,12 @@ var loadMarkdown = function (_a) {
|
|
|
67
67
|
contents.forEach(function (section) {
|
|
68
68
|
section.pages.forEach(function (page) {
|
|
69
69
|
keys_1.push(page);
|
|
70
|
-
files_1.push(
|
|
70
|
+
files_1.push(options.input + '/' + page.source);
|
|
71
71
|
});
|
|
72
72
|
});
|
|
73
73
|
//add the release notes page
|
|
74
74
|
keys_1.push('ownership');
|
|
75
|
-
files_1.push(
|
|
75
|
+
files_1.push(options.input + '/release-notes.md');
|
|
76
76
|
return [4 /*yield*/, Promise.all(files_1.map(function (f) { return (0, fs_1.readFile)(f); }))];
|
|
77
77
|
case 2:
|
|
78
78
|
files_1 = _b.sent();
|
|
@@ -90,9 +90,9 @@ var loadMarkdown = function (_a) {
|
|
|
90
90
|
}
|
|
91
91
|
}
|
|
92
92
|
catch (error) {
|
|
93
|
-
console.log(
|
|
94
|
-
if (verbose === true) {
|
|
95
|
-
console.log(
|
|
93
|
+
console.log(picocolors_1.default.red('Error parsing Markdown file: ' + key.source));
|
|
94
|
+
if (options.verbose === true) {
|
|
95
|
+
console.log(picocolors_1.default.red(error));
|
|
96
96
|
}
|
|
97
97
|
mainProcess.exit(1);
|
|
98
98
|
}
|
|
@@ -101,9 +101,9 @@ var loadMarkdown = function (_a) {
|
|
|
101
101
|
case 3:
|
|
102
102
|
error_1 = _b.sent();
|
|
103
103
|
console.log(error_1);
|
|
104
|
-
console.log(
|
|
105
|
-
if (verbose === true) {
|
|
106
|
-
console.log(
|
|
104
|
+
console.log(picocolors_1.default.red('Error loading src files'));
|
|
105
|
+
if (options.verbose === true) {
|
|
106
|
+
console.log(picocolors_1.default.red(error_1));
|
|
107
107
|
}
|
|
108
108
|
mainProcess.exit(1);
|
|
109
109
|
return [3 /*break*/, 4];
|
|
@@ -40,7 +40,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
42
|
exports.loadMeta = void 0;
|
|
43
|
-
var
|
|
43
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
44
44
|
var fs_1 = require("./fs");
|
|
45
45
|
var validation_1 = require("../validation/validation");
|
|
46
46
|
var loadMeta = function (_a) {
|
|
@@ -55,7 +55,7 @@ var loadMeta = function (_a) {
|
|
|
55
55
|
parameters: null,
|
|
56
56
|
contents: null,
|
|
57
57
|
};
|
|
58
|
-
console.log(
|
|
58
|
+
console.log(picocolors_1.default.green('Loading required JSON metadata files'));
|
|
59
59
|
_c.label = 1;
|
|
60
60
|
case 1:
|
|
61
61
|
_c.trys.push([1, 4, , 5]);
|
|
@@ -79,9 +79,9 @@ var loadMeta = function (_a) {
|
|
|
79
79
|
}
|
|
80
80
|
}
|
|
81
81
|
catch (error) {
|
|
82
|
-
console.log(
|
|
82
|
+
console.log(picocolors_1.default.red('Error parsing required file: ' + key + '.json (invalid JSON)'));
|
|
83
83
|
if (verbose === true) {
|
|
84
|
-
console.log(
|
|
84
|
+
console.log(picocolors_1.default.red(error));
|
|
85
85
|
}
|
|
86
86
|
mainProcess.exit(1);
|
|
87
87
|
}
|
|
@@ -93,12 +93,15 @@ var loadMeta = function (_a) {
|
|
|
93
93
|
pages: [{ title: 'Release notes', source: 'release-notes.md' }],
|
|
94
94
|
};
|
|
95
95
|
meta.contents.push(extra);
|
|
96
|
-
return [2 /*return*/,
|
|
96
|
+
return [2 /*return*/, {
|
|
97
|
+
rawParameters: meta.parameters,
|
|
98
|
+
contents: meta.contents
|
|
99
|
+
}];
|
|
97
100
|
case 4:
|
|
98
101
|
error_1 = _c.sent();
|
|
99
|
-
console.log(
|
|
102
|
+
console.log(picocolors_1.default.red('Error loading required JSON metadata files'));
|
|
100
103
|
if (verbose === true) {
|
|
101
|
-
console.log(
|
|
104
|
+
console.log(picocolors_1.default.red(error_1));
|
|
102
105
|
}
|
|
103
106
|
mainProcess.exit(1);
|
|
104
107
|
return [3 /*break*/, 5];
|
|
@@ -40,11 +40,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
42
|
exports.loadTemplates = void 0;
|
|
43
|
-
var
|
|
43
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
44
44
|
var cheerio_1 = __importDefault(require("cheerio"));
|
|
45
45
|
var fs_1 = require("./fs");
|
|
46
46
|
var loadTemplates = function (_a) {
|
|
47
|
-
var
|
|
47
|
+
var options = _a.options, mainProcess = _a.mainProcess;
|
|
48
48
|
return __awaiter(void 0, void 0, void 0, function () {
|
|
49
49
|
var templates, files, key, file, dom, error_1;
|
|
50
50
|
var _b;
|
|
@@ -52,7 +52,7 @@ var loadTemplates = function (_a) {
|
|
|
52
52
|
switch (_c.label) {
|
|
53
53
|
case 0:
|
|
54
54
|
templates = {};
|
|
55
|
-
console.log(
|
|
55
|
+
console.log(picocolors_1.default.green('Loading templates'));
|
|
56
56
|
_c.label = 1;
|
|
57
57
|
case 1:
|
|
58
58
|
_c.trys.push([1, 8, , 9]);
|
|
@@ -86,9 +86,9 @@ var loadTemplates = function (_a) {
|
|
|
86
86
|
return [2 /*return*/, templates];
|
|
87
87
|
case 8:
|
|
88
88
|
error_1 = _c.sent();
|
|
89
|
-
console.log(
|
|
90
|
-
if (verbose === true) {
|
|
91
|
-
console.log(
|
|
89
|
+
console.log(picocolors_1.default.red('Error loading templates'));
|
|
90
|
+
if (options.verbose === true) {
|
|
91
|
+
console.log(picocolors_1.default.red(error_1));
|
|
92
92
|
}
|
|
93
93
|
mainProcess.exit(1);
|
|
94
94
|
return [3 /*break*/, 9];
|