[FEATURE] manifest.json: Auto-fill supportedLocales

JIRA: CPOUI5FOUNDATION-296
SAP · Jul 12, 2024 · b085634 · b085634
1 parent 7691b08
commit b085634
Show file tree

Hide file tree

Showing 84 changed files with 4,270 additions and 0 deletions.
diff --git a/lib/processors/manifestEnhancer.js b/lib/processors/manifestEnhancer.js
diff --git a/lib/tasks/enhanceManifest.js b/lib/tasks/enhanceManifest.js
@@ -0,0 +1,32 @@
+import manifestEnhancer from "../processors/manifestEnhancer.js";
+import fsInterface from "@ui5/fs/fsInterface";
+
+/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
+/**
+ * Task for transforming the manifest.json file.
+ * Adds missing information based on the available project resources,
+ * for example the locales supported by the present i18n resources.
+ *
+ * @public
+ * @function default
+ * @static
+ *
+ * @param {object} parameters Parameters
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {object} parameters.options Options
+ * @param {string} parameters.options.projectNamespace Namespace of the application
+ * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
+ */
+export default async function({workspace, options}) {
+ const {projectNamespace} = options;
+
+ // Note: all "manifest.json" files in the given namespace
+ const resources = await workspace.byGlob(`/resources/${projectNamespace}/**/manifest.json`);
+
+ const processedResources = await manifestEnhancer({
+ resources,
+ fs: fsInterface(workspace),
+ });
+
+ await Promise.all(processedResources.map((resource) => workspace.write(resource)));
+}
diff --git a/lib/tasks/taskRepository.js b/lib/tasks/taskRepository.js
@@ -17,6 +17,7 @@ const taskInfos = {
  replaceCopyright: {path: "./replaceCopyright.js"},
  replaceVersion: {path: "./replaceVersion.js"},
  replaceBuildtime: {path: "./replaceBuildtime.js"},
+ enhanceManifest: {path: "./enhanceManifest.js"},
  escapeNonAsciiCharacters: {path: "./escapeNonAsciiCharacters.js"},
  executeJsdocSdkTransformation: {path: "./jsdoc/executeJsdocSdkTransformation.js"},
  generateApiIndex: {path: "./jsdoc/generateApiIndex.js"},

diff --git a/test/expected/build/application.o/dest/Component-preload.js b/test/expected/build/application.o/dest/Component-preload.js
diff --git a/test/expected/build/application.o/dest/Component-preload.js.map b/test/expected/build/application.o/dest/Component-preload.js.map
diff --git a/test/expected/build/application.o/dest/i18n/i18n.properties b/test/expected/build/application.o/dest/i18n/i18n.properties
@@ -0,0 +1 @@
+welcome=Hello world
diff --git a/test/expected/build/application.o/dest/i18n/i18n_en.properties b/test/expected/build/application.o/dest/i18n/i18n_en.properties
@@ -0,0 +1 @@
+welcome=Hello EN world
diff --git a/test/expected/build/application.o/dest/i18n/i18n_en_US.properties b/test/expected/build/application.o/dest/i18n/i18n_en_US.properties
@@ -0,0 +1 @@
+welcome=Hello EN US world
diff --git a/test/expected/build/application.o/dest/i18n/i18n_en_US_sapprc.properties b/test/expected/build/application.o/dest/i18n/i18n_en_US_sapprc.properties
@@ -0,0 +1 @@
+welcome=Hello EN US sapprc world
diff --git a/test/expected/build/application.o/dest/index.html b/test/expected/build/application.o/dest/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+ <title>Application O</title>
+ <script id="sap-ui-bootstrap" src="test.js">
+ </script>
+</head>
+<body>
+
+</body>
+</html>
diff --git a/test/expected/build/application.o/dest/manifest.json b/test/expected/build/application.o/dest/manifest.json
@@ -0,0 +1,48 @@
+{
+ "_version": "1.22.0",
+ "sap.app": {
+ "id": "application.o",
+ "type": "application",
+ "applicationVersion": {
+ "version": "1.0.0"
+ },
+ "title": "{{title}}",
+ "i18n": {
+ "bundleUrl": "i18n/i18n.properties",
+ "supportedLocales": [
+ "",
+ "en",
+ "en_US",
+ "en_US_sapprc"
+ ]
+ }
+ },
+ "sap.ui5": {
+ "models": {
+ "i18n": {
+ "type": "sap.ui.model.resource.ResourceModel",
+ "settings": {
+ "bundleName": "application.o.i18n.i18n",
+ "supportedLocales": [
+ "",
+ "en",
+ "en_US",
+ "en_US_sapprc"
+ ]
+ }
+ },
+ "i18n-ui5": {
+ "type": "sap.ui.model.resource.ResourceModel",
+ "settings": {
+ "bundleUrl": "ui5://application/o/i18n/i18n.properties",
+ "supportedLocales": [
+ "",
+ "en",
+ "en_US",
+ "en_US_sapprc"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/test/expected/build/application.o/dest/test-dbg.js b/test/expected/build/application.o/dest/test-dbg.js
@@ -0,0 +1,8 @@
+sap.ui.define([
+], () => {
+ test((paramA) => {
+ const variableA = paramA;
+ console.log(variableA);
+ })
+ test();
+});
diff --git a/test/expected/build/application.o/dest/test.js b/test/expected/build/application.o/dest/test.js
diff --git a/test/expected/build/application.o/dest/test.js.map b/test/expected/build/application.o/dest/test.js.map
diff --git a/test/expected/build/library.o/dest/resources/library/o/.library b/test/expected/build/library.o/dest/resources/library/o/.library
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd" >
+
+ <name>library.o</name>
+ <vendor>SAP SE</vendor>
+ <copyright>${copyright}</copyright>
+ <version>1.0.0</version>
+
+ <title>{{title}}</title>
+ <documentation>{{description}}</documentation>
+
+</library>
diff --git a/test/expected/build/library.o/dest/resources/library/o/library-dbg.js b/test/expected/build/library.o/dest/resources/library/o/library-dbg.js
@@ -0,0 +1,17 @@
+/*!
+ * Some fancy copyright
+ */
+sap.ui.define([
+ 'sap/ui/core/Core',
+], (Core) => {
+ "use strict";
+
+ sap.ui.getCore().initLibrary({
+ name : "library.o",
+ version: "1.0.0",
+ dependencies : []
+ });
+
+ return thisLib;
+
+});
diff --git a/test/expected/build/library.o/dest/resources/library/o/library-preload.js b/test/expected/build/library.o/dest/resources/library/o/library-preload.js
diff --git a/test/expected/build/library.o/dest/resources/library/o/library-preload.js.map b/test/expected/build/library.o/dest/resources/library/o/library-preload.js.map
diff --git a/test/expected/build/library.o/dest/resources/library/o/library.js b/test/expected/build/library.o/dest/resources/library/o/library.js
diff --git a/test/expected/build/library.o/dest/resources/library/o/library.js.map b/test/expected/build/library.o/dest/resources/library/o/library.js.map
diff --git a/test/expected/build/library.o/dest/resources/library/o/manifest.json b/test/expected/build/library.o/dest/resources/library/o/manifest.json
@@ -0,0 +1,103 @@
+{
+ "_version": "1.58.0",
+ "sap.app": {
+ "id": "library.o",
+ "type": "library",
+ "embeds": [],
+ "applicationVersion": {
+ "version": "1.0.0"
+ },
+ "title": "{{title}}",
+ "description": "{{description}}",
+ "resources": "resources.json",
+ "offline": true
+ },
+ "sap.ui": {
+ "technology": "UI5",
+ "supportedThemes": []
+ },
+ "sap.ui5": {
+ "dependencies": {
+ "libs": {}
+ },
+ "library": {
+ "i18n": {
+ "bundleUrl": "messagebundle.properties",
+ "terminologies": {
+ "sports": {
+ "bundleUrl": "sports.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ },
+ "travel": {
+ "bundleUrl": "travel.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ }
+ },
+ "enhanceWith": [
+ {
+ "bundleUrl": "myfolder1/i18n.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "terminologies": {
+ "sports": {
+ "bundleUrl": "myfolder1/soccer.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ },
+ "travel": {
+ "bundleUrl": "myfolder1/vehicles.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ }
+ },
+ "supportedLocales": [
+ "",
+ "en"
+ ]
+ },
+ {
+ "bundleUrl": "myfolder2/i18n.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "terminologies": {
+ "travel": {
+ "bundleUrl": "myfolder2/bicycles.properties",
+ "bundleUrlRelativeTo": "manifest",
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ }
+ },
+ "supportedLocales": [
+ "",
+ "en"
+ ]
+ }
+ ],
+ "supportedLocales": [
+ "",
+ "de",
+ "en"
+ ]
+ }
+ }
+ }
+}
diff --git a/test/expected/build/library.o/dest/resources/library/o/messagebundle.properties b/test/expected/build/library.o/dest/resources/library/o/messagebundle.properties
@@ -0,0 +1,2 @@
+title=a title
+description=a description
diff --git a/test/expected/build/library.o/dest/resources/library/o/messagebundle_de.properties b/test/expected/build/library.o/dest/resources/library/o/messagebundle_de.properties
@@ -0,0 +1,2 @@
+title=a title
+description=a description
diff --git a/test/expected/build/library.o/dest/resources/library/o/messagebundle_en.properties b/test/expected/build/library.o/dest/resources/library/o/messagebundle_en.properties
@@ -0,0 +1,2 @@
+title=a title
+description=a description
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/i18n.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/i18n.properties
@@ -0,0 +1 @@
+title=my company 1 title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/i18n_en.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/i18n_en.properties
@@ -0,0 +1 @@
+title=my company 1 title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer.properties
@@ -0,0 +1 @@
+title=my soccer title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer_de.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer_de.properties
@@ -0,0 +1 @@
+title=Mein Fussball Titel
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer_en.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/soccer_en.properties
@@ -0,0 +1 @@
+title=my soccer title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles.properties
@@ -0,0 +1 @@
+title=my vehicle title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles_de.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles_de.properties
@@ -0,0 +1 @@
+title=Mein Fahrzeugstitel
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles_en.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder1/vehicles_en.properties
@@ -0,0 +1 @@
+title=my vehicle title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles.properties
@@ -0,0 +1 @@
+title=my bicycle title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles_de.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles_de.properties
@@ -0,0 +1 @@
+title=Mein Fahrradtitel
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles_en.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder2/bicycles_en.properties
@@ -0,0 +1 @@
+title=my bicycle title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder2/i18n.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder2/i18n.properties
@@ -0,0 +1 @@
+title=my company 2 title
diff --git a/test/expected/build/library.o/dest/resources/library/o/myfolder2/i18n_en.properties b/test/expected/build/library.o/dest/resources/library/o/myfolder2/i18n_en.properties
@@ -0,0 +1 @@
+title=my company 2 title
diff --git a/test/expected/build/library.o/dest/resources/library/o/sports.properties b/test/expected/build/library.o/dest/resources/library/o/sports.properties
@@ -0,0 +1,2 @@
+title=a sports title
+description=a sports description
diff --git a/test/expected/build/library.o/dest/resources/library/o/sports_de.properties b/test/expected/build/library.o/dest/resources/library/o/sports_de.properties
@@ -0,0 +1,2 @@
+title=ein Sporttitel
+description=eine Sportbeschreibung
diff --git a/test/expected/build/library.o/dest/resources/library/o/sports_en.properties b/test/expected/build/library.o/dest/resources/library/o/sports_en.properties
@@ -0,0 +1,2 @@
+title=a sports title
+description=a sports description
diff --git a/test/expected/build/library.o/dest/resources/library/o/travel.properties b/test/expected/build/library.o/dest/resources/library/o/travel.properties
@@ -0,0 +1,2 @@
+title=a travel title
+description=a travel description
diff --git a/test/expected/build/library.o/dest/resources/library/o/travel_de.properties b/test/expected/build/library.o/dest/resources/library/o/travel_de.properties
@@ -0,0 +1,2 @@
+title=ein Reisetitel
+description=eine Reisebeschreibung
diff --git a/test/expected/build/library.o/dest/resources/library/o/travel_en.properties b/test/expected/build/library.o/dest/resources/library/o/travel_en.properties
@@ -0,0 +1,2 @@
+title=a travel title
+description=a travel description
diff --git a/test/fixtures/application.o/package.json b/test/fixtures/application.o/package.json
@@ -0,0 +1,8 @@
+{
+ "name": "application.o",
+ "version": "1.0.0",
+ "description": "Simple SAPUI5 based application",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ }
+}
diff --git a/test/fixtures/application.o/ui5.yaml b/test/fixtures/application.o/ui5.yaml
@@ -0,0 +1,5 @@
+---
+specVersion: "3.2"
+type: application
+metadata:
+ name: application.o
diff --git a/test/fixtures/application.o/webapp/i18n/i18n.properties b/test/fixtures/application.o/webapp/i18n/i18n.properties
@@ -0,0 +1 @@
+welcome=Hello world
diff --git a/test/fixtures/application.o/webapp/i18n/i18n_en.properties b/test/fixtures/application.o/webapp/i18n/i18n_en.properties
@@ -0,0 +1 @@
+welcome=Hello EN world