babel-plugin-transform-taroapi 3.8.0-canary.0 → 4.0.0-beta.0

package/__tests__/__snapshots__/harmony.spec.ts.snap

@@ -0,0 +1,103 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`babel-plugin-transform-taroapi should canIUse support scheme with numeric attributes! 1`] = `
+"import { canIUse as _canUse } from '@tarojs/taro-h5';
+// 入参带有数字属性的对象路径
+true;
+true;"
+`;
+
+exports[`babel-plugin-transform-taroapi should canIUse support! 1`] = `
+"import { canIUse as _canUse } from '@tarojs/taro-h5';
+// 对象的属性或方法
+false;
+false;
+false;
+false;
+
+// 接口参数、回调或者返回值
+true;
+false;
+false;
+false;
+false;
+true;
+
+// 组件的属性
+true;
+true;
+true;"
+`;
+
+exports[`babel-plugin-transform-taroapi should canIUse work or skip! 1`] = `
+"import Taro from '@tarojs/taro-h5';
+function canIUse() {}
+false;
+false;
+canIUse('showToast.object.image');"
+`;
+
+exports[`babel-plugin-transform-taroapi should leave other apis untouched 1`] = `
+"import Taro from '@tarojs/taro-h5';
+Taro.noop;"
+`;
+
+exports[`babel-plugin-transform-taroapi should move static apis under "Taro" 1`] = `
+"import Taro from '@tarojs/taro-h5';
+Taro.noop;
+Taro.noop();"
+`;
+
+exports[`babel-plugin-transform-taroapi should not go wrong when using an api twice 1`] = `
+"import Taro, { createAnimation as _createAnimation } from '@tarojs/taro-h5';
+const animation = _createAnimation({
+  duration: dura * 1000,
+  timingFunction: 'linear'
+});
+const resetAnimation = _createAnimation({
+  duration: 0,
+  timingFunction: 'linear'
+});"
+`;
+
+exports[`babel-plugin-transform-taroapi should not import taro duplicity 1`] = `
+"import Taro, { createAnimation as _createAnimation, initPxTransform as _initPxTransform } from '@tarojs/taro-h5';
+Taro.Component;
+_createAnimation();
+_initPxTransform();"
+`;
+
+exports[`babel-plugin-transform-taroapi should preserve assignments in left hands 1`] = `
+"import Taro, { createAnimation as _createAnimation, request as _request } from '@tarojs/taro-h5';
+let animation;
+animation = _createAnimation({
+  transformOrigin: "50% 50%",
+  duration: 1000,
+  timingFunction: "ease",
+  delay: 0
+});
+_request();
+Taro.request = '';
+Taro['request'] = '';"
+`;
+
+exports[`babel-plugin-transform-taroapi should preserve default imports 1`] = `
+"import Taro from '@tarojs/taro-h5';
+console.log(Taro);"
+`;
+
+exports[`babel-plugin-transform-taroapi should support rename of imported names 1`] = `
+"// import { inject as mobxInject, observer as mobxObserver } from '@tarojs/mobx'
+import Taro from '@tarojs/taro-h5';
+export class Connected extends Taro.Component {}"
+`;
+
+exports[`babel-plugin-transform-taroapi should work! 1`] = `
+"import Taro, { setStorage as _setStorage, initPxTransform as _initPxTransform, getStorage as _getStorage } from '@tarojs/taro-h5';
+_initPxTransform(Taro.param);
+_initPxTransform();
+_initPxTransform();
+_getStorage();
+_setStorage();
+export { Taro };"
+`;

package/__tests__/harmony.spec.ts

