babel-plugin-hylid-bridge 2.3.0 → 2.4.0-alpha.2

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.4.0-alpha.2](https://code.alipay.com/ant-ife/hylid-bridge/compare/v2.4.0-alpha.1...v2.4.0-alpha.2) (2022-08-16)
+
+
+### Features
+
+* 避免频繁打印日志* 适配 Remix 中会编译所有 node_modules 下模块的逻辑
+
+
+## [2.4.0-alpha.1](https://code.alipay.com/ant-ife/hylid-bridge/compare/v2.4.0-alpha.0...v2.4.0-alpha.1) (2022-08-15)
+
+
+### Features
+
+* 不修改全局的 my, 新建本地变量
+
+
+## [2.4.0-alpha.0](https://code.alipay.com/ant-ife/hylid-bridge/compare/v2.1.0...v2.4.0-alpha.0) (2022-08-12)
+
+
+### Features
+
+* 调整 eslint 配置* 根据源码注入 hylid-bridge 相应模块* 固定三方依赖版本号
+
+### Bug Fixes
+
+* 依赖* build error* split the target
+
+
 ## [2.3.0](https://code.alipay.com/ant-ife/hylid-bridge/compare/v2.1.0...v2.3.0) (2022-08-05)
 
 

package/lib/getLibraryDir.js

@@ -17,11 +17,11 @@ function getLibraryDir() {
       libraryDir = process.env.HYLID_BRIDGE_PACKAGE_DIR || require.resolve('hylid-bridge/package.json', {
         paths: [cwd]
       }).replace('package.json', '');
+      (0, _utils.log)("Find the hylid-bridge package: ".concat(libraryDir));
     } catch (e) {
       (0, _utils.error)("Can not resolve the hylid-bridge package from the directory: ".concat(cwd, "."), e);
     }
   }
 
-  (0, _utils.log)("Find the hylid-bridge package: ".concat(libraryDir));
   return libraryDir;
 }

package/lib/index.d.ts

@@ -3,5 +3,5 @@ import { PluginPass } from '@babel/core';
 interface IState extends PluginPass {
     usedJSAPIList: 'all' | string[];
 }
-declare const _default: (_: typeof babelCore, opts?: Record<string, any> | undefined) => babelCore.PluginObj<IState>;
+declare const _default: (_: typeof babelCore, opts?: Record<string, any>) => babelCore.PluginObj<IState>;
 export default _default;

package/lib/index.js

@@ -34,13 +34,34 @@ var identifierPrefix = '__hylid_bridge__';
 var libraryName = 'hylid-bridge';
 var libraryDir = (0, _getLibraryDir.default)();
 
