@spcsn/taro-cli 0.1.0

package/src/__tests__/doctor-recommand.spec.ts

@@ -0,0 +1,136 @@
+import * as path from 'node:path';
+
+import { chalk, fs } from '@spcsn/taro-helper';
+
+import doctor from '../doctor';
+
+const validator = doctor.validators[3];
+
+jest.mock('@spcsn/taro-helper', () => {
+  const helper = jest.requireActual('@spcsn/taro-helper');
+  const fs = helper.fs;
+  return {
+    __esModule: true,
+    ...helper,
+    fs: {
+      ...fs,
+      readdirSync: jest.fn(),
+      existsSync: jest.fn(),
+    },
+  };
+});
+
+describe('recommand validator of doctor', () => {
+  const existsSyncMocked = fs.existsSync as jest.Mock<any>;
+  const readdirSyncMocked = fs.readdirSync as jest.Mock<any>;
+
+  beforeEach(() => {
+    jest.resetModules();
+    existsSyncMocked.mockReset();
+    readdirSyncMocked.mockReset();
+    existsSyncMocked.mockReturnValue(true);
+  });
+
+  it.skip("should exit because there isn't a Taro project", async () => {
+    const exitSpy = jest.spyOn(process, 'exit') as jest.SpyInstance<void, any>;
+    const logSpy = jest.spyOn(console, 'log');
+
+    exitSpy.mockImplementation(() => {
+      throw new Error();
+    });
+    logSpy.mockImplementation(() => {});
+    existsSyncMocked.mockReturnValue(false);
+
+    const MOCK_APP_PATH = 'src/';
+    try {
+      await validator({ appPath: MOCK_APP_PATH });
+    } catch (error) {} // eslint-disable-line no-empty
+
+    expect(exitSpy).toBeCalledWith(1);
+    const PROJECT_PACKAGE_PATH = path.join(MOCK_APP_PATH, 'package.json');
+    expect(logSpy).toBeCalledWith(chalk.red(`找不到${PROJECT_PACKAGE_PATH}，请确定当前目录是Taro项目根目录!`));
+
+    exitSpy.mockRestore();
+    logSpy.mockRestore();
+  });
+
+  it.skip('should warn when test framework not found', async () => {
+    jest.doMock('./fixtures/default/package.json', () => ({
+      devDependencies: {
+        eslint: 1,
+      },
+    }));
+    readdirSyncMocked.mockReturnValue(['readme', '.gitignore', '.editorconfig']);
+
+    const { lines } = await validator({ appPath: path.join(__dirname, './fixtures/default') });
+
+    expect(lines.length).toBe(1);
+    expect(lines[0].desc).toBe(
+      '没有检查到常见的测试依赖(jest/mocha/ava/tape/jesmine/karma), 配置测试可以帮助提升项目质量',
+    );
+    expect(lines[0].valid).toBe(true);
+    expect(lines[0].solution).toBe(
+      '可以参考 https://github.com/NervJS/taro-ui-sample 项目, 其中已经包含了完整的测试配置与范例',
+    );
+
+    jest.dontMock('./fixtures/default/package.json');
+  });
+
+  it.skip('should warn when Readme not found', async () => {
+    jest.doMock('./fixtures/default/package.json', () => ({
+      devDependencies: {
+        mocha: 1,
+        jslint: 1,
+      },
+    }));
+    readdirSyncMocked.mockReturnValue(['.gitignore', '.editorconfig']);
+
+    const { lines } = await validator({ appPath: path.join(__dirname, './fixtures/default') });
+
+    expect(lines.length).toBe(1);
+    expect(lines[0].desc).toBe(
+      '没有检查到 Readme (readme/readme.md/readme.markdown), 编写 Readme 可以方便其他人了解项目',
+    );
+    expect(lines[0].valid).toBe(true);
+
+    jest.dontMock('./fixtures/default/package.json');
+  });
+
+  it.skip('should warn when .gitignore not found', async () => {
+    jest.doMock('./fixtures/default/package.json', () => ({
+      devDependencies: {
+        jesmine: 1,
+        tslint: 1,
+      },
+    }));
+    readdirSyncMocked.mockReturnValue(['readme.markdown', '.editorconfig']);
+
+    const { lines } = await validator({ appPath: path.join(__dirname, './fixtures/default') });
+
+    expect(lines.length).toBe(1);
+    expect(lines[0].desc).toBe(
+      '没有检查到 .gitignore 配置, 配置 .gitignore 以避免将敏感信息或不必要的内容提交到代码仓库',
+    );
+    expect(lines[0].valid).toBe(true);
+
+    jest.dontMock('./fixtures/default/package.json');
+  });
+
+  it.skip('should warn when .editorconfig not found', async () => {
+    jest.doMock('./fixtures/default/package.json', () => ({
+      devDependencies: {
+        karma: 1,
+        jshint: 1,
+      },
+    }));
+    readdirSyncMocked.mockReturnValue(['readme', '.gitignore']);
+
+    const { lines } = await validator({ appPath: path.join(__dirname, './fixtures/default') });
+
+    expect(lines.length).toBe(1);
+    expect(lines[0].desc).toBe('没有检查到 .editconfig 配置, 配置 editconfig 以统一项目成员编辑器的代码风格');
+    expect(lines[0].valid).toBe(true);
+
+    jest.dontMock('./fixtures/default/package.json');
+  });
+});

