web-documentation 1.0.36 → 1.0.38
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/build/deploy.d.ts +6 -0
- package/build/deploy.js +1 -1
- package/package.json +8 -7
- package/source/deploy.ts +10 -18
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "web-documentation",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.38",
|
|
4
4
|
"description": "Declarative multilanguage documentation website generator",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation",
|
|
@@ -31,10 +31,11 @@
|
|
|
31
31
|
"url": "https://github.com/thaibault/web-documentation"
|
|
32
32
|
},
|
|
33
33
|
"scripts": {
|
|
34
|
-
"build": "yarn build:web; yarn build:deploy",
|
|
34
|
+
"build": "yarn build:types; yarn build:web; yarn build:deploy",
|
|
35
35
|
"build:deploy": "weboptimizer build '{__reference__: \"target:deploy\"}'",
|
|
36
36
|
"build:web": "weboptimizer build",
|
|
37
37
|
"build:stats": "weboptimizer build --profile --json /tmp/stats.json | sed --regexp-extended 's/^Running \".+$//' | sed --regexp-extended 's/^Consolidate module request \".+$//' >/tmp/stats.json && echo 'Results successfully written to \"/tmp/stats.json\".'",
|
|
38
|
+
"build:types": "weboptimizer build:types",
|
|
38
39
|
"check": "yarn check:types; yarn lint",
|
|
39
40
|
"check:types": "weboptimizer check:types",
|
|
40
41
|
"clear": "weboptimizer clear",
|
|
@@ -50,7 +51,7 @@
|
|
|
50
51
|
"watch": "weboptimizer build --watch"
|
|
51
52
|
},
|
|
52
53
|
"devDependencies": {
|
|
53
|
-
"@aws-sdk/client-s3": "^3.
|
|
54
|
+
"@aws-sdk/client-s3": "^3.1068.0",
|
|
54
55
|
"@babel/eslint-parser": "^7.29.7",
|
|
55
56
|
"@babel/runtime": "^7.29.7",
|
|
56
57
|
"@eslint/js": "^10.0.1",
|
|
@@ -68,12 +69,12 @@
|
|
|
68
69
|
"@webcomponents/webcomponentsjs": "^2.8.0",
|
|
69
70
|
"archiver": "^8.0.0",
|
|
70
71
|
"bootstrap-icons": "^1.13.1",
|
|
71
|
-
"clientnode": "^4.0.
|
|
72
|
+
"clientnode": "^4.0.1423",
|
|
72
73
|
"css-loader": "^7.1.4",
|
|
73
74
|
"cssnano": "^8.0.2",
|
|
74
75
|
"default-gateway": "^7.2.2",
|
|
75
76
|
"errorreporter": "^1.0.348",
|
|
76
|
-
"eslint": "^10.
|
|
77
|
+
"eslint": "^10.5.0",
|
|
77
78
|
"eslint-config-google": "^0.14.0",
|
|
78
79
|
"eslint-plugin-jsdoc": "^63.0.2",
|
|
79
80
|
"favicons": "^7.3.0",
|
|
@@ -93,7 +94,7 @@
|
|
|
93
94
|
"postcss-loader": "^8.2.1",
|
|
94
95
|
"postcss-mixins": "^12.1.2",
|
|
95
96
|
"postcss-nested": "^7.0.2",
|
|
96
|
-
"postcss-preset-env": "^11.3.
|
|
97
|
+
"postcss-preset-env": "^11.3.1",
|
|
97
98
|
"postcss-scss": "^4.0.9",
|
|
98
99
|
"postcss-sprites": "^4.2.1",
|
|
99
100
|
"postcss-url": "^10.1.4",
|
|
@@ -107,7 +108,7 @@
|
|
|
107
108
|
"web-component-wrapper": "^0.0.597",
|
|
108
109
|
"web-internationalization": "^2.0.41",
|
|
109
110
|
"weboptimizer": "^3.0.24",
|
|
110
|
-
"webpack-dev-server": "^5.2.
|
|
111
|
+
"webpack-dev-server": "^5.2.5",
|
|
111
112
|
"website-utilities": "^1.0.442"
|
|
112
113
|
},
|
|
113
114
|
"engines": {
|
package/source/deploy.ts
CHANGED
|
@@ -45,6 +45,13 @@ import {Stream} from 'stream'
|
|
|
45
45
|
import {Extract} from 'unzipper'
|
|
46
46
|
// endregion
|
|
47
47
|
// region types
|
|
48
|
+
export interface WebDocumentationConfiguration {
|
|
49
|
+
name?: string
|
|
50
|
+
languages?: Array<string>
|
|
51
|
+
tagline?: string
|
|
52
|
+
trackingCode?: string
|
|
53
|
+
}
|
|
54
|
+
|
|
48
55
|
interface MAKE_TEMPORARY_FILE_OPTIONS {
|
|
49
56
|
directory: boolean
|
|
50
57
|
encoding?: BufferEncoding | null
|
|
@@ -53,7 +60,7 @@ interface MAKE_TEMPORARY_FILE_OPTIONS {
|
|
|
53
60
|
}
|
|
54
61
|
interface SCOPE_TYPE extends Mapping<unknown> {
|
|
55
62
|
description?: string
|
|
56
|
-
webDocumentation?:
|
|
63
|
+
webDocumentation?: WebDocumentationConfiguration
|
|
57
64
|
files?: Array<string>
|
|
58
65
|
main?: string
|
|
59
66
|
name: string
|
|
@@ -337,23 +344,8 @@ const generateAndPushNewDocumentationPage = async (
|
|
|
337
344
|
* @returns Path to build distribution bundle or "null" of building failed.
|
|
338
345
|
*/
|
|
339
346
|
const createDistributionBundle = async (): Promise<null | string> => {
|
|
340
|
-
if (
|
|
341
|
-
SCOPE.scripts
|
|
342
|
-
(
|
|
343
|
-
SCOPE.scripts['build:bundle:compatible'] ||
|
|
344
|
-
SCOPE.scripts['build:bundle'] ||
|
|
345
|
-
SCOPE.scripts.build
|
|
346
|
-
)
|
|
347
|
-
) {
|
|
348
|
-
const buildCommand =
|
|
349
|
-
'yarn ' +
|
|
350
|
-
(
|
|
351
|
-
SCOPE.scripts['build:bundle:compatible'] ?
|
|
352
|
-
'build:bundle:compatible' :
|
|
353
|
-
SCOPE.scripts['build:bundle'] ?
|
|
354
|
-
'build:bundle' :
|
|
355
|
-
'build'
|
|
356
|
-
)
|
|
347
|
+
if (SCOPE.scripts && SCOPE.scripts.build) {
|
|
348
|
+
const buildCommand = `yarn ${SCOPE.scripts.build}`
|
|
357
349
|
log.info(`Build distribution bundle via "${buildCommand}".`)
|
|
358
350
|
log.debug(run(buildCommand))
|
|
359
351
|
}
|