web-documentation 1.0.35 → 1.0.37
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 +9 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "web-documentation",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.37",
|
|
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.1067.0",
|
|
54
55
|
"@babel/eslint-parser": "^7.29.7",
|
|
55
56
|
"@babel/runtime": "^7.29.7",
|
|
56
57
|
"@eslint/js": "^10.0.1",
|
|
@@ -60,7 +61,7 @@
|
|
|
60
61
|
"@types/html-minifier": "^4.0.6",
|
|
61
62
|
"@types/jsdom": "^28.0.3",
|
|
62
63
|
"@types/marked": "^6.0.0",
|
|
63
|
-
"@types/node": "^25.9.
|
|
64
|
+
"@types/node": "^25.9.3",
|
|
64
65
|
"@types/unzipper": "^0.10.11",
|
|
65
66
|
"@types/webpack-env": "^1.18.8",
|
|
66
67
|
"@typescript-eslint/eslint-plugin": "^8.61.0",
|
|
@@ -70,9 +71,9 @@
|
|
|
70
71
|
"bootstrap-icons": "^1.13.1",
|
|
71
72
|
"clientnode": "^4.0.1422",
|
|
72
73
|
"css-loader": "^7.1.4",
|
|
73
|
-
"cssnano": "^8.0.
|
|
74
|
+
"cssnano": "^8.0.2",
|
|
74
75
|
"default-gateway": "^7.2.2",
|
|
75
|
-
"errorreporter": "^1.0.
|
|
76
|
+
"errorreporter": "^1.0.348",
|
|
76
77
|
"eslint": "^10.4.1",
|
|
77
78
|
"eslint-config-google": "^0.14.0",
|
|
78
79
|
"eslint-plugin-jsdoc": "^63.0.2",
|
|
@@ -104,7 +105,7 @@
|
|
|
104
105
|
"typescript-eslint": "^8.61.0",
|
|
105
106
|
"ua-parser-js": "^2.0.10",
|
|
106
107
|
"unzipper": "^0.12.3",
|
|
107
|
-
"web-component-wrapper": "^0.0.
|
|
108
|
+
"web-component-wrapper": "^0.0.597",
|
|
108
109
|
"web-internationalization": "^2.0.41",
|
|
109
110
|
"weboptimizer": "^3.0.24",
|
|
110
111
|
"webpack-dev-server": "^5.2.4",
|
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
|
-
|
|
63
|
+
webDocumentation?: WebDocumentationConfiguration
|
|
57
64
|
files?: Array<string>
|
|
58
65
|
main?: string
|
|
59
66
|
name: string
|
|
@@ -237,7 +244,7 @@ const generateAndPushNewDocumentationPage = async (
|
|
|
237
244
|
|
|
238
245
|
let parameters: Mapping<unknown> = {}
|
|
239
246
|
for (const [key, value] of Object.entries(
|
|
240
|
-
SCOPE.
|
|
247
|
+
SCOPE.webDocumentation || {}
|
|
241
248
|
))
|
|
242
249
|
parameters[camelCaseToDelimited(key).toUpperCase()] = value
|
|
243
250
|
if (!parameters.TAGLINE && SCOPE.description)
|