package/src/__tests__/doctor.spec.ts

@@ -0,0 +1,94 @@
+import { chalk } from '@spcsn/taro-helper';
+
+import { run } from './utils';
+
+jest.mock('../doctor', () => {
+  return {
+    __esModule: true,
+    default: {
+      validators: [
+        () => ({
+          isValid: true,
+          messgaes: [
+            {
+              kind: 2,
+              content: 'Env Success',
+            },
+          ],
+        }),
+        () =>
+          Promise.resolve({
+            isValid: false,
+            messgaes: [
+              {
+                kind: 1,
+                content: 'Config Error',
+              },
+            ],
+          }),
+        () => ({
+          isValid: true,
+          messgaes: [
+            {
+              kind: 2,
+              content: 'Package Success',
+            },
+          ],
+        }),
+        () => ({
+          isValid: true,
+          messgaes: [
+            {
+              kind: 2,
+              content: 'recommend Success',
+            },
+          ],
+        }),
+        async () => ({
+          isValid: true,
+          messgaes: [
+            {
+              kind: 2,
+              content: 'doctor Success',
+            },
+          ],
+        }),
+      ],
+    },
+  };
+});
+
+jest.mock('ora', () => {
+  const ora = jest.fn();
+  ora.mockReturnValue({
+    start() {
+      return {
+        succeed() {},
+      };
+    },
+  });
+  return ora;
+});
+
+const runDoctor = run('doctor', [require.resolve('@tarojs/plugin-doctor')]);
+
+describe('doctor', () => {
+  it("should exit because there isn't a Taro project", async () => {
+    const exitSpy = jest.spyOn(process, 'exit') as jest.SpyInstance<void, any>;
+    const logSpy = jest.spyOn(console, 'log');
+
+    exitSpy.mockImplementation(() => {
+      throw new Error();
+    });
+    logSpy.mockImplementation(() => {});
+    try {
+      await runDoctor('', { options: { disableGlobalConfig: true } });
+    } catch (error) {} // eslint-disable-line no-empty
+
+    expect(exitSpy).toBeCalledWith(1);
+    expect(logSpy).toBeCalledWith(chalk.red('找不到项目配置文件config/index，请确定当前目录是 Taro 项目根目录!'));
+
+    exitSpy.mockRestore();
+    logSpy.mockRestore();
+  });
+});

package/src/__tests__/dotenv-parse.spec.ts

