tt-minigame-ide-cli 1.0.2 → 2.0.0-alpha.1

package/dist/tt-ide-cli/src/utils/util.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="node" />
+import { ProjectConfig } from '@byted/miniprogram-utils/dist/data/project';
+import archiver from 'archiver';
+import { Transform } from 'stream';
+export declare const HIGH_WATER_MARK: number;
+export declare function isMac(): boolean;
+export declare function isCli(): boolean;
+export declare function isMiniGameCli(): boolean;
+export declare function isIDE(): boolean;
+export declare const maxConcurrency: () => number;
+export declare function cleanArgs(cmd: any): any;
+export declare function createProjectConfigFile(projectName: string, projectDir: string, useTypeScript?: boolean): Promise<void>;
+export declare function getPackageRoot(): string;
+/**
+ * Will throw {@link Error} if invalid
+ * @param number
+ */
+export declare function validatePhoneNumber(number: string): void;
+/**
+ * Will throw {@link Error} if invalid
+ * @param code
+ */
+export declare function validateVerificationCode(code: string): void;
+/**
+ * Will throw {@link Error} if invalid
+ * @param email
+ */
+export declare function validateEmail(email: string): void;
+/**
+ * Will throw {@link Error} if invalid
+ * @param id
+ */
+export declare function validateAppId(id: string): void;
+/**
+ * 简单 encode 字符串
+ * @param data
+ * @returns encoded string
+ */
+export declare function mixEncode(data: string): string;
+export declare function clearConsole(title?: string): void;
+/**
+ * The folder **`$HOME/.tma-cli`**
+ */
+export declare function getCliDefaultStoragePath(): string;
+export declare function getAppid(projectConfig: ProjectConfig): string;
+export declare function getProjectConfig(projectPath: string): Promise<ProjectConfig>;
+export declare function getAppJson(projectConfig: ProjectConfig, projectPath: string, isGame: boolean): Promise<any>;
+/**
+ * Duplicate a stream with md5 hash of its content
+ * @param source old source stream
+ * @returns a stream with md5
+ */
+export declare function getMD5Stream(source: archiver.Archiver): Promise<Transform & {
+    __md5: string;
+}>;
+export declare const getNextVersion: (version: string) => string;

package/dist/tt-minigame-ide-cli/src/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tt-minigame-ide-cli/src/index.d.ts

@@ -0,0 +1 @@
+export { loginByEmail, loginByPhone, checkSession, buildNpm, setConfig, preview, upload, } from 'tt-ide-cli';

package/dist/tt-minigame-ide-cli/src/types.d.ts

@@ -0,0 +1,43 @@
+export interface ProjectInfo {
+    path: string;
+}
+export interface TMACliConfig {
+    proxy: string | null;
+    tempFilePath: string | null;
+    storagePath: string;
+    url: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+        emailLogin: string;
+        mobileLogin: string;
+        sendLoginCode: string;
+        getUserInfo: string;
+    };
+    interactGameUrl: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+    };
+    microgameUrl: {
+        makeSchema: string;
+        compileProgress: string;
+        preview: string;
+        upload: string;
+        versionInfo: string;
+    };
+    env: {
+        type: 'online' | 'ppe' | 'boe';
+        channel: string;
+    };
+}
+export interface QrcodeInfo {
+    format: 'imageFile' | 'terminal' | 'imageSVG' | 'plain' | null;
+    output?: string;
+    options?: {
+        small?: boolean;
+    };
+}
+export {};

package/package.json