+function snakeCaseTarget(value) {
+  if (value === 'H5') {
+    return 'h5';
+  }
+
+  return _lodash.default.snakeCase(value);
+}
+
+function isTargetSupported(target) {
+  var libraryDir = (0, _getLibraryDir.default)();
+  return ['MpWeb', 'Mp', 'Web'].some(function (prefix) {
+    if (target.startsWith(prefix)) {
+      var targetClientDir = _path.default.resolve(libraryDir, 'lib/clients', snakeCaseTarget(prefix), snakeCaseTarget(target.replace(prefix, '')));
+
+      return _fsExtra.default.existsSync(targetClientDir);
+    }
+
+    return false;
+  });
+}
+
 function getTargets(customTargets) {
   var targets = customTargets || (process.env.HYLID_BRIDGE_TARGETS ? process.env.HYLID_BRIDGE_TARGETS.split(',') : []);
-  return targets;
+  return targets.filter(isTargetSupported);
 }
 
 function isApiExists(name, target) {
-  var targetSplit = target.split('|');
+  var targetSplit = splitTarget(target);
 
   if (targetSplit.length !== 2) {
     throw new Error("Wrong target configuration: ".concat(target, "."));
@@ -49,22 +70,56 @@ function isApiExists(name, target) {
   return _fsExtra.default.existsSync(_path.default.resolve(libraryDir, "./lib/clients/".concat(targetSplit[0], "/").concat(targetSplit[1], "/").concat(name, ".js")));
 }
 
+function getUserAppEnvPath(appEnvPath) {
+  var realAppEnvPath = appEnvPath !== null && appEnvPath !== void 0 ? appEnvPath : _path.default.resolve(process.cwd(), './src/appEnv.ts');
+
+  if (!_fsExtra.default.existsSync(realAppEnvPath)) {
+    utils.log("Can not find the appEnv module at the path: ".concat(realAppEnvPath, "."));
+    return;
+  }
+
+  return realAppEnvPath;
+}
+
+function splitTarget(target) {
+  var prefixList = ['MpWeb', 'Mp', 'Web'];
+
+  for (var i = 0, il = prefixList.length; i < il; i++) {
+    var prefix = prefixList[i];
+
+    if (target.startsWith(prefix)) {
+      return [snakeCaseTarget(prefix), snakeCaseTarget(target.replace(prefix, ''))];
+    }
+  }
+
+  throw new Error("Invalid bridge target: ".concat(target, "."));
+}
+
+var myLocalName = "".concat(identifierPrefix, "my__");
+
 var _default = function _default(_, opts) {
   var targets = getTargets(opts === null || opts === void 0 ? void 0 : opts.targets);
+  var userAppEnvPath = getUserAppEnvPath(opts === null || opts === void 0 ? void 0 : opts.appEnvPath);
   return {
     name: 'babel-plugin-hylid-bridge',
     visitor: {
       MemberExpression: function MemberExpression(path, state) {
-        var _this = this;
+        var _this$filename,
+            _this = this;
 
         var objectName = path.node.object.name;
         var propertyName = path.node.property.name;
 
-        if (!targets || !targets.length || objectName !== 'my' || path.scope.hasBinding('my')) {
+        if ( // Remix 中会编译所有 node_modules 下的模块
+        (_this$filename = this.filename) !== null && _this$filename !== void 0 && _this$filename.includes("".concat(_path.default.sep, "node_modules").concat(_path.default.sep, "hylid-bridge").concat(_path.default.sep)) || !targets || !targets.length || objectName !== 'my' || path.scope.hasBinding('my')) {
           return;
         }
 
+        var newNode = babelTypes.cloneNode(path.node, true, true);
+        newNode.object = babelTypes.identifier(myLocalName);
+
         if (state.usedJSAPIList === 'all') {
+          path.replaceWith(newNode);
           return;
         }
 
@@ -76,7 +131,7 @@ var _default = function _default(_, opts) {
           var name = propertyName;
 
           if (targets.every(function (target) {
-            var targetSplit = target.split('|');
+            var targetSplit = splitTarget(target);
 
             if (!isApiExists(name, target)) {
               utils.warn("Can not find the API `".concat(name, "` in `").concat(_path.default.resolve(libraryDir, './lib/clients/' + targetSplit[0] + '/' + targetSplit[1]), "`. Fallback to import all API codes of ").concat(target, ". Current file path: `").concat(_this.file.opts.filename, "`."));
@@ -90,6 +145,8 @@ var _default = function _default(_, opts) {
             state.usedJSAPIList = 'all';
           }
         }
+
+        path.replaceWith(newNode);
       },
       Program: {
         exit: function exit(path, state) {
@@ -104,11 +161,24 @@ var _default = function _default(_, opts) {
             return;
           }
 
-          var nodes = [babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(appEnvLocalName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/appEnv")))];
+          var innerAppEnvLocalName = "".concat(identifierPrefix, "innerAppEnv__");
+          var userAppEnvLocalName = "".concat(identifierPrefix, "userAppEnv__");
+          var nodes = [babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(innerAppEnvLocalName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/appEnv")))];
+
+          if (userAppEnvPath) {
+            var relativePath = _path.default.relative(_path.default.dirname(this.filename), userAppEnvPath.replace(/\.ts$/, ''));
+
+            nodes.push(babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(userAppEnvLocalName))], babelTypes.stringLiteral(relativePath.startsWith('../') ? relativePath : "./".concat(relativePath))));
+          } else {
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(userAppEnvLocalName), babelTypes.objectExpression([]))]));
+          }
+
+          var objectSpreadName = "".concat(identifierPrefix, "objectSpread__");
+          nodes.push(babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(objectSpreadName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/objectSpread"))), babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(appEnvLocalName), babelTypes.callExpression(babelTypes.identifier(objectSpreadName), [babelTypes.identifier(innerAppEnvLocalName), babelTypes.identifier(userAppEnvLocalName)]))]));
 
           if (usedJSAPIList === 'all') {
             nodes.push.apply(nodes, (0, _toConsumableArray2.default)(targets.map(function (target) {
-              var targetSplit = target.split('|');
+              var targetSplit = splitTarget(target);
               return babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__")))], babelTypes.stringLiteral("".concat(libraryName, "/lib/clients/").concat(targetSplit[0], "/").concat(targetSplit[1], "/index")));
             })));
 
@@ -118,15 +188,15 @@ var _default = function _default(_, opts) {
               }
 
               var target = targetList[0];
-              var targetSplit = target.split('|');
-              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier('my'), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__"))))]), buildElseIf(targetList.slice(1)));
+              var targetSplit = splitTarget(target);
+              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__"))))]), buildElseIf(targetList.slice(1)));
             };
 
-            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier('my'))])); // Do not generate the `if statement` when there is just one target.
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(myLocalName))])); // Do not generate the `if statement` when there is just one target.
 
             if (targets.length === 1) {
-              var targetSplit = targets[0].split('|');
-              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier('my'), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__")))));
+              var targetSplit = splitTarget(targets[0]);
+              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_my__")))));
             } else {
               var elseIfNode = buildElseIf(targets);
               elseIfNode && nodes.push(elseIfNode);
@@ -136,7 +206,7 @@ var _default = function _default(_, opts) {
 
             normalizedJSAPIList.forEach(function (name) {
               targets.forEach(function (target) {
-                var targetSplit = target.split('|');
+                var targetSplit = splitTarget(target);
                 var localName = "".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_").concat(name, "__");
                 var n = babelTypes.importDeclaration([babelTypes.importDefaultSpecifier(babelTypes.identifier(localName))], babelTypes.stringLiteral("".concat(libraryName, "/lib/clients/").concat(targetSplit[0], "/").concat(targetSplit[1], "/").concat(name)));
                 nodes.push(n);
@@ -149,22 +219,22 @@ var _default = function _default(_, opts) {
               }
 
               var target = targetList[0];
-              var targetSplit = target.split('|');
+              var targetSplit = splitTarget(target);
               var propertyList = normalizedJSAPIList.map(function (name) {
                 return babelTypes.objectProperty(babelTypes.identifier(name), babelTypes.identifier("".concat(identifierPrefix).concat(targetSplit[0], "_").concat(targetSplit[1], "_").concat(name, "__")));
               });
-              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier('my'), babelTypes.objectExpression(propertyList)))]), _buildElseIf(targetList.slice(1)));
+              return babelTypes.ifStatement(babelTypes.identifier("".concat(appEnvLocalName, ".").concat(_lodash.default.camelCase("is_".concat(targetSplit[0], "_").concat(targetSplit[1])))), babelTypes.blockStatement([babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.objectExpression(propertyList)))]), _buildElseIf(targetList.slice(1)));
             };
 
-            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier('my'))])); // Do not generate the `if statement` when there is just one target.
+            nodes.push(babelTypes.variableDeclaration('var', [babelTypes.variableDeclarator(babelTypes.identifier(myLocalName))])); // Do not generate the `if statement` when there is just one target.
 
             if (targets.length === 1) {
-              var _targetSplit = targets[0].split('|');
+              var _targetSplit = splitTarget(targets[0]);
 
               var propertyList = normalizedJSAPIList.map(function (name) {
                 return babelTypes.objectProperty(babelTypes.identifier(name), babelTypes.identifier("".concat(identifierPrefix).concat(_targetSplit[0], "_").concat(_targetSplit[1], "_").concat(name, "__")));
               });
-              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier('my'), babelTypes.objectExpression(propertyList))));
+              nodes.push(babelTypes.expressionStatement(babelTypes.assignmentExpression('=', babelTypes.identifier(myLocalName), babelTypes.objectExpression(propertyList))));
             } else {
               var _elseIfNode = _buildElseIf(targets);
 
@@ -175,6 +245,10 @@ var _default = function _default(_, opts) {
           if (nodes.length) {
             path.unshiftContainer('body', nodes);
           }
+
+          if (targets.length && (usedJSAPIList === 'all' || usedJSAPIList.length)) {
+            utils.log("Successfully inject the Hylid-bridge into ".concat(this.filename, " to support the targets: ").concat(targets.join(','), "."));
+          }
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-hylid-bridge",
-  "version": "2.3.0",
+  "version": "2.4.0-alpha.2",
   "description": "babel-plugin-hylid-bridge",
   "main": "lib/index.js",
   "scripts": {
@@ -13,14 +13,14 @@
   "keywords": [],
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.15.6",
-    "@babel/runtime": "^7.18.6",
-    "@babel/types": "^7.15.6",
-    "@types/fs-extra": "^9.0.13",
-    "@types/lodash": "^4.14.176",
-    "chalk": "^4.1.2",
-    "fs-extra": "^10.0.0",
-    "lodash": "^4.17.21"
+    "@babel/core": "7.18.2",
+    "@babel/runtime": "7.18.9",
+    "@babel/types": "7.18.10",
+    "@types/fs-extra": "9.0.13",
+    "@types/lodash": "4.14.182",
+    "chalk": "3.0.0",
+    "fs-extra": "10.1.0",
+    "lodash": "4.17.21"
   },
   "devDependencies": {
     "gulp": "4.0.2",