@@ -0,0 +1,105 @@
+import * as path from 'node:path';
+
+import { dotenvParse } from '@spcsn/taro-helper';
+import { Kernel } from '@spcsn/taro-service';
+
+import CLI from '../cli';
+
+jest.mock('@spcsn/taro-service');
+const MockedKernel = Kernel as unknown as jest.Mock<Kernel>;
+const APP_PATH = path.join(__dirname, 'fixtures/default');
+
+function setProcessArgv(cmd: string) {
+  // @ts-ignore
+  process.argv = [null, ...cmd.split(' ')];
+}
+
+describe('inspect', () => {
+  let cli: CLI;
+
+  beforeAll(() => {
+    cli = new CLI(APP_PATH);
+  });
+
+  beforeEach(() => {
+    MockedKernel.mockClear();
+    process.argv = [];
+    delete process.env.NODE_ENV;
+    delete process.env.TARO_ENV;
+    delete process.env.TARO_APP_TEST;
+    delete process.env.TARO_APP_ID;
+    delete process.env.JD_APP_TEST;
+    delete process.env.TARO_APP_DEFAULT;
+    delete process.env.TARO_APP_FOO;
+  });
+
+  afterEach(() => {
+    MockedKernel.mockClear();
+    process.argv = [];
+    delete process.env.NODE_ENV;
+    delete process.env.TARO_ENV;
+    delete process.env.TARO_APP_TEST;
+    delete process.env.TARO_APP_ID;
+    delete process.env.JD_APP_TEST;
+    delete process.env.TARO_APP_DEFAULT;
+    delete process.env.TARO_APP_FOO;
+  });
+
+  describe('cli mode env', () => {
+    it('dotenvParse .env .env.dev should success', async () => {
+      expect(process.env.TARO_test).toBeUndefined();
+      dotenvParse(path.resolve(__dirname, 'env'), 'TARO_', 'dev');
+      expect(process.env.TARO_test).toBe('123');
+      expect(process.env._TARO_test).toBeUndefined();
+    });
+
+    it('--watch true => 默认加载 .env.development', async () => {
+      setProcessArgv('taro build --watch --type weapp');
+      await cli.run();
+      expect(process.env.TARO_APP_TEST).toEqual('env-development');
+      expect(process.env.TARO_APP_DEFAULT).toEqual('default');
+    });
+
+    it('--watch false => 默认加载 .env.production', async () => {
+      setProcessArgv('taro build --type weapp');
+      await cli.run();
+      expect(process.env.TARO_APP_TEST).toEqual('env-production');
+      expect(process.env.TARO_APP_DEFAULT).toEqual('default');
+    });
+
+    it('指定加载 .env.pre', async () => {
+      setProcessArgv('taro build --type weapp --mode pre');
+      await cli.run();
+      expect(process.env.TARO_APP_TEST).toEqual('env-pre');
+      expect(process.env.TARO_APP_DEFAULT).toEqual('default');
+    });
+
+    it('env.local 比 .env 优先级更高', async () => {
+      setProcessArgv('taro build --type weapp --mode find404');
+      await cli.run();
+      expect(process.env.TARO_APP_TEST).toEqual('env-local');
+      expect(process.env.TARO_APP_DEFAULT).toEqual('default');
+    });
+
+    it('env.uat.local 比 .env.uat 优先级更高', async () => {
+      setProcessArgv('taro build --type weapp --mode uat');
+      await cli.run();
+      expect(process.env.TARO_APP_TEST).toEqual('env-uat-local');
+      expect(process.env.TARO_APP_DEFAULT).toEqual('default');
+    });
+
+    it('自定义前缀: JD_APP_', async () => {
+      setProcessArgv('taro build --type weapp --mode uat --env-prefix JD_APP_');
+      await cli.run();
+      expect(process.env.JD_APP_TEST).toEqual('env-uat');
+      expect(process.env.TARO_APP_TEST).toEqual(undefined);
+      expect(process.env.TARO_APP_ID).toEqual('特殊变量appid');
+    });
+
+    it('环境变量可以相互引用', async () => {
+      setProcessArgv('taro build --type weapp --mode pre');
+      await cli.run();
+      expect(process.env.TARO_APP_FOO).toEqual('env-pre-foo');
+    });
+  });
+});

