@ui5/webcomponents-tools 0.0.0-f24ff9019 → 0.0.0-f42e7c18c

package/lib/generate-custom-elements-manifest/index.js

@@ -1,327 +0,0 @@
-const fs = require("fs").promises;
-const path = require("path");
-// https://github.com/webcomponents/custom-elements-manifest/blob/main/schema.json
-
-const inputDir = process.argv[2];
-const outputDir = process.argv[3];
-
-const camelToKebabMap = new Map();
-const apiIndex = new Map();
-const forbiddenAttributeTypes = ["object", "array"];
-
-const camelToKebabCase = string => {
-	if (!camelToKebabMap.has(string)) {
-		const result = string.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
-		camelToKebabMap.set(string, result);
-	}
-	return camelToKebabMap.get(string);
-};
-
-const generateJavaScriptExport = entity => {
-	return {
-		declaration: generateRefenrece(entity.name),
-		deprecated: !!entity.deprecated,
-		kind: "js",
-		name: "default",
-	};
-};
-
-const generateCustomElementExport = entity => {
-	return {
-		declaration: {
-			name: entity.basename,
-			module: `${entity.module}.js`,
-		},
-		deprecated: !!entity.deprecated,
-		kind: "custom-element-definition",
-		name: entity.tagname,
-	};
-};
-
-const generateJavaScriptModule = entity => {
-	return {
-		kind: "javascript-module",
-		path: `${entity.basename}.js`,
-		declarations: [
-			generateCustomElementDeclaration(entity),
-		],
-		exports: [
-			generateJavaScriptExport(entity),
-			generateCustomElementExport(entity),
-		],
-	};
-};
-
-const generateSingleClassField = classField => {
-	let generatedClassField = {
-		deprecated: !!classField.deprecated,
-		kind: "field",
-		name: classField.name,
-		privacy: classField.visibility,
-		static: !!classField.static,
-		type: generateType(classField.type),
-	};
-
-	if (classField.defaultValue) {
-		generatedClassField.default = classField.defaultValue;
-	}
-
-	if (classField.description) {
-		generatedClassField.description = classField.description;
-	}
-
-	return generatedClassField;
-};
-
-const generateSingleParameter = parameter => {
-	let generatedParameter = {
-		deprecated: !!parameter.deprecated,
-		name: parameter.name,
-		type: generateType(parameter.type),
-	};
-
-	if (parameter.description) {
-		generatedParameter.description = parameter.description;
-	}
-
-	if (parameter.optional) {
-		generatedParameter.optional = parameter.optional;
-	}
-
-	return generatedParameter;
-};
-
-const generateParameters = (parameters) => {
-	return parameters.reduce((newParametersArray, parameter) => {
-		newParametersArray.push(generateSingleParameter(parameter));
-
-		return newParametersArray;
-	}, []);
-};
-
-const generateSingleClassMethod = classMethod => {
-	let generatedClassMethod = {
-		deprecated: !!classMethod.deprecated,
-		kind: "method",
-		name: classMethod.name,
-		privacy: classMethod.visibility,
-		static: classMethod.static,
-	};
-
-	if (classMethod.description) {
-		generatedClassMethod.description = classMethod.description;
-	}
-
-	if (classMethod.parameters && classMethod.parameters.length) {
-		generatedClassMethod.parameters = generateParameters(classMethod.parameters);
-	}
-
-	if (classMethod.returnValue) {
-		generatedClassMethod.return = {
-			type: generateType(classMethod.returnValue.type),
-		};
-
-		if (classMethod.returnValue.description) {
-			generatedClassMethod.return.description = classMethod.returnValue.type;
-		}
-	}
-
-	return generatedClassMethod;
-};
-
-const generateClassFields = classFields => {
-	return classFields.reduce((newClassFieldsArray, classField) => {
-		newClassFieldsArray.push(generateSingleClassField(classField));
-
-		return newClassFieldsArray;
-	}, []);
-};
-
-const generateClassMethods = classMethods => {
-	return classMethods.reduce((newClassMethodsArray, classMethod) => {
-		newClassMethodsArray.push(generateSingleClassMethod(classMethod));
-
-		return newClassMethodsArray;
-	}, []);
-};
-
-const generateMembers = (classFields, classMethods) => {
-	return [...generateClassFields(classFields), ...generateClassMethods(classMethods)];
-};
-
-const generateType = type => {
-	const dataType = apiIndex.get(type);
-
-	return {
-		text: dataType && dataType.name.includes(".types.") ?
-			filterPublicApi(dataType.properties)
-				.map(prop => `"${prop.name}"`)
-				.join(" | ") : type,
-	};
-};
-
-const generateSingleAttribute = attribute => {
-	let generatedAttribute = {
-		default: attribute.defaultValue,
-		deprecated: !!attribute.deprecated,
-		fieldName: attribute.name,
-		name: camelToKebabCase(attribute.name),
-		type: generateType(attribute.type),
-	};
-
-	if (attribute.description) {
-		generatedAttribute.description = attribute.description;
-	}
-
-	return generatedAttribute;
-};
-
-const generateAttributes = attributes => {
-	attributes = attributes.reduce((newAttributesArray, attribute) => {
-		newAttributesArray.push(generateSingleAttribute(attribute));
-
-		return newAttributesArray;
-	}, []);
-
-	return attributes;
-};
-
-const generateSingleEvent = event => {
-	let generatedEvent = {
-		deprecated: !!event.deprecated,
-		name: event.name,
-		type: event.native === "true" ? "NativeEvent" : "CustomEvent",
-	};
-
-	if (event.description) {
-		generatedEvent.description = event.description;
-	}
-
-	return generatedEvent;
-};
-
-const generateEvents = events => {
-	events = events.reduce((newEventsArray, event) => {
-		newEventsArray.push(generateSingleEvent(event));
-
-		return newEventsArray;
-	}, []);
-
-	return events;
-};
-
-const generateSingleSlot = slot => {
-	return {
-		deprecated: !!slot.deprecated,
-		description: slot.description,
-		name: slot.name,
-	};
-};
-
-const generateSlots = slots => {
-	slots = slots.reduce((newSlotsArray, event) => {
-		newSlotsArray.push(generateSingleSlot(event));
-
-		return newSlotsArray;
-	}, []);
-
-	return slots;
-};
-
-const generateCustomElementDeclaration = entity => {
-	let generatedCustomElementDeclaration = {
-		deprecated: !!entity.deprecated,
-		customElement: true,
-		kind: entity.basename,
-		name: entity.basename,
-		tagName: entity.tagname,
-	};
-
-	const slots = filterPublicApi(entity.slots);
-	const events = filterPublicApi(entity.events);
-	const classFields = filterPublicApi(entity.properties);
-	const classMethods = filterPublicApi(entity.methods);
-	const attributes = classFields.filter(property => {
-		return property.noattribute !== "true" && property.readonly !== "true" && !forbiddenAttributeTypes.includes(property.type.toLowerCase());
-	});
-
-	if (slots.length) {
-		generatedCustomElementDeclaration.slots = generateSlots(slots);
-	}
-
-	if (events.length) {
-		generatedCustomElementDeclaration.events = generateEvents(events);
-	}
-
-	if (attributes.length) {
-		generatedCustomElementDeclaration.attributes = generateAttributes(attributes);
-	}
-
-	if (entity.description) {
-		generatedCustomElementDeclaration.description = entity.description;
-	}
-
-	if (classFields.length || classMethods.length) {
-		generatedCustomElementDeclaration.members = generateMembers(classFields, classMethods);
-	}
-
-	if (entity.extends && entity.extends !== "HTMLElement") {
-		generatedCustomElementDeclaration.superclass = generateRefenrece(entity.extends);
-	}
-
-	return generatedCustomElementDeclaration;
-};
-
-const generateRefenrece = (entityName) => {
-	let packageName;
-	let basename;
-
-	if (!entityName) {
-		throw new Error("JSDoc error: entity not found in api.json.");
-	}
-
-	if (entityName.includes(".")) {
-		basename = entityName.split(".").pop();
-	} else {
-		basename = entityName
-	}
-
-	if (entityName.includes("sap.ui.webc.main")) {
-		packageName = "@ui5/webcomponents";
-	} else if (entityName.includes("sap.ui.webc.fiori")) {
-		packageName = "@ui5/webcomponents-fiori";
-	} else if (entityName.includes("sap.ui.webc.base")) {
-		packageName = "@ui5/webcomponents-base";
-	}
-
-	return {
-		module: `${basename}.js`,
-		name: `${basename}`,
-		package: packageName,
-	};
-};
-
-const filterPublicApi = array => {
-	return (array || []).filter(el => el.visibility === "public");
-};
-
-const generate = async () => {
-	const file = JSON.parse(await fs.readFile(path.join(inputDir, "api.json")));
-	let customElementsManifest = {
-		schemaVersion: "1.0.0",
-		readme: "",
-		modules: [],
-	};
-
-	file.symbols.forEach(entity => {
-		if (entity.tagname || entity.kind === "class") {
-			customElementsManifest.modules.push(generateJavaScriptModule(entity));
-		}
-	});
-
-	await fs.writeFile(path.join(outputDir, "custom-elements.json"), JSON.stringify(customElementsManifest));
-};
-
-generate().then(() => {
-	console.log("Custom elements manifest generated.");
-});

