@ui5/webcomponents-tools 0.0.0-0a35d6b3d → 0.0.0-0dd36ca4b
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/CHANGELOG.md +514 -0
- package/assets-meta.js +2 -6
- package/components-package/nps.js +12 -18
- package/components-package/wdio.js +404 -405
- package/icons-collection/nps.js +2 -2
- package/lib/amd-to-es6/index.js +102 -0
- package/lib/amd-to-es6/no-remaining-require.js +33 -0
- package/lib/cem/custom-elements-manifest.config.mjs +83 -45
- package/lib/cem/event.mjs +20 -3
- package/lib/cem/schema-internal.json +3 -0
- package/lib/cem/types-internal.d.ts +550 -786
- package/lib/cem/types.d.ts +520 -655
- package/lib/cem/utils.mjs +49 -20
- package/lib/cem/validate.js +20 -13
- package/lib/create-icons/index.js +8 -6
- package/lib/create-illustrations/index.js +40 -33
- package/lib/create-new-component/index.js +4 -11
- package/lib/create-new-component/tsFileContentTemplate.js +3 -12
- package/lib/css-processors/css-processor-component-styles.mjs +47 -0
- package/lib/css-processors/scope-variables.mjs +3 -0
- package/lib/dev-server/ssr-dom-shim-loader.js +26 -0
- package/lib/generate-js-imports/illustrations.js +9 -9
- package/lib/generate-json-imports/i18n.js +3 -35
- package/lib/generate-json-imports/themes.js +2 -29
- package/lib/i18n/defaults.js +1 -1
- package/lib/scoping/lint-src.js +8 -7
- package/package.json +3 -2
- package/components-package/wdio.sync.js +0 -368
- package/lib/create-new-component/jsFileContentTemplate.js +0 -73
- package/lib/esm-abs-to-rel/index.js +0 -61
- package/lib/generate-custom-elements-manifest/index.js +0 -327
- package/lib/jsdoc/config.json +0 -29
- package/lib/jsdoc/configTypescript.json +0 -29
- package/lib/jsdoc/plugin.js +0 -2468
- package/lib/jsdoc/preprocess.js +0 -146
- package/lib/jsdoc/template/publish.js +0 -4120
- package/lib/replace-global-core/index.js +0 -25
@@ -1,61 +0,0 @@
|
|
1
|
-
const esprima = require("esprima");
|
2
|
-
const escodegen = require("escodegen");
|
3
|
-
|
4
|
-
const fs = require("fs").promises;
|
5
|
-
const path = require("path");
|
6
|
-
const basePath = process.argv[2];
|
7
|
-
|
8
|
-
const convertImports = async (srcPath) => {
|
9
|
-
let changed = false;
|
10
|
-
let code = (await fs.readFile(srcPath)).toString();
|
11
|
-
if (code.includes("import(")) {
|
12
|
-
// esprima can't parse this, but it's from the project files
|
13
|
-
return;
|
14
|
-
}
|
15
|
-
const tree = esprima.parseModule(code);
|
16
|
-
const importer = srcPath.replace(basePath, "");
|
17
|
-
const importerDir = path.dirname(importer);
|
18
|
-
// console.log("-> ", importer);
|
19
|
-
tree.body.forEach(node => {
|
20
|
-
if (node.type === "ImportDeclaration") {
|
21
|
-
let importee = node.source.value;
|
22
|
-
if (importee.startsWith(".")) {
|
23
|
-
// add .js extension if missing
|
24
|
-
if (!importee.endsWith(".js")) {
|
25
|
-
node.source.value += ".js"
|
26
|
-
changed = true;
|
27
|
-
}
|
28
|
-
return;
|
29
|
-
}
|
30
|
-
let importeeDir = path.dirname(importee);
|
31
|
-
let importeeFile = path.basename(importee);
|
32
|
-
let relativePath = path.relative(importerDir, importeeDir);
|
33
|
-
if (relativePath.length === 0) {
|
34
|
-
relativePath = "."
|
35
|
-
}
|
36
|
-
if (!relativePath.startsWith(".")) {
|
37
|
-
relativePath = "./" + relativePath;
|
38
|
-
}
|
39
|
-
|
40
|
-
relativePath = relativePath.replace(/\\/g, "/"); // the browser expects unix paths
|
41
|
-
let relativeImport = `${relativePath}/${importeeFile}.js`;
|
42
|
-
// console.log(importee + " --> " + relativeImport);
|
43
|
-
node.source.value = relativeImport;
|
44
|
-
changed = true;
|
45
|
-
}
|
46
|
-
});
|
47
|
-
|
48
|
-
if (changed) {
|
49
|
-
return fs.writeFile(srcPath, escodegen.generate(tree));
|
50
|
-
}
|
51
|
-
}
|
52
|
-
|
53
|
-
const generate = async () => {
|
54
|
-
const { globby } = await import("globby");
|
55
|
-
const fileNames = await globby(basePath.replace(/\\/g, "/") + "**/*.js");
|
56
|
-
return Promise.all(fileNames.map(convertImports).filter(x => !!x));
|
57
|
-
};
|
58
|
-
|
59
|
-
generate().then(() => {
|
60
|
-
console.log("Success: Converted absolute imports to relative for files in:", basePath);
|
61
|
-
});
|
@@ -1,327 +0,0 @@
|
|
1
|
-
const fs = require("fs").promises;
|
2
|
-
const path = require("path");
|
3
|
-
// https://github.com/webcomponents/custom-elements-manifest/blob/main/schema.json
|
4
|
-
|
5
|
-
const inputDir = process.argv[2];
|
6
|
-
const outputDir = process.argv[3];
|
7
|
-
|
8
|
-
const camelToKebabMap = new Map();
|
9
|
-
const apiIndex = new Map();
|
10
|
-
const forbiddenAttributeTypes = ["object", "array"];
|
11
|
-
|
12
|
-
const camelToKebabCase = string => {
|
13
|
-
if (!camelToKebabMap.has(string)) {
|
14
|
-
const result = string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
|
15
|
-
camelToKebabMap.set(string, result);
|
16
|
-
}
|
17
|
-
return camelToKebabMap.get(string);
|
18
|
-
};
|
19
|
-
|
20
|
-
const generateJavaScriptExport = entity => {
|
21
|
-
return {
|
22
|
-
declaration: generateRefenrece(entity.name),
|
23
|
-
deprecated: !!entity.deprecated,
|
24
|
-
kind: "js",
|
25
|
-
name: "default",
|
26
|
-
};
|
27
|
-
};
|
28
|
-
|
29
|
-
const generateCustomElementExport = entity => {
|
30
|
-
return {
|
31
|
-
declaration: {
|
32
|
-
name: entity.basename,
|
33
|
-
module: `${entity.module}.js`,
|
34
|
-
},
|
35
|
-
deprecated: !!entity.deprecated,
|
36
|
-
kind: "custom-element-definition",
|
37
|
-
name: entity.tagname,
|
38
|
-
};
|
39
|
-
};
|
40
|
-
|
41
|
-
const generateJavaScriptModule = entity => {
|
42
|
-
return {
|
43
|
-
kind: "javascript-module",
|
44
|
-
path: `${entity.basename}.js`,
|
45
|
-
declarations: [
|
46
|
-
generateCustomElementDeclaration(entity),
|
47
|
-
],
|
48
|
-
exports: [
|
49
|
-
generateJavaScriptExport(entity),
|
50
|
-
generateCustomElementExport(entity),
|
51
|
-
],
|
52
|
-
};
|
53
|
-
};
|
54
|
-
|
55
|
-
const generateSingleClassField = classField => {
|
56
|
-
let generatedClassField = {
|
57
|
-
deprecated: !!classField.deprecated,
|
58
|
-
kind: "field",
|
59
|
-
name: classField.name,
|
60
|
-
privacy: classField.visibility,
|
61
|
-
static: !!classField.static,
|
62
|
-
type: generateType(classField.type),
|
63
|
-
};
|
64
|
-
|
65
|
-
if (classField.defaultValue) {
|
66
|
-
generatedClassField.default = classField.defaultValue;
|
67
|
-
}
|
68
|
-
|
69
|
-
if (classField.description) {
|
70
|
-
generatedClassField.description = classField.description;
|
71
|
-
}
|
72
|
-
|
73
|
-
return generatedClassField;
|
74
|
-
};
|
75
|
-
|
76
|
-
const generateSingleParameter = parameter => {
|
77
|
-
let generatedParameter = {
|
78
|
-
deprecated: !!parameter.deprecated,
|
79
|
-
name: parameter.name,
|
80
|
-
type: generateType(parameter.type),
|
81
|
-
};
|
82
|
-
|
83
|
-
if (parameter.description) {
|
84
|
-
generatedParameter.description = parameter.description;
|
85
|
-
}
|
86
|
-
|
87
|
-
if (parameter.optional) {
|
88
|
-
generatedParameter.optional = parameter.optional;
|
89
|
-
}
|
90
|
-
|
91
|
-
return generatedParameter;
|
92
|
-
};
|
93
|
-
|
94
|
-
const generateParameters = (parameters) => {
|
95
|
-
return parameters.reduce((newParametersArray, parameter) => {
|
96
|
-
newParametersArray.push(generateSingleParameter(parameter));
|
97
|
-
|
98
|
-
return newParametersArray;
|
99
|
-
}, []);
|
100
|
-
};
|
101
|
-
|
102
|
-
const generateSingleClassMethod = classMethod => {
|
103
|
-
let generatedClassMethod = {
|
104
|
-
deprecated: !!classMethod.deprecated,
|
105
|
-
kind: "method",
|
106
|
-
name: classMethod.name,
|
107
|
-
privacy: classMethod.visibility,
|
108
|
-
static: classMethod.static,
|
109
|
-
};
|
110
|
-
|
111
|
-
if (classMethod.description) {
|
112
|
-
generatedClassMethod.description = classMethod.description;
|
113
|
-
}
|
114
|
-
|
115
|
-
if (classMethod.parameters && classMethod.parameters.length) {
|
116
|
-
generatedClassMethod.parameters = generateParameters(classMethod.parameters);
|
117
|
-
}
|
118
|
-
|
119
|
-
if (classMethod.returnValue) {
|
120
|
-
generatedClassMethod.return = {
|
121
|
-
type: generateType(classMethod.returnValue.type),
|
122
|
-
};
|
123
|
-
|
124
|
-
if (classMethod.returnValue.description) {
|
125
|
-
generatedClassMethod.return.description = classMethod.returnValue.type;
|
126
|
-
}
|
127
|
-
}
|
128
|
-
|
129
|
-
return generatedClassMethod;
|
130
|
-
};
|
131
|
-
|
132
|
-
const generateClassFields = classFields => {
|
133
|
-
return classFields.reduce((newClassFieldsArray, classField) => {
|
134
|
-
newClassFieldsArray.push(generateSingleClassField(classField));
|
135
|
-
|
136
|
-
return newClassFieldsArray;
|
137
|
-
}, []);
|
138
|
-
};
|
139
|
-
|
140
|
-
const generateClassMethods = classMethods => {
|
141
|
-
return classMethods.reduce((newClassMethodsArray, classMethod) => {
|
142
|
-
newClassMethodsArray.push(generateSingleClassMethod(classMethod));
|
143
|
-
|
144
|
-
return newClassMethodsArray;
|
145
|
-
}, []);
|
146
|
-
};
|
147
|
-
|
148
|
-
const generateMembers = (classFields, classMethods) => {
|
149
|
-
return [...generateClassFields(classFields), ...generateClassMethods(classMethods)];
|
150
|
-
};
|
151
|
-
|
152
|
-
const generateType = type => {
|
153
|
-
const dataType = apiIndex.get(type);
|
154
|
-
|
155
|
-
return {
|
156
|
-
text: dataType && dataType.name.includes(".types.") ?
|
157
|
-
filterPublicApi(dataType.properties)
|
158
|
-
.map(prop => `"${prop.name}"`)
|
159
|
-
.join(" | ") : type,
|
160
|
-
};
|
161
|
-
};
|
162
|
-
|
163
|
-
const generateSingleAttribute = attribute => {
|
164
|
-
let generatedAttribute = {
|
165
|
-
default: attribute.defaultValue,
|
166
|
-
deprecated: !!attribute.deprecated,
|
167
|
-
fieldName: attribute.name,
|
168
|
-
name: camelToKebabCase(attribute.name),
|
169
|
-
type: generateType(attribute.type),
|
170
|
-
};
|
171
|
-
|
172
|
-
if (attribute.description) {
|
173
|
-
generatedAttribute.description = attribute.description;
|
174
|
-
}
|
175
|
-
|
176
|
-
return generatedAttribute;
|
177
|
-
};
|
178
|
-
|
179
|
-
const generateAttributes = attributes => {
|
180
|
-
attributes = attributes.reduce((newAttributesArray, attribute) => {
|
181
|
-
newAttributesArray.push(generateSingleAttribute(attribute));
|
182
|
-
|
183
|
-
return newAttributesArray;
|
184
|
-
}, []);
|
185
|
-
|
186
|
-
return attributes;
|
187
|
-
};
|
188
|
-
|
189
|
-
const generateSingleEvent = event => {
|
190
|
-
let generatedEvent = {
|
191
|
-
deprecated: !!event.deprecated,
|
192
|
-
name: event.name,
|
193
|
-
type: event.native === "true" ? "NativeEvent" : "CustomEvent",
|
194
|
-
};
|
195
|
-
|
196
|
-
if (event.description) {
|
197
|
-
generatedEvent.description = event.description;
|
198
|
-
}
|
199
|
-
|
200
|
-
return generatedEvent;
|
201
|
-
};
|
202
|
-
|
203
|
-
const generateEvents = events => {
|
204
|
-
events = events.reduce((newEventsArray, event) => {
|
205
|
-
newEventsArray.push(generateSingleEvent(event));
|
206
|
-
|
207
|
-
return newEventsArray;
|
208
|
-
}, []);
|
209
|
-
|
210
|
-
return events;
|
211
|
-
};
|
212
|
-
|
213
|
-
const generateSingleSlot = slot => {
|
214
|
-
return {
|
215
|
-
deprecated: !!slot.deprecated,
|
216
|
-
description: slot.description,
|
217
|
-
name: slot.name,
|
218
|
-
};
|
219
|
-
};
|
220
|
-
|
221
|
-
const generateSlots = slots => {
|
222
|
-
slots = slots.reduce((newSlotsArray, event) => {
|
223
|
-
newSlotsArray.push(generateSingleSlot(event));
|
224
|
-
|
225
|
-
return newSlotsArray;
|
226
|
-
}, []);
|
227
|
-
|
228
|
-
return slots;
|
229
|
-
};
|
230
|
-
|
231
|
-
const generateCustomElementDeclaration = entity => {
|
232
|
-
let generatedCustomElementDeclaration = {
|
233
|
-
deprecated: !!entity.deprecated,
|
234
|
-
customElement: true,
|
235
|
-
kind: entity.basename,
|
236
|
-
name: entity.basename,
|
237
|
-
tagName: entity.tagname,
|
238
|
-
};
|
239
|
-
|
240
|
-
const slots = filterPublicApi(entity.slots);
|
241
|
-
const events = filterPublicApi(entity.events);
|
242
|
-
const classFields = filterPublicApi(entity.properties);
|
243
|
-
const classMethods = filterPublicApi(entity.methods);
|
244
|
-
const attributes = classFields.filter(property => {
|
245
|
-
return property.noattribute !== "true" && property.readonly !== "true" && !forbiddenAttributeTypes.includes(property.type.toLowerCase());
|
246
|
-
});
|
247
|
-
|
248
|
-
if (slots.length) {
|
249
|
-
generatedCustomElementDeclaration.slots = generateSlots(slots);
|
250
|
-
}
|
251
|
-
|
252
|
-
if (events.length) {
|
253
|
-
generatedCustomElementDeclaration.events = generateEvents(events);
|
254
|
-
}
|
255
|
-
|
256
|
-
if (attributes.length) {
|
257
|
-
generatedCustomElementDeclaration.attributes = generateAttributes(attributes);
|
258
|
-
}
|
259
|
-
|
260
|
-
if (entity.description) {
|
261
|
-
generatedCustomElementDeclaration.description = entity.description;
|
262
|
-
}
|
263
|
-
|
264
|
-
if (classFields.length || classMethods.length) {
|
265
|
-
generatedCustomElementDeclaration.members = generateMembers(classFields, classMethods);
|
266
|
-
}
|
267
|
-
|
268
|
-
if (entity.extends && entity.extends !== "HTMLElement") {
|
269
|
-
generatedCustomElementDeclaration.superclass = generateRefenrece(entity.extends);
|
270
|
-
}
|
271
|
-
|
272
|
-
return generatedCustomElementDeclaration;
|
273
|
-
};
|
274
|
-
|
275
|
-
const generateRefenrece = (entityName) => {
|
276
|
-
let packageName;
|
277
|
-
let basename;
|
278
|
-
|
279
|
-
if (!entityName) {
|
280
|
-
throw new Error("JSDoc error: entity not found in api.json.");
|
281
|
-
}
|
282
|
-
|
283
|
-
if (entityName.includes(".")) {
|
284
|
-
basename = entityName.split(".").pop();
|
285
|
-
} else {
|
286
|
-
basename = entityName
|
287
|
-
}
|
288
|
-
|
289
|
-
if (entityName.includes("sap.ui.webc.main")) {
|
290
|
-
packageName = "@ui5/webcomponents";
|
291
|
-
} else if (entityName.includes("sap.ui.webc.fiori")) {
|
292
|
-
packageName = "@ui5/webcomponents-fiori";
|
293
|
-
} else if (entityName.includes("sap.ui.webc.base")) {
|
294
|
-
packageName = "@ui5/webcomponents-base";
|
295
|
-
}
|
296
|
-
|
297
|
-
return {
|
298
|
-
module: `${basename}.js`,
|
299
|
-
name: `${basename}`,
|
300
|
-
package: packageName,
|
301
|
-
};
|
302
|
-
};
|
303
|
-
|
304
|
-
const filterPublicApi = array => {
|
305
|
-
return (array || []).filter(el => el.visibility === "public");
|
306
|
-
};
|
307
|
-
|
308
|
-
const generate = async () => {
|
309
|
-
const file = JSON.parse(await fs.readFile(path.join(inputDir, "api.json")));
|
310
|
-
let customElementsManifest = {
|
311
|
-
schemaVersion: "1.0.0",
|
312
|
-
readme: "",
|
313
|
-
modules: [],
|
314
|
-
};
|
315
|
-
|
316
|
-
file.symbols.forEach(entity => {
|
317
|
-
if (entity.tagname || entity.kind === "class") {
|
318
|
-
customElementsManifest.modules.push(generateJavaScriptModule(entity));
|
319
|
-
}
|
320
|
-
});
|
321
|
-
|
322
|
-
await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
|
323
|
-
};
|
324
|
-
|
325
|
-
generate().then(() => {
|
326
|
-
console.log("Custom elements manifest generated.");
|
327
|
-
});
|
package/lib/jsdoc/config.json
DELETED
@@ -1,29 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"source": {
|
3
|
-
"include": "src",
|
4
|
-
"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
|
5
|
-
},
|
6
|
-
"opts" : {
|
7
|
-
"recurse": true,
|
8
|
-
"template" : "template",
|
9
|
-
"destination": ""
|
10
|
-
},
|
11
|
-
"plugins": [
|
12
|
-
"./plugin.js"
|
13
|
-
],
|
14
|
-
"templates" : {
|
15
|
-
"ui5" : {
|
16
|
-
"variants": [
|
17
|
-
"apijson"
|
18
|
-
],
|
19
|
-
"version": "1.62",
|
20
|
-
"apiJsonFolder": "",
|
21
|
-
"apiJsonFile": "dist/api.json",
|
22
|
-
"includeSettingsInConstructor": false
|
23
|
-
}
|
24
|
-
},
|
25
|
-
"tags": {
|
26
|
-
"allowUnknownTags": true,
|
27
|
-
"dictionaries": ["jsdoc"]
|
28
|
-
}
|
29
|
-
}
|
@@ -1,29 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"source": {
|
3
|
-
"include": "jsdoc-dist",
|
4
|
-
"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
|
5
|
-
},
|
6
|
-
"opts" : {
|
7
|
-
"recurse": true,
|
8
|
-
"template" : "template",
|
9
|
-
"destination": ""
|
10
|
-
},
|
11
|
-
"plugins": [
|
12
|
-
"./plugin.js"
|
13
|
-
],
|
14
|
-
"templates" : {
|
15
|
-
"ui5" : {
|
16
|
-
"variants": [
|
17
|
-
"apijson"
|
18
|
-
],
|
19
|
-
"version": "1.62",
|
20
|
-
"apiJsonFolder": "",
|
21
|
-
"apiJsonFile": "dist/api.json",
|
22
|
-
"includeSettingsInConstructor": false
|
23
|
-
}
|
24
|
-
},
|
25
|
-
"tags": {
|
26
|
-
"allowUnknownTags": true,
|
27
|
-
"dictionaries": ["jsdoc"]
|
28
|
-
}
|
29
|
-
}
|