package/src/__tests__/env/.env

@@ -0,0 +1,2 @@
+TARO_test = 123
+_TARO_test = 456

package/src/__tests__/fixtures/default/.env

@@ -0,0 +1,3 @@
+TARO_APP_TEST=env
+
+TARO_APP_DEFAULT=default

package/src/__tests__/fixtures/default/.env.development

@@ -0,0 +1 @@
+TARO_APP_TEST=env-development

package/src/__tests__/fixtures/default/.env.local

@@ -0,0 +1 @@
+TARO_APP_TEST=env-local

package/src/__tests__/fixtures/default/.env.pre

@@ -0,0 +1,3 @@
+TARO_APP_TEST=env-pre
+
+TARO_APP_FOO=${TARO_APP_TEST}-foo

package/src/__tests__/fixtures/default/.env.production

@@ -0,0 +1 @@
+TARO_APP_TEST=env-production

package/src/__tests__/fixtures/default/.env.uat

@@ -0,0 +1,5 @@
+TARO_APP_TEST=env-uat
+
+JD_APP_TEST=env-uat
+
+TARO_APP_ID=特殊变量appid

package/src/__tests__/fixtures/default/.env.uat.local

@@ -0,0 +1 @@
+TARO_APP_TEST=env-uat-local

package/src/__tests__/fixtures/default/babel.config.js

@@ -0,0 +1,10 @@
+// babel-preset-taro 更多选项和默认值：
+// https://github.com/NervJS/taro/blob/next/packages/babel-preset-taro/README.md
+module.exports = {
+  presets: [
+    ['taro', {
+      framework: 'react',
+      ts: false
+    }]
+  ]
+}

package/src/__tests__/fixtures/default/config/dev.js

@@ -0,0 +1,9 @@
+module.exports = {
+  env: {
+    NODE_ENV: '"development"'
+  },
+  defineConstants: {
+  },
+  mini: {},
+  h5: {}
+}

package/src/__tests__/fixtures/default/config/index.js

@@ -0,0 +1,84 @@
+const config = {
+  projectName: 't2',
+  date: '2020-5-21',
+  designWidth: 750,
+  deviceRatio: {
+    640: 2.34 / 2,
+    750: 1,
+    828: 1.81 / 2
+  },
+  sourceRoot: 'src',
+  outputRoot: 'dist',
+  plugins: [],
+  defineConstants: {
+  },
+  copy: {
+    patterns: [
+    ],
+    options: {
+    }
+  },
+  framework: 'react',
+  compiler: {
+    type: 'webpack5',
+    prebundle: {
+      enable: false
+    }
+  },
+  mini: {
+    output: {
+      clean: {
+        keep: ['project.config.json']
+      }
+    },
+    postcss: {
+      pxtransform: {
+        enable: true,
+        config: {
+
+        }
+      },
+      url: {
+        enable: true,
+        config: {
+          limit: 1024 // 设定转换尺寸上限
+        }
+      },
+      cssModules: {
+        enable: false, // 默认为 false，如需使用 css modules 功能，则设为 true
+        config: {
+          namingPattern: 'module', // 转换模式，取值为 global/module
+          generateScopedName: '[name]__[local]___[hash:base64:5]'
+        }
+      }
+    }
+  },
+  h5: {
+    output: {
+      clean: false
+    },
+    publicPath: '/',
+    staticDirectory: 'static',
+    postcss: {
+      autoprefixer: {
+        enable: true,
+        config: {
+        }
+      },
+      cssModules: {
+        enable: false, // 默认为 false，如需使用 css modules 功能，则设为 true
+        config: {
+          namingPattern: 'module', // 转换模式，取值为 global/module
+          generateScopedName: '[name]__[local]___[hash:base64:5]'
+        }
+      }
+    }
+  }
+}
+
+module.exports = function (merge) {
+  if (process.env.NODE_ENV === 'development') {
+    return merge({}, config, require('./dev'))
+  }
+  return merge({}, config, require('./prod'))
+}

