babel-plugin-transform-modules-ui5 7.5.0 → 7.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.6.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.5.0...v7.6.0) (2024-07-22)
+
+
+### Features
+
+* support sap.ui.require for [@sap](https://github.com/sap)UiRequire annotated modules ([#131](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/issues/131)) ([23c4ac6](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/23c4ac67eef5a825692c528852ef62bbd621d13e))
+
+
+
+
+
 # [7.5.0](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/compare/v7.4.2...v7.5.0) (2024-07-12)
 
 

package/dist/modules/helpers/wrapper.js

@@ -139,14 +139,19 @@ function wrap(visitor, programNode, opts) {
   if (imports.some(imp => imp.interop)) {
     body.unshift(th.buildDefaultImportInterop());
   }
-  const define = generateDefine(body, imports, exportGlobal || opts.exportAllGlobal, hasUseStrict(programNode));
+
+  // should we use sap.ui.require instead of sap.ui.define?
+  let useSapUiRequire = hasUseSapUiRequire(visitor.parent.comments, body, true);
+
+  // generate the sap.ui.define or sap.ui.require
+  const defineOrRequire = generateDefineOrRequire(body, imports, exportGlobal || opts.exportAllGlobal, useSapUiRequire);
 
   // add the "use strict" directive if not on program node
   if (!opts.neverUseStrict && !hasUseStrict(programNode)) {
-    const defineFnBody = define.expression.arguments[1].body;
-    defineFnBody.directives = [_core.types.directive(_core.types.directiveLiteral("use strict")), ...(defineFnBody.directives || [])];
+    const defineOrRequireFnBody = defineOrRequire.expression.arguments[1].body;
+    defineOrRequireFnBody.directives = [_core.types.directive(_core.types.directiveLiteral("use strict")), ...(defineOrRequireFnBody.directives || [])];
   }
-  programNode.body = [...preDefine, define];
+  programNode.body = [...preDefine, defineOrRequire];
 
   // if a copyright comment is present we append it to the new program node
   if (copyright && visitor.parent) {
@@ -157,11 +162,36 @@ function wrap(visitor, programNode, opts) {
 function hasUseStrict(node) {
   return (node.directives || []).some(directive => directive.value.value === "use strict");
 }
-function generateDefine(body, imports, exportGlobal) {
+function hasUseSapUiRequire(comments, body, remove) {
+  // detect the @sapUiRequire comment
+  return comments.some(comment => {
+    let found = false;
+    // check for existing comment block
+    if (comment.type === "CommentBlock") {
+      found = comment.value.trim() === "@sapUiRequire";
+    }
+    // remove the comment (if it is somewhere in the body)
+    if (found && remove) {
+      body === null || body === void 0 || body.forEach(node => {
+        (0, _core.traverse)(node, {
+          enter(path) {
+            ["leadingComments", "trailingComments", "innerComments"].forEach(key => {
+              var _path$node$key;
+              path.node[key] = (_path$node$key = path.node[key]) === null || _path$node$key === void 0 ? void 0 : _path$node$key.filter(c => c !== comment);
+            });
+          },
+          noScope: true
+        });
+      });
+    }
+    return found;
+  });
+}
+function generateDefineOrRequire(body, imports, exportGlobal, useRequire) {
   const defineOpts = {
     SOURCES: _core.types.arrayExpression(imports.map(i => _core.types.stringLiteral(i.src))),
     PARAMS: imports.map(i => _core.types.identifier(i.tmpName)),
     BODY: body
   };
-  return exportGlobal ? th.buildDefineGlobal(defineOpts) : th.buildDefine(defineOpts);
+  return useRequire ? th.buildRequire(defineOpts) : exportGlobal ? th.buildDefineGlobal(defineOpts) : th.buildDefine(defineOpts);
 }

package/dist/utils/templates.js

@@ -5,13 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.buildInheritingFunction = exports.buildInheritingConstructor = exports.buildExtendAssign = exports.buildExportDefault = exports.buildDynamicImportHelper = exports.buildDefineGlobal = exports.buildDefine = exports.buildDefaultImportInterop = exports.buildDefaultImportDeconstructor = exports.buildDeclareExports = exports.buildConstDeclaration = exports.buildAssign = exports.buildAllExportHelper = exports.buildAllExport = void 0;
 exports.buildNamedExport = buildNamedExport;
-exports.exportsIdentifier = exports.buildTempExport = exports.buildReturnExports = exports.buildReturn = exports.buildNamedImportDestructor = void 0;
+exports.exportsIdentifier = exports.buildTempExport = exports.buildReturnExports = exports.buildReturn = exports.buildRequire = exports.buildNamedImportDestructor = void 0;
 var _core = require("@babel/core");
 const exportName = "__exports";
 const exportsIdentifier = exports.exportsIdentifier = _core.types.identifier(exportName);
 const buildAssign = exports.buildAssign = (0, _core.template)(`
   OBJECT.NAME = VALUE;
 `);
+const buildRequire = exports.buildRequire = (0, _core.template)(`
+  sap.ui.require(SOURCES, function (PARAMS) {
+    BODY;
+  });
+`);
 const buildDefine = exports.buildDefine = (0, _core.template)(`
   sap.ui.define(SOURCES, function (PARAMS) {
     BODY;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-modules-ui5",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "description": "An unofficial babel plugin for SAP UI5.",
   "main": "dist/index.js",
   "repository": {
@@ -94,5 +94,5 @@
     "prettier": "^3.1.0",
     "rimraf": "^5.0.5"
   },
-  "gitHead": "afd2f7c5644541c95ea3218a306fce1c71391050"
+  "gitHead": "8db5f32610df08996a49b97529c8a8f3fabcc59c"
 }