babel-plugin-transform-modules-ui5 7.9.0 → 7.10.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## 7.10.0
+
+### Minor Changes
+
+- [#154](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/pull/154) [`f62f9fb`](https://github.com/ui5-community/babel-plugin-transform-modules-ui5/commit/f62f9fba1a64dea2673662dd163fcc1eb5cff540) Thanks [@bbogovich-sap](https://github.com/bbogovich-sap)! - Add two comment pragmas to opt out of module transformation:
+
+  - `/* @ui5-no-wrap */` (file level) leaves a module completely unwrapped —
+    no `sap.ui.define`/`sap.ui.require` and no import/export rewriting — while
+    still stripping TypeScript types. Intended for modules consumed as native
+    ES modules, e.g. web workers.
+  - `/* @ui5-ignore-import */` (statement level) excludes a single static
+    `import` or dynamic `import()` from being converted into a UI5 dependency.
+
+  Note: `@ui5-ignore-import` on a static import only yields valid output in an
+  unwrapped module (no exports, or together with `@ui5-no-wrap`); a leftover
+  ES `import` inside a `sap.ui.define` factory is not valid at runtime.
+
 ## 7.9.0
 
 ### Minor Changes

package/dist/index.js

@@ -23,6 +23,7 @@ module.exports = () => {
       enter(path, {
         opts
       }) {
+        var _path$parent$comments, _path$parent;
         if (this.ran) return;
         this.ran = true;
         if (opts.onlyConvertNamedClass == false) {
@@ -48,6 +49,7 @@ module.exports = () => {
         this.imports = [];
         this.namedExports = [];
         this.injectDynamicImportHelper = false;
+        this.noWrap = ((_path$parent$comments = (_path$parent = path.parent) === null || _path$parent === void 0 ? void 0 : _path$parent.comments) !== null && _path$parent$comments !== void 0 ? _path$parent$comments : []).some(c => c.type === "CommentBlock" && c.value.trim() === "@ui5-no-wrap");
 
         // Properties for Class Transform
         this.importNames = [];

package/dist/modules/helpers/wrapper.js

@@ -10,7 +10,10 @@ var th = _interopRequireWildcard(require("../../utils/templates"));
 var ast = _interopRequireWildcard(require("../../utils/ast"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function wrap(visitor, programNode, opts) {
-  var _body;
+  var _visitor$parent$comme, _visitor$parent, _body;
+  if (hasNoWrapPragma((_visitor$parent$comme = (_visitor$parent = visitor.parent) === null || _visitor$parent === void 0 ? void 0 : _visitor$parent.comments) !== null && _visitor$parent$comme !== void 0 ? _visitor$parent$comme : [])) {
+    return;
+  }
   let {
     defaultExport,
     exportGlobal,
@@ -48,8 +51,8 @@ function wrap(visitor, programNode, opts) {
   // is associcated with the program and not the program body, so we need to find it
   // and move it to the new program body (which is sap.ui.define)
   if (!copyright) {
-    var _visitor$parent;
-    copyright = (_visitor$parent = visitor.parent) === null || _visitor$parent === void 0 || (_visitor$parent = _visitor$parent.comments) === null || _visitor$parent === void 0 ? void 0 : _visitor$parent.find((comment, idx, arr) => {
+    var _visitor$parent2;
+    copyright = (_visitor$parent2 = visitor.parent) === null || _visitor$parent2 === void 0 || (_visitor$parent2 = _visitor$parent2.comments) === null || _visitor$parent2 === void 0 ? void 0 : _visitor$parent2.find((comment, idx, arr) => {
       if (comment.value.startsWith("!")) {
         arr.splice(idx, 1);
         return true;
@@ -181,6 +184,9 @@ function wrap(visitor, programNode, opts) {
 function hasUseStrict(node) {
   return (node.directives || []).some(directive => directive.value.value === "use strict");
 }
+function hasNoWrapPragma(comments) {
+  return comments.some(comment => comment.type === "CommentBlock" && comment.value.trim() === "@ui5-no-wrap");
+}
 function hasUseSapUiRequire(comments, body, remove) {
   // detect the @sapUiRequire comment
   return comments.some(comment => {

package/dist/modules/visitor.js

@@ -94,7 +94,8 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
       node
     } = path;
     if (node.importKind === "type") return; // flow-type
-
+    if (this.noWrap) return;
+    if (hasIgnoreImportPragma(node)) return;
     const {
       specifiers,
       source
@@ -232,6 +233,7 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
       declaration,
       source
     } = node;
+    if (this.noWrap) return;
     let fromSource = "";
     if (source) {
       // e.g. export { one, two } from 'x'
@@ -289,6 +291,7 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
     const {
       node
     } = path;
+    if (this.noWrap) return;
     let {
       declaration
     } = node;
@@ -326,6 +329,7 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
   ExportAllDeclaration(path, {
     filename
   }) {
+    if (this.noWrap) return;
     const src = resolveSource(path.node.source.value, filename);
     const name = cleanImportSource(src);
     const tmpName = tempModuleName(name);
@@ -351,7 +355,9 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
     const {
       callee
     } = node;
+    if (this.noWrap) return;
     if (ast.isImport(callee)) {
+      if (hasIgnoreImportPragma(path.getStatementParent().node)) return;
       this.injectDynamicImportHelper = true;
       path.replaceWith(_objectSpread(_objectSpread({}, node), {}, {
         callee: _core.types.identifier("__ui5_require_async")
@@ -365,6 +371,7 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
     const {
       node
     } = path;
+    if (this.noWrap) return;
     if ((node === null || node === void 0 || (_node$object = node.object) === null || _node$object === void 0 ? void 0 : _node$object.type) === "MetaProperty") {
       var _node$property, _node$property2;
       // replace all "import.meta.url" with "module.url"
@@ -379,4 +386,8 @@ const ModuleTransformVisitor = exports.ModuleTransformVisitor = {
       }
     }
   }
-};
+};
+function hasIgnoreImportPragma(node) {
+  var _node$leadingComments;
+  return ((_node$leadingComments = node.leadingComments) !== null && _node$leadingComments !== void 0 ? _node$leadingComments : []).some(comment => comment.type === "CommentBlock" && comment.value.trim() === "@ui5-ignore-import");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-modules-ui5",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "description": "An unofficial babel plugin for SAP UI5.",
   "main": "dist/index.js",
   "repository": {