package/src/__tests__/fixtures/default/config/prod.js

@@ -0,0 +1,18 @@
+module.exports = {
+  env: {
+    NODE_ENV: '"production"'
+  },
+  defineConstants: {
+  },
+  mini: {},
+  h5: {
+    /**
+     * 如果h5端编译后体积过大，可以使用webpack-bundle-analyzer插件对打包体积进行分析。
+     * 参考代码如下：
+     * webpackChain (chain) {
+     *   chain.plugin('analyzer')
+     *     .use(require('webpack-bundle-analyzer').BundleAnalyzerPlugin, [])
+     * }
+     */
+  }
+}

package/src/__tests__/fixtures/default/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "test",
+  "dependencies": {
+    "@babel/runtime": "^7.7.7",
+    "@spcsn/taro-shared": "3.0.0-beta.6",
+    "@spcsn/taro": "3.0.0-beta.6",
+    "@spcsn/taro-api": "3.0.0-beta.6",
+    "@spcsn/taro-cli": "3.0.0-beta.6",
+    "@spcsn/taro-components": "3.0.0-beta.6",
+    "@spcsn/taro-helper": "3.0.0-beta.6",
+    "@spcsn/taro-react": "3.0.0-beta.6",
+    "@spcsn/taro-runner-utils": "3.0.0-beta.6",
+    "@spcsn/taro-runtime": "3.0.0-beta.6",
+    "@spcsn/taro-service": "3.0.0-beta.6",
+    "@spcsn/taro-plugin-platform-weapp": "3.0.0-beta.6",
+    "@spcsn/taro-plugin-framework-react": "3.0.0-beta.6",
+    "@spcsn/taro-plugin-generator": "3.0.0-beta.6",
+    "@spcsn/taro-vite-runner": "3.0.0-beta.6",
+    "@spcsn/taro-binding": "0.1.0"
+  },
+  "devDependencies": {
+    "babel-preset-taro": "2.0.0",
+    "babel-plugin-transform-taroapi": "3.0.0-beta.6",
+    "postcss-plugin-constparse": "3.0.0-beta.6",
+    "postcss-pxtransform": "3.0.0-beta.6"
+  }
+}

package/src/__tests__/fixtures/default/src/app.config.js

@@ -0,0 +1,11 @@
+export default {
+  pages: [
+    'pages/index/index'
+  ],
+  window: {
+    backgroundTextStyle: 'light',
+    navigationBarBackgroundColor: '#fff',
+    navigationBarTitleText: 'WeChat',
+    navigationBarTextStyle: 'black'
+  }
+}

package/src/__tests__/fixtures/default/src/app.js

@@ -0,0 +1,16 @@
+import { Component } from 'react'
+
+class App extends Component {
+  componentDidMount () {}
+
+  componentDidShow () {}
+
+  componentDidHide () {}
+
+  // this.props.children 是将要会渲染的页面
+  render () {
+    return this.props.children
+  }
+}
+
+export default App

package/src/__tests__/fixtures/default/src/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+  <meta content="width=device-width,initial-scale=1,user-scalable=no" name="viewport">
+  <meta name="apple-mobile-web-app-capable" content="yes">
+  <meta name="apple-touch-fullscreen" content="yes">
+  <meta name="format-detection" content="telephone=no,address=no">
+  <meta name="apple-mobile-web-app-status-bar-style" content="white">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" >
+  <title></title>
+  <script>
+    !function(x){function w(){var v,u,t,tes,s=x.document,r=s.documentElement,a=r.getBoundingClientRect().width;if(!v&&!u){var n=!!x.navigator.appVersion.match(/AppleWebKit.*Mobile.*/);v=x.devicePixelRatio;tes=x.devicePixelRatio;v=n?v:1,u=1/v}if(a>=640){r.style.fontSize="40px"}else{if(a<=320){r.style.fontSize="20px"}else{r.style.fontSize=a/320*20+"px"}}}x.addEventListener("resize",function(){w()});w()}(window);
+  </script>
+</head>
+<body>
+  <div id="app"></div>
+</body>
+</html>

