tt-minigame-ide-cli 0.0.1-beta.2 → 0.0.1-beta.5

package/README.en.md

@@ -1,6 +1,6 @@
 # tmg-cli
 
-> `tmg` cli is the official tool for bytedance microapp development.
+> `tmg` cli is the official tool for bytedance minigame development.
 
 [中文](./README.md)
 
@@ -9,8 +9,8 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Create Project](#create-project)
-  - [Open existing project](#open-existing-project)
+  <!-- - [Create Project](#create-project)
+  - [Open existing project](#open-existing-project) -->
   - [Login](#login)
   - [Login by email](#login-by-email)
   - [Preview project](#preview-project)
@@ -23,12 +23,12 @@
 It's recommended to install `tmg` globally.
 
 ```
-npm install -g tt-ide-cli
+npm install -g tt-minigame-ide-cli
 ```
 
 ## Usage
 
-### Create Project
+<!-- ### Create Project
 
 Create a new blank miniprogram project with given name in current folder.
 
@@ -41,9 +41,9 @@ Options:
 
   -f, --force        Overwrite target directory if it exists
   -h, --help         Output usage information
-```
+``` -->
 
-### Open existing project
+<!-- ### Open existing project
 
 Open existing project with given path in microapp IDE.
 
@@ -53,7 +53,7 @@ If the path is not available, start up the IDE only.
 Usage: tmg open <project-path>
 
 Open target project by path
-```
+``` -->
 
 ### Login
 
@@ -96,9 +96,10 @@ 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
+  -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
@@ -114,6 +115,7 @@ 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
+  -u, --copy                  Copy remote url to clipboard
   -h, --help                   output usage information
+  -o, --output <path>          QRCode image output path
 ```

package/README.md

@@ -1,6 +1,6 @@
 # tmg-cli
 
-> `tmg` 是字节跳动小程序官方提供的命令行工具。
+> `tmg` 是字节跳动小小游戏官方提供的命令行工具。
 
 [English](./README.en.md)
 
@@ -9,11 +9,11 @@
 
 - [安装](#%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)
+  <!-- - [创建新项目](#%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)
+  - [预览小游戏](#%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 -->
@@ -23,12 +23,12 @@
 建议在全局安装 `tmg` 。
 
 ```
-npm install -g tt-ide-cli
+npm install -g tt-minigame-ide-cli
 ```
 
 ## 使用
 
-### 创建新项目
+<!-- ### 创建新项目
 
 在当前目录下，以给定的项目名字创建一个空白的小程序项目。
 
@@ -41,9 +41,9 @@ Options:
 
   -f, --force        Overwrite target directory if it exists
   -h, --help         Output usage information
-```
+``` -->
 
-### 打开已有项目
+<!-- ### 打开已有项目
 
 在小程序开发者工具中打开给定目录的项目。
 
@@ -53,7 +53,7 @@ Options:
 Usage: tmg open <project-path>
 
 Open target project by path
-```
+``` -->
 
 ### 登录
 
@@ -84,9 +84,9 @@ Options:
 
 ```
 
-### 预览小程序
+### 预览小游戏
 
-将项目上传后，扫码二维码来预览小程序。
+将项目上传后，扫码二维码来预览小游戏。
 
 ```
 Usage: tmg preview [options] [entry]
@@ -97,9 +97,10 @@ 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
+  -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
 ```
 
 ### 上传项目
@@ -115,6 +116,7 @@ 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
+  -u, --copy                  Copy remote url to clipboard
   -h, --help                   output usage information
+  -o, --output <path>          QRCode image output path
 ```

package/bin/tmg.js

@@ -15,50 +15,50 @@ 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));
-      }
-    });
-  });
+// 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);
-  });
+// 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
 
@@ -103,7 +103,7 @@ program
   .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('-u, --copy', 'Copy remote url to clipboard')
   .option('-p, --proxy <proxy>', 'Preview with proxy')
   .option('-o, --output <path>', 'QRCode image output path')
   .action((entry, cmd) => {
@@ -139,7 +139,7 @@ program
   )
   .requiredOption('-c, --app-changelog <log>', 'Changelog for this version')
   .option('-p, --proxy <proxy>', 'Update request proxy')
-  .option('-cp, --copy', 'Copy remote url to clipboard')
+  .option('-u, --copy', 'Copy remote url to clipboard')
   .option('-o, --output <path>', 'QRCode image output path')
   .action((entry, cmd) => {
     const options = cleanArgs(cmd);

package/lib/upload.js

@@ -17,7 +17,8 @@ const {
     uploadProject,
     getCompileProgress,
     checkUserPermissions,
-    getQrCode
+    getQrCode,
+    checkUploadVersion,
 } = require('./util/request');
 const {
     generateQrCode
@@ -50,6 +51,17 @@ async function upload(entry, options) {
         console.log(chalk.red(errMsg));
         throw new Error(errMsg);
     }
+
+    const {
+        success: checkVersionSuccess,
+        msg: checkVersionMsg,
+    } = await checkUploadVersion(appId, options.appVersion);
+    if (!checkVersionSuccess) {
+        const errMsg = `[CLI UPLOAD ERROR]: ${checkVersionMsg}`;
+        console.log(chalk.red(errMsg));
+        throw new Error(errMsg);
+    }
+
     const tempDir = options.tempDir || path.join(__dirname, '../temp');
     await fs.emptyDir(tempDir);
 

package/lib/util/helper.js

@@ -24,21 +24,19 @@ function mixEncode(data) {
 }
 
 async function zipFile(sourcePath, targetPath) {
-  const appJsonPath = path.join(sourcePath, 'app.json');
-  const isMiniProgram = await fs.pathExists(appJsonPath);
-  const subpackageInfoPath = path.join(sourcePath, `${isMiniProgram ? 'app.json' : 'game.json'}`);
+  const subpackageInfoPath = path.join(sourcePath,  'game.json');
   const projectConfigJson = fs.readJSONSync(subpackageInfoPath);
   const subPackagesArr = projectConfigJson.subPackages || projectConfigJson.subpackages;
   const zipFileRet = {
     filePath: null,
   };
   if (subPackagesArr && subPackagesArr.length > 0) {
-    const ifSubPackageUploadable = await verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath);
+    const ifSubPackageUploadable = await verifySubPackageSize(projectConfigJson, sourcePath);
     if (ifSubPackageUploadable) {
-      zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, isMiniProgram, true);
+      zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, true);
     }
   } else {
-    zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, isMiniProgram, false);
+    zipFileRet.filePath = await normalZipFile(sourcePath, targetPath, false);
   }
   return zipFileRet;
 }
@@ -46,7 +44,7 @@ async function zipFile(sourcePath, targetPath) {
 /**
  * @description 校验分包大小, 小游戏和小程序的不同在于子包不同
  */
-async function verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath) {
+async function verifySubPackageSize(projectConfigJson, sourcePath) {
   let subPackageTotalSize = 0; // 子包+主包
   // 做大小比较全拿字节数，精确
   const packageSizeConfig = {
@@ -56,7 +54,7 @@ async function verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath
   };
   // console.log('校验', projectConfigJson, packageSizeConfig);
   // 开放数据域文件校验，可以认为开放数据域也作为一个子包
-  if (isMiniProgram && projectConfigJson.openDataContext) {
+  if (projectConfigJson.openDataContext) {
     const openDataContextPath = path.join(sourcePath, projectConfigJson.openDataContext);
     const openDataContextSize = await getFolderSize(openDataContextPath);
     if (openDataContextSize > packageSizeConfig.subPackageSize) {
@@ -111,9 +109,9 @@ async function verifySubPackageSize(projectConfigJson, isMiniProgram, sourcePath
   return true;
 }
 
-async function normalZipFile(sourcePath, targetPath, isMiniProgram, isSubPackage) {
+async function normalZipFile(sourcePath, targetPath, isSubPackage) {
 
-  const packageSize = isMiniProgram ? 4 : 8;
+  const packageSize = 8;
   const zipPath = path.join(targetPath, `${path.basename(sourcePath)}.zip`);
   return new Promise(function (resolve, reject) {
     const output = fs.createWriteStream(zipPath);

package/lib/util/request.js

@@ -4,6 +4,7 @@ const querystring = require('querystring');
 const url = require('url');
 const fs = require('fs');
 const execa = require('execa');
+const compareVersions = require('compare-versions');
 const {
     getUserCookies
 } = require('./cookie');
@@ -32,8 +33,8 @@ axios.interceptors.request.use(config => {
     config.headers.Referer = REFERER;
     if (config.data instanceof FormData) {
         Object.assign(config.headers, config.data.getHeaders());
-      }
-    if(config.proxy) {
+    }
+    if (config.proxy) {
         const parseURL = URL.parse(config.proxy.host);
         config.httpsAgent = require('tunnel').httpsOverHttp({
             proxy: {
@@ -340,6 +341,7 @@ exports.checkUserPermissions = function (appId, proxy) {
         }
     });
 }
+
 // 该方法暂无调用
 exports.checkRemoteVersion = async function () {
     const registry = (await execa('npm', ['config', 'get', 'registry'])).stdout;
@@ -359,4 +361,27 @@ exports.checkRemoteVersion = async function () {
             msg: err.message
         }
     });
+}
+
+// 获取远程版本号
+exports.checkUploadVersion = async function (appId, version) {
+    try {
+        const res = await axios.get(`/api/apps/v3/meta?appid=${appId}&aid=13&version=current&ttcode=OVCNW/U0UREwv0sHdY9Rm16vBgGrCQIBOWurUCmJ1H6d/2XHLKeOYTYfEJIEeC0AOCwBZAR2j34C4tFN7Nqfq9tHVEpM4OuJM2b8qz0INtUs1qLhKFOtnGa9/Ey0WW86GGocJk074eP72MMhzNmePzaTQzXwn/eqEq4GHwyF2Tg=&t=${new Date().getTime()}`)
+        const current = res.data.data.version;
+        if (compareVersions(version, current) > 0) {
+            return {
+                success: true,
+            }
+        } else {
+            return {
+                success: false,
+                msg: `The version you uploaded must be greater than the current version ${current}.`,
+            }
+        }
+    } catch (err) {
+        return {
+            success: false,
+            msg: err.message
+        }
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tt-minigame-ide-cli",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.5",
   "description": "Command line interface for micro app development",
   "main": "lib/index.js",
   "bin": {
@@ -17,6 +17,7 @@
     "chalk": "^3.0.0",
     "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",

package/template/app.js

@@ -1,5 +0,0 @@
-App({
-  onLaunch: function () {
-
-  }
-})

package/template/app.json

@@ -1,11 +0,0 @@
-{
-  "pages":[
-    "pages/index/index"
-  ],
-  "window":{
-    "backgroundTextStyle":"light",
-    "navigationBarBackgroundColor": "#fff",
-    "navigationBarTitleText": "Mini Program",
-    "navigationBarTextStyle":"black"
-  }
-}

package/template/pages/index/index.js

@@ -1,10 +0,0 @@
-const app = getApp()
-
-Page({
-  data: {
-
-  },
-  onLoad: function () {
-    console.log('Welcome to Mini Program')
-  },
-})

package/template/pages/index/index.ttml

@@ -1 +0,0 @@
-<view class="intro">Welcome to Mini Program</view>

package/template/pages/index/index.ttss

@@ -1,4 +0,0 @@
-.intro {
-  margin: 30px;
-  text-align: center;
-}