tt-minigame-ide-cli 0.0.1-beta.0

package/.yarnrc

@@ -0,0 +1 @@
+registry "https://registry.npmjs.org"

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Bytedance Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,119 @@
+# tmg-cli
+
+> `tmg` cli is the official tool for bytedance microapp development.
+
+[中文](./README.md)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Create Project](#create-project)
+  - [Open existing project](#open-existing-project)
+  - [Login](#login)
+  - [Login by email](#login-by-email)
+  - [Preview project](#preview-project)
+  - [Upload project](#upload-project)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
+
+It's recommended to install `tmg` globally.
+
+```
+npm install -g tt-ide-cli
+```
+
+## Usage
+
+### Create Project
+
+Create a new blank miniprogram project with given name in current folder.
+
+```
+Usage: tmg create <project-name>
+
+Create a new project with given name in current folder
+
+Options:
+
+  -f, --force        Overwrite target directory if it exists
+  -h, --help         Output usage information
+```
+
+### Open existing project
+
+Open existing project with given path in microapp IDE.
+
+If the path is not available, start up the IDE only.
+
+```
+Usage: tmg open <project-path>
+
+Open target project by path
+```
+
+### Login
+
+Login to the developer Platform. Proxy is supported.
+
+```
+Usage: tmg login [options]
+
+Login to the developer platform
+
+Options:
+  -m, --mobile         Login by mobile
+  -e, --email          Login by email
+  -p, --proxy <proxy>  Login with proxy
+  -h, --help           output usage information
+```
+
+### Login by email
+
+```
+Usage: login-e [email] [password]
+
+Login to the developer platform by E-mail
+
+Options:
+  -p, --proxy <proxy>  Login with proxy
+  -h, --help           Output usage information
+```
+
+### Preview project
+
+Upload project to remote and preview the result by scanning the output QR code.
+
+```
+Usage: tmg preview [options] [entry]
+
+preview project by remote
+
+Options:
+  -f, --force          Preview project without local cache(deprecated)
+  --disable-cache      Preview project without local cache
+  -s, --small          Use small QR Code, but it does not take effect in some environments
+  -c, --copy           Copy remote url to clipboard
+  -p, --proxy <proxy>  Preview with proxy
+  -h, --help           output usage information
+```
+
+### Upload project
+
+Upload project to the developer platform
+
+```
+Usage: tmg upload [options] [entry]
+
+upload project to the developer platform
+
+Options:
+  -v, --app-version <version>  App version (eg: [major].[minor].[patch])
+  -c, --app-changelog <log>    Changelog for this version
+  -p, --proxy <proxy>          Update request proxy
+  -cp, --copy                  Copy remote url to clipboard
+  -h, --help                   output usage information
+```

package/README.md

@@ -0,0 +1,120 @@
+# tmg-cli
+
+> `tmg` 是字节跳动小程序官方提供的命令行工具。
+
+[English](./README.en.md)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [安装](#%E5%AE%89%E8%A3%85)
+- [使用](#%E4%BD%BF%E7%94%A8)
+  - [创建新项目](#%E5%88%9B%E5%BB%BA%E6%96%B0%E9%A1%B9%E7%9B%AE)
+  - [打开已有项目](#%E6%89%93%E5%BC%80%E5%B7%B2%E6%9C%89%E9%A1%B9%E7%9B%AE)
+  - [登录](#%E7%99%BB%E5%BD%95)
+  - [通过 email 登录](#%E9%80%9A%E8%BF%87-email-%E7%99%BB%E5%BD%95)
+  - [预览小程序](#%E9%A2%84%E8%A7%88%E5%B0%8F%E7%A8%8B%E5%BA%8F)
+  - [上传项目](#%E4%B8%8A%E4%BC%A0%E9%A1%B9%E7%9B%AE)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## 安装
+
+建议在全局安装 `tmg` 。
+
+```
+npm install -g tt-ide-cli
+```
+
+## 使用
+
+### 创建新项目
+
+在当前目录下，以给定的项目名字创建一个空白的小程序项目。
+
+```
+Usage: tmg create <project-name>
+
+Create a new project with given name in current folder
+
+Options:
+
+  -f, --force        Overwrite target directory if it exists
+  -h, --help         Output usage information
+```
+
+### 打开已有项目
+
+在小程序开发者工具中打开给定目录的项目。
+
+如果给定的目录不存在，则仅打开开发者工具。
+
+```
+Usage: tmg open <project-path>
+
+Open target project by path
+```
+
+### 登录
+
+登录到开发者平台。支持代理设置。
+
+```
+Usage: tmg login [options]
+
+Login to the developer platform
+
+Options:
+  -m, --mobile         Login by mobile
+  -e, --email          Login by email
+  -p, --proxy <proxy>  Login with proxy
+  -h, --help           output usage information
+```
+
+### 通过 email 登录
+
+```
+Usage: login-e [email] [password]
+
+Login to the developer platform by E-mail
+
+Options:
+  -p, --proxy <proxy>  Login with proxy
+  -h, --help           Output usage information
+
+```
+
+### 预览小程序
+
+将项目上传后，扫码二维码来预览小程序。
+
+```
+Usage: tmg preview [options] [entry]
+
+preview project by remote
+
+Options:
+  -f, --force          Preview project without local cache(deprecated)
+  --disable-cache      Preview project without local cache
+  -s, --small          Use small QR Code, but it does not take effect in some environments
+  -c, --copy           Copy remote url to clipboard
+  -p, --proxy <proxy>  Preview with proxy
+  -h, --help           output usage information
+```
+
+### 上传项目
+
+把项目上传到开发者平台进行发布。
+
+```
+Usage: tmg upload [options] [entry]
+
+upload project to the developer platform
+
+Options:
+  -v, --app-version <version>  App version (eg: [major].[minor].[patch])
+  -c, --app-changelog <log>    Changelog for this version
+  -p, --proxy <proxy>          Update request proxy
+  -cp, --copy                  Copy remote url to clipboard
+  -h, --help                   output usage information
+```

package/bin/tmg.js

@@ -0,0 +1,199 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const program = require('commander');
+const cp = require('child_process');
+const semver = require('semver');
+const minimist = require('minimist');
+const { getVersion } = require('../lib/util/version');
+const requiredVersion = require('../package.json').engines.node;
+checkNodeVersion(requiredVersion);
+
+// Get version
+program.version(getVersion(), '-V, --version', 'Output the current version');
+
+//#region open project
+
+program
+  .command('open <project-path>')
+  .description('Open target project by path')
+  .action((projectPath) => {
+    const isMac = process.platform === 'darwin',
+      IDE_SCHEMA = 'bytedanceide:';
+    const openCmd = isMac ? `open ${IDE_SCHEMA}` : `explorer ${IDE_SCHEMA}`;
+    let openPath;
+    if (!path.isAbsolute(projectPath)) {
+      projectPath = path.join(process.cwd(), projectPath);
+    }
+    if (fs.existsSync(projectPath)) {
+      // open project with existing path
+      console.log(chalk.green(`open projectPath: ${projectPath}`));
+      openPath = `${openCmd}?path=${projectPath}`;
+    } else {
+      // project folder not exist,
+      // open IDE
+      console.log(chalk.green(`open IDE`));
+      openPath = openCmd;
+    }
+
+    cp.exec(openPath, (error) => {
+      if (!error) {
+        console.log('打开IDE成功');
+      } else {
+        console.log(chalk.red('打开IDE失败', error));
+      }
+    });
+  });
+
+//#endregion
+
+//#region create new project
+
+program
+  .command('create <project-name>')
+  .description('Create a new project with given name in current folder')
+  .option('-f, --force', 'Overwrite target directory if it exists')
+  .action((name, cmd) => {
+    const options = cleanArgs(cmd);
+    checkArgNum(1);
+    require('../lib/create')(name, options);
+  });
+
+//#endregion
+
+//#region Login by mobile or email
+
+program
+  .command('login')
+  .description('Login to the developer platform')
+  .option('-m, --mobile', 'Login by mobile')
+  .option('-e, --email', 'Login by email')
+  .option('-p, --proxy <proxy>', 'Login with proxy')
+  .action((cmd) => {
+    const options = cleanArgs(cmd);
+    require('../lib/auth')(options);
+  });
+
+//#endregion
+
+//#region tmg login by Email
+
+program
+  .command('login-e [email] [password]')
+  .description('Login to the developer platform by E-mail')
+  .option('-p, --proxy <proxy>', 'Login with proxy')
+  .action((email, password, cmd) => {
+    const options = {
+      type: 'direct',
+      email,
+      password,
+      cmd,
+    };
+    require('../lib/auth')(options);
+  });
+
+//#endregion
+
+//#region preview project
+
+program
+  .command('preview [entry]')
+  .description('Preview project by remote')
+  .option('-f, --force', 'Preview project without local cache(deprecated)')
+  .option('--disable-cache', 'Preview project without local cache')
+  .option('-s, --small', 'Use small QR Code, it may fail in some environments')
+  .option('-c, --copy', 'Copy remote url to clipboard')
+  .option('-p, --proxy <proxy>', 'Preview with proxy')
+  .action((entry, cmd) => {
+    const options = cleanArgs(cmd);
+    checkArgNum(1);
+    require('../lib/preview')(entry, options);
+  });
+
+//#endregion
+
+program
+  .command('build-npm [projectPath]')
+  .description('build npm packages in node_modules')
+  // 后面需要支持一下下方的两个选项
+  //   .option('--package-json-path');
+  //   .options('-i, --ignores', 'npm packages to be ignored')
+  .action((projectPath, cmd) => {
+    const options = cleanArgs(cmd);
+    require('../lib/index').buildNpm({
+      projectPath,
+      ...options,
+    });
+  });
+
+//#region upload project
+
+program
+  .command('upload [entry]')
+  .description('Upload project to the developer platform')
+  .requiredOption(
+    '-v, --app-version <version>',
+    'App version (eg: [major].[minor].[patch])'
+  )
+  .requiredOption('-c, --app-changelog <log>', 'Changelog for this version')
+  .option('-p, --proxy <proxy>', 'Update request proxy')
+  .option('-cp, --copy', 'Copy remote url to clipboard')
+  .action((entry, cmd) => {
+    const options = cleanArgs(cmd);
+    checkArgNum(1);
+    // console.log(entry, options)
+    require('../lib/upload')(entry, options);
+  });
+
+//#endregion
+
+program.parse(process.argv);
+
+//#region helpers
+
+function camelize(str) {
+  return str.replace(/-(\w)/g, (_, c) => (c ? c.toUpperCase() : ''));
+}
+
+function checkArgNum(num) {
+  if (minimist(process.argv.slice(3))._.length > num) {
+    console.log(
+      chalk.yellow(
+        '\n Info: You provided more than one argument. The first one will be used, the rest are ignored.'
+      )
+    );
+  }
+}
+
+function checkNodeVersion(wanted) {
+  if (!semver.satisfies(process.version, wanted)) {
+    console.log(
+      chalk.red(
+        'You are using Node ' +
+          process.version +
+          ', but this version of `tmg`' +
+          ' requires Node ' +
+          wanted +
+          '.\nPlease upgrade your Node version.'
+      )
+    );
+    process.exit(1);
+  }
+}
+
+// commander passes the Command object itself as options,
+// extract only actual options into a fresh object.
+function cleanArgs(cmd) {
+  return cmd.options.reduce((args, o) => {
+    const key = camelize(o.long.replace(/^--/, ''));
+    // if an option is not present and Command has a method with the same name
+    // it should not be copied
+    if (typeof cmd[key] !== 'function' && typeof cmd[key] !== 'undefined') {
+      args[key] = cmd[key];
+    }
+    return args;
+  }, {});
+}
+
+//#endregion

package/lib/auth.js

@@ -0,0 +1,145 @@
+// login
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const { isValidPhoneNumber, isValidVerificationCode, isValidEmail } = require('./util/check');
+const { clearConsole, outputResult } = require('./util/logger');
+const { getMobileVerificationCode, userLogin, getUserData } = require('./util/request');
+const { saveUserCookies } = require('./util/cookie');
+const { mixEncode } = require('./util/helper');
+
+async function auth(options) {
+  // Choose login type
+  const loginType = await checkLoginType(options);
+  let requestParams = {};
+  clearConsole(chalk.bold.green(`${loginType === 'mobile' ? '📱': ' 📧'} Sign in with ${loginType}`));
+  const { inputRet } = await inquirer.prompt([
+    {
+      name: 'inputRet',
+      type: 'input',
+      message: `Your ${loginType === 'mobile' ? 'mobile number': 'email'}:`
+    }
+  ]);
+  if (loginType === 'mobile') {
+    if (isValidPhoneNumber(inputRet)) {
+      const result = await getMobileVerificationCode(inputRet, options.proxy);
+      result.success ? console.log(chalk.green('Send verification code success')): console.log(chalk.red(result.msg));
+      if (!result.success) return;
+      const { code } = await inquirer.prompt([
+        {
+          name: 'code',
+          type: 'input',
+          message: `Your verification code:`
+        }
+      ]);
+      if (isValidVerificationCode(code)) {
+        requestParams = { mobile: inputRet, code };
+      } else {
+        console.log(chalk.red(`[CLI LOGIN ERROR]: Verification code ${chalk.cyan(code)} is not correct`));
+        return;
+      }
+    } else {
+      console.log(chalk.red(`[CLI LOGIN ERROR]: Mobile number ${chalk.cyan(inputRet)} is not correct`));
+      return;
+    }
+  } else {
+    if (isValidEmail(inputRet)) {
+      const { pwd } = await inquirer.prompt([
+        {
+          name: 'pwd',
+          type: 'password',
+          message: `Your password:`
+        }
+      ]);
+      requestParams = {
+        mix_mode: 1,
+        email: mixEncode(inputRet),
+        password: mixEncode(pwd)
+      }
+    } else {
+      console.log(chalk.red(`[CLI LOGIN ERROR]: Email ${chalk.cyan(inputRet)} is not correct`));
+      return;
+    }
+  }
+  // Start login
+  const { success: loginSuccess, msg: loginMsg, cookies } = await userLogin(loginType, requestParams, options.proxy);
+  if (!loginSuccess) {
+    console.log(chalk.red(`[CLI LOGIN ERROR]: ${loginMsg}`));
+    return;
+  }
+  await saveUserCookies(cookies);
+  const { success: checkSuccess, msg: checkMsg } = await getUserData(options.proxy);
+  if (!checkSuccess) {
+    console.log(chalk.red(`[CLI LOGIN ERROR]: ${checkMsg}`));
+    return;
+  }
+  outputResult('success', loginType, ` 🎉 Login success`);
+}
+
+async function loginDirect(options) {
+  const proxy = options.proxy || options.cmd.proxy;
+  if (!isValidEmail(options.email)) {
+    console.log(chalk.red(`[CLI LOGIN ERROR]: Email ${chalk.cyan(options.email)} is not correct`));
+    return;
+  }
+  const loginType = 'email';
+  const requestParams = {
+    mix_mode: 1,
+    email: mixEncode(options.email),
+    password: mixEncode(options.password)
+  };
+  // Start login
+  const { success: loginSuccess, msg: loginMsg, cookies } = await userLogin(loginType, requestParams, proxy);
+  if (!loginSuccess) {
+    console.log(chalk.red(`[CLI LOGIN ERROR]: ${loginMsg}`));
+    return;
+  }
+  await saveUserCookies(cookies, options.cacheDir);
+  const { success: checkSuccess, msg: checkMsg } = await getUserData(proxy);
+  if (!checkSuccess) {
+    console.log(chalk.red(`[CLI LOGIN ERROR]: ${checkMsg}`));
+    return;
+  }
+  outputResult('success', loginType, ` 🎉 Login success`);
+}
+
+async function checkLoginType(options) {
+  let loginType = '';
+  if (options.mobile) {
+    loginType = 'mobile';
+  } else if (options.email) {
+    loginType = 'email';
+  } else {
+    const { action } = await inquirer.prompt([
+      {
+        name: 'action',
+        type: 'list',
+        message: `Please choose login type:`,
+        choices: [
+          { name: 'Mobile', value: 'mobile' },
+          { name: 'Email', value: 'email' },
+          { name: 'Cancel', value: false }
+        ]
+      }
+    ]);
+    if (!action) {
+      return;
+    } else {
+      loginType = action;
+    }
+  }
+  return loginType;
+}
+
+module.exports = (...args) => {
+  if (args[0].type === 'direct') {
+    return loginDirect(args[0]).catch(err => {
+      console.log(chalk.red(`[CLI LOGIN ERROR]: ${err}`));
+      process.exit(1);
+    });
+  } else {
+    return auth(...args).catch(err => {
+      console.log(chalk.red(`[CLI LOGIN ERROR]: ${err}`));
+      process.exit(1);
+    });
+  }
+}

package/lib/build-npm.js

@@ -0,0 +1,22 @@
+const { packNpm } = require('@tt-miniprogram/ext-pack');
+
+const buildNpm = async (options) => {
+	// console.log('buildNpm收到的options是：：：', options);
+	let projectPath = options.projectPath || process.cwd();
+    return new Promise((resolve, reject) => {
+        packNpm({
+            rootPath: projectPath,
+            isWatch: false
+        }, function(err, info) {
+            if (err) {
+                console.log({buildSuccess: false, reason: err});
+                reject({buildSuccess: false, reason: err});
+            } else {
+                console.log({buildSuccess: true, reason: info});
+                resolve({buildSuccess: true, reason: info});
+            }
+        });
+    });
+};
+
+module.exports = buildNpm;