package/src/__tests__/fixtures/default/src/pages/index/index.config.js

@@ -0,0 +1,3 @@
+export default {
+  navigationBarTitleText: '首页'
+}

package/src/__tests__/fixtures/default/src/pages/index/index.jsx

@@ -0,0 +1,22 @@
+import React, { Component } from 'react'
+import { View, Text } from '@spcsn/taro-components'
+
+export default class Index extends Component {
+  componentWillMount () { }
+
+  componentDidMount () { }
+
+  componentWillUnmount () { }
+
+  componentDidShow () { }
+
+  componentDidHide () { }
+
+  render () {
+    return (
+      <View className='index'>
+        <Text>Hello world!</Text>
+      </View>
+    )
+  }
+}

package/src/__tests__/info.spec.ts

@@ -0,0 +1,72 @@
+import * as path from 'node:path';
+
+import { chalk } from '@spcsn/taro-helper';
+
+import { getPkgVersion } from '../util';
+import { run } from './utils';
+
+jest.mock('envinfo', () => {
+  const envinfo = jest.requireActual('envinfo');
+  return {
+    __esModule: true,
+    async run(data, options) {
+      const res = await envinfo.run(data, { ...options, json: true });
+      return JSON.parse(res);
+    },
+  };
+});
+
+const runInfo = run('info', ['commands/info']);
+
+describe('info', () => {
+  it("should exit because there isn't a Taro project", async () => {
+    const exitSpy = jest.spyOn(process, 'exit') as jest.SpyInstance<void, any>;
+    const logSpy = jest.spyOn(console, 'log');
+
+    exitSpy.mockImplementation(() => {
+      throw new Error();
+    });
+    logSpy.mockImplementation(() => {});
+
+    try {
+      await runInfo('');
+    } catch (error) {} // eslint-disable-line no-empty
+
+    expect(exitSpy).toBeCalledWith(1);
+    expect(logSpy).toBeCalledWith(chalk.red('找不到项目配置文件config/index，请确定当前目录是 Taro 项目根目录!'));
+
+    exitSpy.mockRestore();
+    logSpy.mockRestore();
+  });
+
+  it('should log information', async () => {
+    const logSpy = jest.spyOn(console, 'log');
+    logSpy.mockImplementation(() => {});
+
+    const appPath = path.resolve(__dirname, 'fixtures/default');
+    await runInfo(appPath);
+
+    expect(logSpy).toBeCalledTimes(1);
+    const res = logSpy.mock.calls[0][0];
+    const title = `Taro CLI ${getPkgVersion()} environment info`;
+    expect(res.hasOwnProperty(title)).toBeTruthy();
+    const info = res[title];
+    expect('System' in info).toBeTruthy();
+    expect('Binaries' in info).toBeTruthy();
+    // envinfo 还不支持 yarn workspace
+    // expect('npmPackages' in info).toBeTruthy()
+    // Note: windows 操作系统可能不存在 System.Shell
+    expect(Object.keys(info.System)).toEqual(expect.arrayContaining(['OS']));
+    // Note: 环境内可能不包括 Yarn
+    expect(Object.keys(info.Binaries)).toEqual(expect.arrayContaining(['Node', 'npm']));
+    // expect(info.npmPackages.hasOwnProperty('@spcsn/taro-helper')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('@spcsn/taro-service')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('@spcsn/taro')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('@spcsn/taroize')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('@spcsn/taro-webpack-runner')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('babel-plugin-transform-taroapi')).toBeTruthy()
+    // expect(info.npmPackages.hasOwnProperty('postcss-pxtransform')).toBeTruthy()
+
+    logSpy.mockRestore();
+  });
+});