@@ -1,41 +1,64 @@
 {
   "name": "tt-minigame-ide-cli",
-  "version": "1.0.2",
+  "version": "2.0.0-alpha.1",
   "description": "Command line interface for micro app development",
-  "main": "lib/index.js",
+  "license": "ISC",
+  "main": "dist/index.js",
   "bin": {
     "tmg": "bin/tmg.js"
   },
+  "files": [
+    "bin",
+    "templates",
+    "dist"
+  ],
   "scripts": {
-    "doctoc": "doctoc README.md README.en.md"
+    "build": "yarn build:cli",
+    "build:cli": "cross-env NODE_ENV=production BUILD_ENV=CLI NODE_OPTIONS=--max-old-space-size=4096 webpack --config webpack.cli.js --progress",
+    "dev": "yarn dev:cli",
+    "dev:cli": "cross-env NODE_ENV=development webpack --config webpack.cli.js --progress --watch",
+    "prepublishOnly": "yarn build:cli",
+    "test": "npx patch-package && jest"
   },
-  "author": "liubowen.howard@bytedance.com",
-  "license": "ISC",
   "dependencies": {
-    "@tt-miniprogram/ext-pack": "1.0.20",
-    "address": "^1.1.2",
-    "archiver": "^3.1.1",
-    "axios": "^0.19.2",
-    "chalk": "^3.0.0",
+    "@tt-miniprogram/ext-pack": "^1.0.33",
+    "archiver": "^5.3.0",
+    "chalk": "^4.1.2",
     "clipboardy": "^2.2.0",
-    "commander": "^4.1.1",
-    "compare-versions": "^4.1.3",
-    "execa": "^4.0.0",
-    "folder-hash": "^3.3.0",
-    "form-data": "^3.0.0",
-    "fs-extra": "^8.1.0",
-    "glob": "^7.2.0",
-    "inquirer": "^7.0.4",
-    "minimist": "^1.2.0",
-    "qrcode": "^1.5.0",
-    "semver": "^7.3.5",
-    "tunnel": "^0.0.6",
+    "commander": "5.1.0",
+    "deep-clone": "^3.0.3",
+    "easy-table": "^1.2.0",
+    "fast-glob": "^3.2.11",
+    "folder-hash": "^4.0.1",
+    "form-data": "^4.0.0",
+    "fs-extra": "^10.0.0",
+    "inquirer": "^8.2.0",
+    "ora": "^5.4.1",
+    "qrcode": "^1.4.4",
+    "qrcode-terminal": "^0.12.0",
+    "semver-compare": "^1.0.0",
     "unzipper": "^0.10.11"
   },
-  "engines": {
-    "node": ">=8.9"
-  },
   "devDependencies": {
-    "doctoc": "^2.2.0"
+    "@types/archiver": "^5.1.1",
+    "@types/chalk": "^2.2.0",
+    "@types/folder-hash": "^4.0.1",
+    "@types/fs-extra": "^9.0.13",
+    "@types/inquirer": "^8.1.3",
+    "@types/jest": "^29.2.3",
+    "@types/qrcode": "^1.4.2",
+    "@types/qrcode-terminal": "^0.12.0",
+    "@types/unzipper": "^0.10.4",
+    "@types/webpack-merge": "4.1.5",
+    "clean-webpack-plugin": "3.0.0",
+    "cross-env": "^7.0.3",
+    "jest": "^26.6.3",
+    "patch-package": "^6.4.7",
+    "ts-jest": "^26.5.6",
+    "ts-loader": "8.0.5",
+    "webpack-merge": "4.2.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   }
 }

package/.yarnrc

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

package/LICENSE

@@ -1,21 +0,0 @@
-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

@@ -1,104 +0,0 @@
-# tmg-cli
-
-> `tmg` cli is the official tool for bytedance minigame 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)
-  - [Login](#login)
-  - [Login by email](#login-by-email)
-  - [Preview project](#preview-project)
-  - [Upload project](#upload-project)
-  - [Get project version](#get-project-version)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Installation
-
-It's recommended to install `tmg` globally.
-
-```
-npm install -g tt-minigame-ide-cli
-```
-
-## Usage
-
-### 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
-  -u, --copy           Copy remote url to clipboard
-  -p, --proxy <proxy>  Preview with proxy
-  -h, --help           output usage information
-  -o, --output <path>  QRCode image output path
-```
-
-### 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
-  -u, --copy                  Copy remote url to clipboard
-  -h, --help                   output usage information
-  -o, --output <path>          QRCode image output path
-```
-
-### Get project version
-
-Get latest released version of project.
-
-```
-Usage: tmg version [entry]
-
-Get latest released version of project
-```
-

package/lib/auth.js

@@ -1,145 +0,0 @@
-// 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

@@ -1,22 +0,0 @@
-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;

package/lib/create.js

@@ -1,106 +0,0 @@
-// 创建小程序模版
-const fs = require('fs-extra');
-const path = require('path');
-const inquirer = require('inquirer');
-const chalk = require('chalk');
-const axios = require('axios');
-const unzipper = require('unzipper');
-const { createProjectConfigFile } = require('./util/config');
-const { clearConsole } = require('./util/logger');
-const { getVersion } = require('./util/version');
-const TEMPLATE_DOWNLOAD_URL = 'https://sf1-cdn-tos.douyinstatic.com/obj/microapp/frontend/ide/template/tma-showcase.zip';
-
-async function create(projectName, options) {
-  const cwd = options.cwd || process.cwd();
-  const targetDir = path.resolve(cwd, projectName || '.');
-  clearConsole(chalk.bold.green(`miniprogram ide CLI v${getVersion()}`));
-  if (fs.existsSync(targetDir)) {
-    if (options.force) {
-      await fs.remove(targetDir);
-    } else {
-      const { action } = await inquirer.prompt([
-        {
-          name: 'action',
-          type: 'list',
-          message: `Target directory ${chalk.cyan(targetDir)} already exists. Pick an action:`,
-          choices: [
-            { name: 'Overwrite', value: 'overwrite' },
-            { name: 'Cancel', value: false }
-          ]
-        }
-      ]);
-      if (!action) {
-        return;
-      } else if (action === 'overwrite') {
-        console.log(`\nRemoving ${chalk.cyan(targetDir)}...`);
-        await fs.remove(targetDir);
-      }
-    }
-  }
-  // Choose template
-  const { action } = await inquirer.prompt([
-    {
-      name: 'action',
-      type: 'list',
-      message: `Please select a template:`,
-      choices: [
-        { name: 'Blank template', value: 'blank' },
-        { name: 'Capability-rich template', value: 'rich' },
-        { name: 'Cancel', value: false }
-      ]
-    }
-  ]);
-
-  if (!action) return;
-  
-  fs.ensureDirSync(targetDir);
-  if (action === 'rich') {
-    // Pull the template from the web
-    console.log(`⚙\u{fe0f}   Installing template. This might take a while....`);
-    await downloadRemoteTemplate(TEMPLATE_DOWNLOAD_URL, targetDir)
-  } else {
-    // Copy template from local
-    await fs.copy(path.join(__dirname, '../template'), targetDir);
-    await createProjectConfigFile(projectName, targetDir);
-  }
-
-  console.log(`🎉  Successfully created project ${chalk.yellow(projectName)}.`);
-}
-
-async function downloadRemoteTemplate(sourcePath, targetPath) {
-  return new Promise(async (resolve, reject) => {
-    const zipPath = path.join(targetPath, 'template.zip');
-    const stream = fs.createWriteStream(zipPath);
-    const response = await axios({
-      url: sourcePath,
-      method: "GET",
-      responseType: "stream",
-    });
-    response.data.pipe(stream);
-
-    stream.on('finish', () => {
-      fs.createReadStream(zipPath).
-        pipe(unzipper.Extract({ path: targetPath }))
-          .on('close', () => {
-            fs.unlinkSync(zipPath);
-            resolve();
-          })
-          .on('error', (err) => {
-            fs.unlinkSync(zipPath);
-            reject(err);
-          });
-    });
-
-    stream.on('error', (err) => {
-      reject(err);
-    });
-  });
-}
-
-
-module.exports = (...args) => {
-  return create(...args).catch(err => {
-    console.log(chalk.red(`[CLI CREATE ERROR]: ${err}`));
-    process.exit(1);
-  });
-}

package/lib/index.d.ts

@@ -1,23 +0,0 @@
-interface PreviewOptions {
-	entry?: string;
-	copy?: boolean;
-	force?: boolean;
-	small?: boolean;
-	proxy?: string;
-}
-
-interface UploadOptions {
-	entry?: string;
-	version: string;
-	changeLog: string;
-	proxy?: string;
-	copy?: boolean;
-}
-
-declare namespace ttIdeCli {
-	function create(projectName: string, options: { force?: boolean }): void;
-	function loginByName(email: string, password: string): void;
-	function login(options: { type?: string; proxy?: string }): void;
-	function preview(options: PreviewOptions): void;
-	function upload(options: UploadOptions): void;
-}