package/lib/jsdoc/config.json

@@ -1,29 +0,0 @@
-{
-	"source": {
-		"include": "src",
-		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
-	},
-	"opts" : {
-		"recurse": true,
-		"template" : "template",
-		"destination": ""
-	},
-	"plugins": [
-		"./plugin.js"
-	],
-	"templates" : {
-		"ui5" : {
-			"variants": [
-				"apijson"
-			],
-			"version": "1.62",
-			"apiJsonFolder": "",
-			"apiJsonFile": "dist/api.json",
-			"includeSettingsInConstructor": false
-		}
-	},
-	"tags": {
-		"allowUnknownTags": true,
-		"dictionaries": ["jsdoc"]
-	}
-}

package/lib/jsdoc/configTypescript.json

@@ -1,29 +0,0 @@
-{
-	"source": {
-		"include": "jsdoc-dist",
-		"excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
-	},
-	"opts" : {
-		"recurse": true,
-		"template" : "template",
-		"destination": ""
-	},
-	"plugins": [
-		"./plugin.js"
-	],
-	"templates" : {
-		"ui5" : {
-			"variants": [
-				"apijson"
-			],
-			"version": "1.62",
-			"apiJsonFolder": "",
-			"apiJsonFile": "dist/api.json",
-			"includeSettingsInConstructor": false
-		}
-	},
-	"tags": {
-		"allowUnknownTags": true,
-		"dictionaries": ["jsdoc"]
-	}
-}