@@ -0,0 +1,220 @@
+import * as babel from '@babel/core'
+import * as t from '@babel/types'
+
+import plugin from '../src'
+import * as definition from './__mocks__/harmony-definition.json'
+
+type ImportType = babel.types.ImportSpecifier | babel.types.ImportDefaultSpecifier | babel.types.ImportNamespaceSpecifier
+
+const packageName = '@tarojs/taro-h5'
+const pluginOptions = [
+  plugin,
+  {
+    packageName,
+    definition,
+  }
+]
+const getNamedImports = (importSpecifiers: (t.ImportSpecifier | t.ImportDefaultSpecifier | t.ImportNamespaceSpecifier)[]) => {
+  return importSpecifiers.reduce((prev, curr) => {
+    if (t.isImportSpecifier(curr)) {
+      prev.add(((curr as t.ImportSpecifier).imported as babel.types.Identifier).name)
+    }
+    return prev
+  }, new Set())
+}
+const babelTransform = (code = '') => babel.transform(code, { ast: true, configFile: false, plugins: [pluginOptions] })
+
+describe('babel-plugin-transform-taroapi', () => {
+  test('should work!', function () {
+    const code = `
+      import Taro, { setStorage, initPxTransform, param } from '${packageName}';
+      initPxTransform(param)
+      Taro.initPxTransform()
+      Taro.initPxTransform()
+      Taro['getStorage']()
+      setStorage()
+      export { Taro }
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should leave other apis untouched', function () {
+    const code = `
+      import Taro from '${packageName}'
+      Taro.noop
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+
+    const ast = result?.ast as t.File
+    const body = ast.program.body as [t.ImportDeclaration, t.ExpressionStatement]
+    expect(t.isImportDeclaration(body[0])).toBeTruthy()
+    expect(t.isExpressionStatement(body[1])).toBeTruthy()
+    const defaultImport = body[0].specifiers.find(v => t.isImportDefaultSpecifier(v)) as ImportType
+    expect(defaultImport).toBeTruthy()
+
+    const taroName = defaultImport.local.name
+    const namedImports = getNamedImports(body[0].specifiers)
+    expect(namedImports).toEqual(new Set())
+    expect(t.isMemberExpression(body[1].expression)).toBeTruthy()
+
+    const obj = t.memberExpression(
+      t.identifier(taroName),
+      t.identifier('noop'),
+    )
+    delete obj.optional
+
+    expect((body[1].expression as t.MemberExpression)).toMatchObject(obj)
+  })
+
+  test('should move static apis under "Taro"', function () {
+    const code = `
+      import { noop } from '${packageName}';
+      noop;
+      noop();
+    `
+
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+
+    const ast = result?.ast as t.File
+    const body = ast.program.body as [t.ImportDeclaration, t.ExpressionStatement]
+    expect(t.isImportDeclaration(body[0])).toBeTruthy()
+    expect(t.isExpressionStatement(body[1])).toBeTruthy()
+    const defaultImport = body[0].specifiers.find(v => t.isImportDefaultSpecifier(v))
+    expect(defaultImport).toBeTruthy()
+
+    const taroName = defaultImport!.local.name
+    let memberExpression: any = body[1].expression
+    if (t.isCallExpression(body[1])) {
+      memberExpression = ((body[1] as t.ExpressionStatement).expression as t.CallExpression).callee
+    }
+    expect(memberExpression).toMatchObject(t.memberExpression(
+      t.identifier(taroName),
+      t.identifier('noop')
+    ))
+  })
+
+  test('should not import taro duplicity', function () {
+    const code = `
+      import { Component } from '${packageName}';
+      import Taro from '${packageName}';
+      Component
+      Taro.createAnimation()
+      Taro.initPxTransform()
+    `
+
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+    const ast = result?.ast as t.File
+    const body = ast.program.body as [t.ImportDeclaration, t.ExpressionStatement, t.ExpressionStatement]
+    expect(t.isImportDeclaration(body[0])).toBeTruthy()
+    expect(t.isExpressionStatement(body[1])).toBeTruthy()
+    expect(t.isExpressionStatement(body[2])).toBeTruthy()
+  })
+
+  test('should not go wrong when using an api twice', function () {
+    const code = `
+      import Taro from '${packageName}';
+      const animation = Taro.createAnimation({
+        duration: dura * 1000,
+        timingFunction: 'linear'
+      })
+      const resetAnimation = Taro.createAnimation({
+        duration: 0,
+        timingFunction: 'linear'
+      })
+    `
+    expect(() => {
+      const result = babelTransform(code)
+      expect(result?.code).toMatchSnapshot()
+    }).not.toThrowError()
+  })
+
+  test('should preserve default imports', function () {
+    const code = `
+      import Taro from '${packageName}'
+      console.log(Taro)
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should preserve assignments in left hands', function () {
+    const code = `
+      import Taro from '${packageName}'
+      let animation
+      animation = Taro.createAnimation({
+        transformOrigin: "50% 50%",
+        duration: 1000,
+        timingFunction: "ease",
+        delay: 0
+      });
+      Taro.request()
+      Taro.request = ''
+      Taro['request'] = ''
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should support rename of imported names', function () {
+    const code = `
+    // import { inject as mobxInject, observer as mobxObserver } from '@tarojs/mobx'
+    import { Component as TaroComponent } from '${packageName}';
+    export class Connected extends TaroComponent {}
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should canIUse work or skip!', function () {
+    const code = `
+    import Taro from '${packageName}'
+    function canIUse() {}
+    Taro.canIUse('showToast.object.image')
+    Taro['canIUse']('showToast.object.image')
+    canIUse('showToast.object.image')
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should canIUse support!', function () {
+    const code = `
+    import { canIUse as canUse } from '${packageName}';
+    // 对象的属性或方法
+    canUse('console.log')
+    canUse('CameraContext.onCameraFrame')
+    canUse('CameraFrameListener.start')
+    canUse('Image.src')
+
+    // 接口参数、回调或者返回值
+    canUse('openBluetoothAdapter')
+    canUse('getSystemInfoSync.return.safeArea.left')
+    canUse('getSystemInfo.success.screenWidth')
+    canUse('showToast.object.image')
+    canUse('onCompassChange.callback.direction')
+    canUse('request.object.method.GET')
+
+    // 组件的属性
+    canUse('live-player')
+    canUse('text.selectable')
+    canUse('button.open-type.contact')
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+
+  test('should canIUse support scheme with numeric attributes!', function () {
+    const code = `
+    import { canIUse as canUse } from '${packageName}';
+    // 入参带有数字属性的对象路径
+    canUse('live-pusher.audio-reverb-type.4')
+    canUse('live-pusher.aspect.9:16')
+    `
+    const result = babelTransform(code)
+    expect(result?.code).toMatchSnapshot()
+  })
+})

package/dist/index.js

@@ -11,7 +11,7 @@ const plugin = function (babel) {
     function canIUse(definition, scheme = '') {
         if (!scheme)
             return false;
-        const o = (0, lodash_1.set)({}, scheme, true);
+        const o = (0, lodash_1.setWith)({}, scheme, true, Object);
         return (0, lodash_1.isMatchWith)(definition, o, (a, b) => {
             if (a === '*' || b === true)
                 return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-transform-taroapi",
-  "version": "3.8.0-canary.0",
+  "version": "4.0.0-beta.0",
   "main": "dist/index.js",
   "dependencies": {
     "lodash": "^4.17.21"

package/src/index.ts

@@ -1,4 +1,4 @@
-import { isMatchWith, set } from 'lodash'
+import { isMatchWith, setWith } from 'lodash'
 
 import type * as BabelCore from '@babel/core'
 
@@ -22,7 +22,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
 
   function canIUse (definition, scheme = '') {
     if (!scheme) return false
-    const o = set({}, scheme, true)
+    const o = setWith({}, scheme, true, Object)
     return isMatchWith(definition, o, (a, b) => {
       if (a === '*' || b === true) return true
     })
@@ -60,7 +60,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
       this.apis = apis
     },
     visitor: {
-      ImportDeclaration (ast) {
+      ImportDeclaration (ast: BabelCore.NodePath<any>) {
         if (ast.node.source.value !== this.packageName) return
 
         ast.node.specifiers.forEach(node => {
@@ -91,7 +91,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
           }
         })
       },
-      MemberExpression (ast) {
+      MemberExpression (ast: BabelCore.NodePath<any>) {
         /* 处理Taro.xxx */
         const isTaro = t.isIdentifier(ast.node.object, { name: taroName })
         const property = ast.node.property
@@ -110,7 +110,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
 
         // 同一api使用多次, 读取变量名
         if (this.apis.has(propertyName)) {
-          const parentNode = ast.parent
+          const parentNode = ast.parent as BabelCore.types.AssignmentExpression
           const isAssignment = t.isAssignmentExpression(parentNode) && parentNode.left === ast.node
 
           if (!isAssignment) {
@@ -129,7 +129,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
           needDefault = true
         }
       },
-      CallExpression (ast) {
+      CallExpression (ast: BabelCore.NodePath<any>) {
         if (!ast.scope.hasReference(this.canIUse)) return
         const callee = ast.node.callee
         if (t.isMemberExpression(callee) && t.isIdentifier(callee.object, { name: taroName })) {
@@ -188,7 +188,7 @@ const plugin = function (babel: typeof BabelCore): BabelCore.PluginObj<IState> {
                 ast.node.specifiers = namedImports
               }
             },
-            CallExpression (ast) {
+            CallExpression (ast: BabelCore.NodePath<any>) {
               if (!invokedApis.has(that.canIUse)) return
               const callee = ast.node.callee
               const { name } = t.identifier(invokedApis.get(that.canIUse)!)