docgen-tool 3.3.1 → 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 +74 -0
- package/dist/src/docgen/docgen.js +173 -0
- package/dist/src/docgen/execute/execute.js +63 -0
- package/dist/{docgen → src/docgen}/fs/fs.js +9 -9
- package/dist/src/docgen/fs/markdown.js +115 -0
- package/dist/src/docgen/fs/meta.js +113 -0
- package/dist/src/docgen/fs/templates.js +100 -0
- package/dist/src/docgen/fs/write-pages.js +113 -0
- package/dist/src/docgen/meta/derive-parameters.js +29 -0
- package/dist/src/docgen/meta/sort-pages.js +32 -0
- package/dist/src/docgen/pdf/wkhtmltopdf/wkhtmltopdf.js +186 -0
- package/dist/src/docgen/scaffold/scaffold.js +60 -0
- package/dist/src/docgen/types.js +2 -0
- package/dist/src/docgen/validation/validation.js +152 -0
- 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/views/redirect.js +83 -0
- package/package.json +11 -8
- package/dist/docgen/docgen.js +0 -1009
- /package/dist/{docgen.js → src/docgen.js} +0 -0
|
@@ -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>
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "docgen-tool",
|
|
3
|
+
"version": "3.5.0",
|
|
4
|
+
"description": "A tool for creating HTML and PDF documentation",
|
|
5
|
+
"main": "dist/docgen.ts",
|
|
6
|
+
"bin": {
|
|
7
|
+
"docgen": "dist/docgen.ts"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"dist/*"
|
|
11
|
+
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"copy:files": "ncp src/include dist/include",
|
|
14
|
+
"dev": "ts-node src/docgen.ts run",
|
|
15
|
+
"build": "rimraf dist && tsc -p tsconfig.json && yarn copy:files",
|
|
16
|
+
"run:build": "dist/docgen.ts",
|
|
17
|
+
"build:docs": "ts-node src/docgen.ts run -m -n -r -p -d 40000 -i src/docs -o ./docs",
|
|
18
|
+
"build:docs:nopdf": "ts-node src/docgen.ts run -m -n -r -i src/docs -o ./docs",
|
|
19
|
+
"build:styles": "sass --no-source-map src/styles/main.scss src/include/require/styles/framework.css",
|
|
20
|
+
"test": "npm run prettier:check",
|
|
21
|
+
"test:run": "rimraf src/__test__/test-run-output && ts-node src/docgen.ts run -i src/__test__/test-run -o src/__test__/test-run-output -p -m -n -d 40000",
|
|
22
|
+
"test:scaffold": "rimraf src/__test__/test-run-output && ts-node src/docgen.ts scaffold -o src/__test__/test-run-output",
|
|
23
|
+
"test:prod:run": "rimraf src/__test__/test-run-output && ./dist/docgen.js run -i src/__test__/test-run -o ../source/__test__/test-run-output -p -m -n -d 40000",
|
|
24
|
+
"prettier:check": "prettier --check 'src/docgen.ts' '*.{ts,js,json,css,less}'",
|
|
25
|
+
"prettier:fix": "prettier --write 'src/docgen.ts' '*.{ts,js,json,css,less}'"
|
|
26
|
+
},
|
|
27
|
+
"husky": {
|
|
28
|
+
"hooks": {
|
|
29
|
+
"pre-commit": "lint-staged"
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"lint-staged": {
|
|
33
|
+
"*.{js,json,css,less}": "prettier --write",
|
|
34
|
+
"docgen": "prettier --write"
|
|
35
|
+
},
|
|
36
|
+
"dependencies": {
|
|
37
|
+
"cheerio": "^1.0.0-rc.12",
|
|
38
|
+
"cli-spinner": "^0.2.10",
|
|
39
|
+
"commander": "^11.0.0",
|
|
40
|
+
"fs-extra": "^11.1.1",
|
|
41
|
+
"husky": "^4.3.0",
|
|
42
|
+
"lint-staged": "^10.5.1",
|
|
43
|
+
"lodash": "^4.17.21",
|
|
44
|
+
"markdown-it": "^13.0.1",
|
|
45
|
+
"picocolors": "^1.0.0",
|
|
46
|
+
"react": "^18.2.0",
|
|
47
|
+
"react-dom": "^18.2.0",
|
|
48
|
+
"spawn-args": "^0.2.0",
|
|
49
|
+
"z-schema": "^6.0.1"
|
|
50
|
+
},
|
|
51
|
+
"devDependencies": {
|
|
52
|
+
"@types/node": "^20.3.1",
|
|
53
|
+
"@types/react": "^18.2.37",
|
|
54
|
+
"eslint": "^8.43.0",
|
|
55
|
+
"eslint-config-prettier": "^8.8.0",
|
|
56
|
+
"ncp": "^2.0.0",
|
|
57
|
+
"prettier": "^2.1.2",
|
|
58
|
+
"rimraf": "^5.0.1",
|
|
59
|
+
"sass": "^1.66.1",
|
|
60
|
+
"ts-node": "^10.9.1",
|
|
61
|
+
"tslib": "^2.5.3",
|
|
62
|
+
"typescript": "^5.1.3"
|
|
63
|
+
},
|
|
64
|
+
"repository": {
|
|
65
|
+
"type": "git",
|
|
66
|
+
"url": "https://github.com/mtmacdonald/docgen"
|
|
67
|
+
},
|
|
68
|
+
"author": "Inkit Inc. and contributors",
|
|
69
|
+
"license": "MIT",
|
|
70
|
+
"bugs": {
|
|
71
|
+
"url": "https://github.com/mtmacdonald/docgen/issues"
|
|
72
|
+
},
|
|
73
|
+
"homepage": "https://mtmacdonald.github.io/docgen/docs/index.html"
|
|
74
|
+
}
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
39
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
|
+
};
|
|
41
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
|
+
exports.DocGen = void 0;
|
|
43
|
+
var picocolors_1 = __importDefault(require("picocolors"));
|
|
44
|
+
var path_1 = __importDefault(require("path"));
|
|
45
|
+
var fs_1 = require("./fs/fs");
|
|
46
|
+
var meta_1 = require("./fs/meta");
|
|
47
|
+
var templates_1 = require("./fs/templates");
|
|
48
|
+
var markdown_1 = require("./fs/markdown");
|
|
49
|
+
var wkhtmltopdf_1 = require("./pdf/wkhtmltopdf/wkhtmltopdf");
|
|
50
|
+
var scaffold_1 = require("./scaffold/scaffold");
|
|
51
|
+
var sort_pages_1 = require("./meta/sort-pages");
|
|
52
|
+
var derive_parameters_1 = require("./meta/derive-parameters");
|
|
53
|
+
var process_pages_1 = require("./views/pages/process-pages");
|
|
54
|
+
var write_pages_1 = require("./fs/write-pages");
|
|
55
|
+
var redirect_1 = require("./views/redirect");
|
|
56
|
+
var package_json_1 = require("../../package.json");
|
|
57
|
+
function DocGen(process) {
|
|
58
|
+
var _this = this;
|
|
59
|
+
var mainProcess = process;
|
|
60
|
+
var options;
|
|
61
|
+
this.getVersion = function () {
|
|
62
|
+
return package_json_1.version;
|
|
63
|
+
};
|
|
64
|
+
this.setOptions = function (userOptions) {
|
|
65
|
+
options = userOptions;
|
|
66
|
+
//all user-specified paths must be normalized
|
|
67
|
+
if (options.input) {
|
|
68
|
+
options.input = path_1.default.normalize(options.input + '/');
|
|
69
|
+
}
|
|
70
|
+
if (options.output) {
|
|
71
|
+
options.output = path_1.default.normalize(options.output + '/');
|
|
72
|
+
}
|
|
73
|
+
//wkhtmltopdf path does not need a trailing slash
|
|
74
|
+
if (options.wkhtmltopdfPath && options.wkhtmltopdfPath !== '') {
|
|
75
|
+
options.wkhtmltopdfPath = path_1.default.normalize(options.wkhtmltopdfPath);
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
/*
|
|
79
|
+
copy the example src files (template) to any directory, when scaffold command is invoked
|
|
80
|
+
*/
|
|
81
|
+
this.scaffold = function () { return __awaiter(_this, void 0, void 0, function () {
|
|
82
|
+
return __generator(this, function (_a) {
|
|
83
|
+
return [2 /*return*/, (0, scaffold_1.scaffold)({
|
|
84
|
+
outputDirectory: options.output,
|
|
85
|
+
verbose: options.verbose === true,
|
|
86
|
+
})];
|
|
87
|
+
});
|
|
88
|
+
}); };
|
|
89
|
+
this.run = function () { return __awaiter(_this, void 0, void 0, function () {
|
|
90
|
+
var templates, _a, contents, rawParameters, sortedPages, parameters, pages, hydratedPages;
|
|
91
|
+
return __generator(this, function (_b) {
|
|
92
|
+
switch (_b.label) {
|
|
93
|
+
case 0:
|
|
94
|
+
console.log(picocolors_1.default.green(picocolors_1.default.bold('DocGen version ' + package_json_1.version)));
|
|
95
|
+
//delete and recreate the output directory
|
|
96
|
+
return [4 /*yield*/, (0, fs_1.cleanDirectory)(options.output, options.verbose)];
|
|
97
|
+
case 1:
|
|
98
|
+
//delete and recreate the output directory
|
|
99
|
+
_b.sent();
|
|
100
|
+
return [4 /*yield*/, (0, templates_1.loadTemplates)({
|
|
101
|
+
options: options,
|
|
102
|
+
mainProcess: mainProcess,
|
|
103
|
+
})];
|
|
104
|
+
case 2:
|
|
105
|
+
templates = _b.sent();
|
|
106
|
+
return [4 /*yield*/, (0, meta_1.loadMeta)({
|
|
107
|
+
inputPath: options.input,
|
|
108
|
+
verbose: options.verbose,
|
|
109
|
+
mainProcess: mainProcess,
|
|
110
|
+
})];
|
|
111
|
+
case 3:
|
|
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
|
+
});
|
|
120
|
+
return [4 /*yield*/, (0, markdown_1.loadMarkdown)({
|
|
121
|
+
options: options,
|
|
122
|
+
contents: contents,
|
|
123
|
+
mainProcess: mainProcess,
|
|
124
|
+
})];
|
|
125
|
+
case 4:
|
|
126
|
+
pages = _b.sent();
|
|
127
|
+
return [4 /*yield*/, (0, process_pages_1.processPages)({
|
|
128
|
+
templates: templates,
|
|
129
|
+
pages: pages,
|
|
130
|
+
sortedPages: sortedPages,
|
|
131
|
+
parameters: parameters,
|
|
132
|
+
options: options,
|
|
133
|
+
contents: contents,
|
|
134
|
+
})];
|
|
135
|
+
case 5:
|
|
136
|
+
hydratedPages = _b.sent();
|
|
137
|
+
return [4 /*yield*/, (0, write_pages_1.writePages)({
|
|
138
|
+
options: options,
|
|
139
|
+
contents: contents,
|
|
140
|
+
hydratedPages: hydratedPages,
|
|
141
|
+
mainProcess: mainProcess,
|
|
142
|
+
})];
|
|
143
|
+
case 6:
|
|
144
|
+
_b.sent();
|
|
145
|
+
return [4 /*yield*/, (0, redirect_1.createRedirect)({
|
|
146
|
+
options: options,
|
|
147
|
+
redirectPage: hydratedPages.redirect,
|
|
148
|
+
homePage: contents[0].pages[0],
|
|
149
|
+
})];
|
|
150
|
+
case 7:
|
|
151
|
+
_b.sent();
|
|
152
|
+
if (!(options.pdf === true)) return [3 /*break*/, 10];
|
|
153
|
+
return [4 /*yield*/, (0, wkhtmltopdf_1.checkPdfVersion)({ options: options, mainProcess: mainProcess })];
|
|
154
|
+
case 8:
|
|
155
|
+
_b.sent();
|
|
156
|
+
return [4 /*yield*/, (0, wkhtmltopdf_1.generatePdf)({
|
|
157
|
+
options: options,
|
|
158
|
+
parameters: parameters,
|
|
159
|
+
sortedPages: sortedPages,
|
|
160
|
+
mainProcess: mainProcess
|
|
161
|
+
})];
|
|
162
|
+
case 9:
|
|
163
|
+
_b.sent();
|
|
164
|
+
return [3 /*break*/, 11];
|
|
165
|
+
case 10:
|
|
166
|
+
console.log(picocolors_1.default.green(picocolors_1.default.bold('Done!')));
|
|
167
|
+
_b.label = 11;
|
|
168
|
+
case 11: return [2 /*return*/];
|
|
169
|
+
}
|
|
170
|
+
});
|
|
171
|
+
}); };
|
|
172
|
+
}
|
|
173
|
+
exports.DocGen = DocGen;
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.execute = void 0;
|
|
40
|
+
var util_1 = require("util");
|
|
41
|
+
var child_process_1 = require("child_process");
|
|
42
|
+
var execPromise = (0, util_1.promisify)(child_process_1.exec);
|
|
43
|
+
function execute(command) {
|
|
44
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
45
|
+
var _a, stdout, stderr, e_1;
|
|
46
|
+
return __generator(this, function (_b) {
|
|
47
|
+
switch (_b.label) {
|
|
48
|
+
case 0:
|
|
49
|
+
_b.trys.push([0, 2, , 3]);
|
|
50
|
+
return [4 /*yield*/, execPromise(command)];
|
|
51
|
+
case 1:
|
|
52
|
+
_a = _b.sent(), stdout = _a.stdout, stderr = _a.stderr;
|
|
53
|
+
return [2 /*return*/, { stdout: stdout, stderr: stderr }];
|
|
54
|
+
case 2:
|
|
55
|
+
e_1 = _b.sent();
|
|
56
|
+
console.error(e_1);
|
|
57
|
+
return [3 /*break*/, 3];
|
|
58
|
+
case 3: return [2 /*return*/];
|
|
59
|
+
}
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
exports.execute = execute;
|
|
@@ -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*/];
|