lerna version v0.2.0

Author: nshen

.github/README.md

@@ -6,170 +6,165 @@
 
 ---
 
-<!-- # mini-shed -->
 
-
-
-<!-- 迷你屋是一个开放，高效的小游戏框架 -->
-
-<!-- ## Table of Contents
-
-- [koa-jwt](#koa-jwt)
-  - [Table of Contents](#table-of-contents)
-  - [Introduction](#introduction)
-  - [Install](#install)
-  - [Usage](#usage)
-    - [Retrieving the token](#retrieving-the-token)
-    - [Passing the secret](#passing-the-secret)
-    - [Checking if the token is revoked](#checking-if-the-token-is-revoked)
-  - [Example](#example)
-  - [Token Verification Exceptions](#token-verification-exceptions)
-  - [Related Modules](#related-modules)
-  - [Tests](#tests)
-  - [Author](#author)
-  - [Credits](#credits)
-  - [Contributors](#contributors)
-  - [License](#license) -->
-
-<!-- ## 简介
-
-`mini-shed` 是一枚高效，开放，易扩展的微信小游戏框架。 -->
-
-> mini-shed 正在独立开发中，有建议，想帮忙，想聊天的，都欢迎来骚扰我。[[联系方式]](https://nshen.net/about)
+> mini-shed 目前版本 v0.2，龟速独立开发中，有建议，想参与，想聊天的欢迎来[骚扰](https://nshen.net/about)。
 
 ## 特性
 
 - 基于前端流行技术 `TypeScript` 编写，`babel` + `rollup` 构建，用组合 `npm` 包的方式开发小游戏。
 - 在 `VSCode` 中开发，`Chrome`浏览器中实时刷新调试，秒编译到各个小游戏平台。
 - 可发布 Web版`H5小游戏`，`微信/QQ小游戏`， `头条/抖音小游戏`，`OPPO/VIVO小游戏` 等快游戏平台。
-- 迷你的`Entity-Component-System` 架构，数据驱动，简单高效，独立`System`自由组合，易于扩展。
-- 没用`Adapter库`，原生`WebGL`高速渲染，跨小游戏平台统一API，专注于`小且快`。
+- `Entity-Component-System` 架构，数据驱动，简单高效，独立`System`自由组合，易于扩展。
+- 专注于小且快，没用`Adapter库`，原生`WebGL`渲染，跨小游戏平台统一API。
 
-# 快速开始
+## 快速开始
 
-## 获取最新脚手架
+### 安装 `@shed/cli` 命令行工具
 
-```
-git clone https://github.com/nshen/shed.git myGame
+迷你屋使用 `@shed/cli` 来创建，编译小游戏。
 
-```
+- 用 npm 安装
 
-## 然后进入目录
+```bash
+npm install -g @shed/cli
 
-```
-cd myGame
+# 网络环境不好可安装淘宝镜像 cnpm，之后所有 npm 命令都用 cnpm 代替
+npm install -g cnpm --registry=https://registry.npm.taobao.org
+cnpm install -g @shed/cli
 ```
 
-## 安装 npm 依赖
+- 或用 yarn 安装
 
-```
-npm install
+```bash
+yarn global add @shed/cli
 ```
 
-## 简单一条命令即可编译出小游戏
+打开命令行输入 `shed` 回车，如果安装成功会有提示信息。
 
-```
-npm run build
-```
+### 创建一个新的小游戏
 
-## 打开微信小游戏开发工具，导入游戏，选择 `dist` 子目录即可
+```bash
+> shed create myGame  # 在当前目录下创建一个新游戏叫做 `myGame`
+```
+进入 `myGame` 目录，安装依赖
 
-![create mini game](./create_minigame.png)
+```bash
+> cd myGame
+> npm install # 或者 yarn install 
+```
 
-# 迷你ECS架构
+### 实时编译Web预览
 
-Entity Component System 是一个经典架构，`Shed.js` 根据JS语言特性实现了这个迷你版本
+在 `myGame` 目录中运行
 
-## Component
+```bash
+> shed build h5 --watch
+```
 
-`Component` **只有数据，没有方法。**  例如一个 `transform` 组件只是一个含 `type` 属性的 `Object` 。
+其他命令见 [@shed/cli](./packages/cli) 文档页
 
-```typescript
-  { type: 'transform', x: 0, y: 0, rotation: 180 }
-```
+## 项目结构
 
-## Entity
+整个项目是在 [Lerna](https://lerna.js.org/) 管理下的 monorepo。
 
+mini-shed 中的包是标准的 npm 包，可按需组合，并不局限在下边的包，可自行扩展。
 
-`Entity` 仅是一个有唯一 `id` 的**容器**，并且保存了一个 `Components` 表。
+#### 常用包
 
-例如一个添加了 `transform 组件` 与 `render 组件` 的 `Entity` **可以想象成** ：
+| Package | Status | Description |
+|---------|--------|-------------|
+| [@shed/cli]      | [![shed-cli-status]][@shed/cli-package]   | 命令行工具，主要用来创建，编译小游戏，还提供一些辅助功能 |
+| [@shed/ecs]      | [![shed-ecs-status]][@shed/ecs-package]   | 开放的 `Entity-Component-System` 系统实现 |
+| [@shed/math]     | [![shed-math-status]][@shed/math-package] | 数学支持库 Matrix，Vector 等|
+| [@shed/gl]       | [![shed-gl-status]][@shed/gl-package]     | 使`WebGL API` 简化的面向对象包装 |
+| [@shed/platform] | [![shed-platform-status]][@shed/platform-package] | 以微信小游戏为基准，统一各小游戏平台提供的`API`，并 `Promise` 化 |
+| [@shed/utils]    | [![shed-utils-status]][@shed/utils-package] |  一些实用类或函数 |
 
-```typescript
-let entity = {
-    id: 'Entity121',
-    components: {
-        'transform': { type: 'transform', x: 0, y: 0, rotation: 180 },
-        'render': { image:'sprite.png' }
-    }
-}
-```
+#### 默认demo包
 
-## System
+| Package | Status | Description |
+|---------|--------|-------------|
+| [@shed/starter]  | [![shed-starter-status]][@shed/starter-package] | 使用`shed create` 命令创建的默认demo |
 
-System **只有方法，不存数据。** 以下是一个自定义 `System` 的写法
 
-```typescript
+#### 新包模板
 
-import { System } from "@shed/ecs";
+创建一个新包可以基于此修改
 
-export class EmptySystem extends System {
+| Package | Status | Description |
+|---------|--------|-------------|
+| [@shed/new-package]  | [![shed-new-package-status]][@shed/new-package-package] | 一个配置好`typescript`, `babel`, `rollup` 的模板包 |
 
-    update() {
+#### Systems
 
-        // write you code here
-    }
-}
+`Entity Component System` 中的 `System` 可以独立成一个 `npm` 包存在，使得非常容易扩展。
 
-```
+| Project | Status | Description |
+|---------|--------|-------------|
+| [@shed/render2d-system]      | [![@shed/render2d-system-status]][@shed/render2d-system-package]   | 2d渲染系统，它会尽量把所有 Entity 打包在一起一次渲染 |
 
-一个 `System` 通常关注和操作一组指定类型的 `Entities`
 
-例如一个 `RenderSystem` 就应该只关注同时含有 `render` 与 `transform` 组件的 `Entities`。
+[@shed/render2d-system]: ./packages/render2d-system
+[@shed/render2d-system-status]: https://img.shields.io/npm/v/@shed/render2d-system.svg
+[@shed/render2d-system-package]: https://www.npmjs.com/package/@shed/render2d-system
 
-确实 [@shed/render-system](https://github.com/nshen/shed-render-system) 就是这么做的。
 
-这里可以看到，一个 `System` 可以发布成一个独立的 `npm包`。开发游戏时可以像拼插乐高一样按需安装系统。
+[@shed/cli]: ./packages/cli
+[@shed/ecs]: ./packages/ecs
+[@shed/math]: ./packages/math
+[@shed/gl]: ./packages/gl
+[@shed/platform]: ./packages/platform
+[@shed/utils]: ./packages/utils
+[@shed/starter]: ./packages/starter
+[@shed/new-package]: ./packages/new-package
 
-`npm install shed-xxx-system`
+[shed-cli-status]: https://img.shields.io/npm/v/@shed/cli.svg
+[shed-ecs-status]: https://img.shields.io/npm/v/@shed/ecs.svg
+[shed-math-status]: https://img.shields.io/npm/v/@shed/math.svg
+[shed-gl-status]: https://img.shields.io/npm/v/@shed/gl.svg
+[shed-platform-status]: https://img.shields.io/npm/v/@shed/platform.svg
+[shed-utils-status]: https://img.shields.io/npm/v/@shed/utils.svg
+[shed-starter-status]: https://img.shields.io/npm/v/@shed/starter.svg
+[shed-new-package-status]: https://img.shields.io/npm/v/@shed/new-package.svg
 
-这就是这个系统容易扩展的地方，更多信息请查看 [@shed/ecs](https://github.com/nshen/shed-ecs) 主页
+[@shed/cli-package]: https://www.npmjs.com/package/@shed/cli
+[@shed/ecs-package]: https://www.npmjs.com/package/@shed/ecs
+[@shed/math-package]: https://www.npmjs.com/package/@shed/math
+[@shed/gl-package]: https://www.npmjs.com/package/@shed/gl
+[@shed/platform-package]: https://www.npmjs.com/package/@shed/platform
+[@shed/utils-package]: https://www.npmjs.com/package/@shed/utils
+[@shed/starter-package]: https://www.npmjs.com/package/@shed/starter
+[@shed/new-package-package]: https://www.npmjs.com/package/@shed/new-package
 
 
 
+## `.github` 文件夹
 
-# 生态系统
+.github 文件夹内是 github actions ，用于发布`@shed/starter` 到国内镜像
 
-## 每个游戏都需要的核心库
+### 触发
 
-| Project | Status | Description |
-|---------|--------|-------------|
-| [@shed/ecs]      | [![shed-ecs-status]][@shed/ecs-package]   | 迷你 `Entity-Component-System` 系统 |
-| [@shed/math]     | [![shed-math-status]][@shed/math-package] | Matrix，Vector 等数学支持库 |
-| [@shed/gl]       | [![shed-gl-status]][@shed/gl-package]     | 让 `Webgl API` 更简洁的帮助库 |
+每次`push`源代码到 `github` 时，会触发此流程
 
+### 发布 starter 
 
+`github actions`会自动把 `/packages/starter` 目录 ，强推到 `coding.net` 和 `gitee.com` 以下项目地址
 
-[@shed/ecs]: https://github.com/nshen/shed-ecs
-[@shed/math]: https://github.com/nshen/shed-math
-[@shed/gl]:  https://github.com/nshen/shed-gl
+- https://shed.coding.net/p/mini-shed-starter
+- https://gitee.com/nshen/mini-shed-starter
 
-[shed-ecs-status]: https://img.shields.io/npm/v/@shed/ecs.svg
-[shed-math-status]: https://img.shields.io/npm/v/@shed/math.svg
-[shed-gl-status]: https://img.shields.io/npm/v/@shed/gl.svg
+使用`@shed/cli`命令行创建游戏时，实际上是从上边的地址clone下来的
 
-[@shed/ecs-package]: https://www.npmjs.com/package/@shed/ecs
-[@shed/math-package]: https://www.npmjs.com/package/@shed/math
-[@shed/gl-package]: https://www.npmjs.com/package/@shed/gl
+```bash
+shed create myGame 
+# 实际相当于 
+# git clone https://e.coding.net/shed/mini-shed-starter.git myGame
+```
 
-## Systems
+## Contributors
 
-| Project | Status | Description |
-|---------|--------|-------------|
-| [@shed/render-system]      | [![@shed/render-system-status]][@shed/render-system-package]   | 高效的 2D Batching 渲染系统 |
+* [nshen](https://github.com/nshen)
 
-[@shed/render-system]: https://github.com/nshen/shed-render-system
-[@shed/render-system-status]: https://img.shields.io/npm/v/@shed/render-system.svg
-[@shed/render-system-package]: https://www.npmjs.com/package/@shed/render-system
+## License
 
-目前 `System` 生态比较贫乏，期待你的加入。
+[The MIT License](http://opensource.org/licenses/MIT)

README.md

@@ -23,9 +23,17 @@ shed -h  # -h显示所有命令的 help 信息
 
 ## 用法
 
+安装成功之后即可在命令行中调用`shed`命令，`shed -h` 查看帮助。
+
 通常为 `shed` + `命令` + `--参数` 的方式使用命令行
 
-### 创建一个新游戏
+## 所有命令
+
+- `shed create <name>` [创建一个新的小游戏](###创建一个新的小游戏)
+- `shed build <platform>` [编译到小游戏平台](###编译到小游戏平台)
+- `shed spritesheet <folder>`   [创建一个`spritesheet`](###创建一个`spritesheet`)
+- `shed fnt <file>` [fnt 格式转 json](###fnt-格式转-json)                   
+### 创建一个新的小游戏
 
 ```bash
 > shed create myGame  # 在当前目录下创建一个新游戏叫做 `myGame`
@@ -59,12 +67,16 @@ shed -h  # -h显示所有命令的 help 信息
 
 通常调用后会发布到一个独立**文件夹**下，打开对应的**开发者工具**导入该**文件夹**，根据需要修改对应平台的参数。
 
-### 创建一个 `spritesheet`
+各平台不同，且在发展之中，但大同小异，具体参数还需参看各[小游戏平台参考文档](###小游戏平台参考文档)，做相应的修改。
+
+### 创建一个`spritesheet`
+
 
-此命令需要提前安装 `ImageMagick 6.X`
 
 命令为 `shed + spritesheet + 文件夹`
 
+>此命令需要提前安装 [`ImageMagick 6.X`](https://imagemagick.org/download/releases/)
+
 ```bash
 > shed spritesheet ./images   #将./images目录下所有图片打包成一个 spritesheet
 ```
@@ -82,10 +94,10 @@ shed fnt ./myfont.fnt  # 将./myfont.fnt 转换成 ./myfont.json
 shed -h
 ```
 
-## 小游戏平台文档
-
-OPPO https://open.oppomobile.com/wiki/doc#id=10516
+## 小游戏平台参考文档
 
+- OPPO https://open.oppomobile.com/wiki/doc#id=10516
+- 快应用 https://doc.quickapp.cn/framework/manifest.html
 
 ## Contributors
 
@@ -96,6 +108,5 @@ OPPO https://open.oppomobile.com/wiki/doc#id=10516
 [The MIT License](http://opensource.org/licenses/MIT)
 
 
-Build
-快应用 https://doc.quickapp.cn/framework/manifest.html
+
 

packages/cli/README.md

@@ -2,11 +2,11 @@ import * as fs from "fs-extra";
 import { Logger } from "../helpers/log";
 import path from 'path';
 import chalk from "chalk";
+import { shouldUseYarn } from "../helpers/should-use-yarn";
 
 const clone = require('git-clone');
 const ora = require('ora');
 
-
 let repositories: { [key: string]: string; } = {
     'coding': 'https://e.coding.net/shed/mini-shed-starter.git',
     'gitee': 'https://gitee.com/nshen/mini-shed-starter.git',
@@ -34,7 +34,7 @@ export async function create(name: string, r: string = 'coding') {
     clone(repo, name, async (err: any) => {
         if (err) {
             spinner.fail(`下载失败，请检查网络并重试。`);
-            spinner.fail(`从 ${chalk.cyan(r)} 下载失败，请检查网络，或尝试 shed create ${name} ${r === 'github' ? 'coding' : 'github'}`);
+            spinner.fail(`从 ${chalk.cyan(r)} 下载失败，请检查网络，或尝试 shed create ${name} ${r === 'gitee' ? 'coding' : 'gitee'}`);
             return;
         }
         try {
@@ -45,22 +45,22 @@ export async function create(name: string, r: string = 'coding') {
             console.error(error);
         }
         // TODO: copy to __dirname?
-        spinner.succeed(`成功在 ${path.join(process.cwd(), name)} 中创建了 ${chalk.cyan(name)} 项目！`);
-        console.log('在这个目录中，你可以调用以下命令：');
-        console.log();
-        console.log(chalk.cyan('  shed '));
+        spinner.succeed(`成功在 ${chalk.cyan(path.join(process.cwd(), name))} 中创建了 ${chalk.cyan(name)} 项目！`);
+        const useYarn = shouldUseYarn();
         console.log();
         console.log(`建议你现在输入：`);
-        console.log(chalk.cyan(`  cd ${name}`));
-        console.log(chalk.cyan(`  npm install`));
         console.log();
-        console.log('发布小游戏请使用');
-        Logger.command('npm run build');
+        Logger.command(`  cd ${name}`);
+        useYarn ? Logger.command(`  yarn install`) : Logger.command(`  npm install`);
+        console.log();
+        console.log('依赖安装后，可用以下命令预览小游戏：');
+        console.log();
+        useYarn ? Logger.command('yarn dev') : Logger.command('npm run dev');
     });
 
 }
 
-let thingsYouCanDo: string[] = ['喝杯水', '冲杯茶', '冲杯咖啡', '吃块糖', '直直腰', '起立走走', '眺望远方', '闭目养神', '到处逛逛'];
+const thingsYouCanDo: string[] = ['喝杯水', '冲杯茶', '冲杯咖啡', '吃块糖', '直直腰', '起立走走', '眺望远方', '闭目养神', '到处逛逛', '提臀5次'];
 function randomThing(): string {
     return thingsYouCanDo[Math.floor(Math.random() * thingsYouCanDo.length)];
 }

packages/cli/src/commands/create.ts

@@ -8,6 +8,7 @@ export class Logger {
     }
 
     static command(str: string) {
-        console.log(chalk.blue.bold(str));
+        // console.log(chalk.blue.bold(str));
+        console.log(chalk.cyan(str)) 
     }
 }

packages/cli/src/helpers/log.ts

@@ -59,12 +59,11 @@ program.parse(process.argv);
 if (process.argv.length <= 2) {
 
     console.log(chalk.cyan(figlet.textSync('mini-shed', { horizontalLayout: 'full' })));
-    console.log('感谢尝试 mini-shed 小游戏框架 < https://github.com/nshen/mini-shed >');
-    // console.log('https://github.com/nshen/mini-shed/issues');
-    console.log('有任何问题请入QQ群：431085380');
-    console.log('shed -h 可显示更多帮助信息');
-    console.log('--------------------------\n');
-
+    console.log('感谢尝试 ' + chalk.cyan('mini-shed v' + pkg.version) + ' 小游戏框架');
+    console.log('有问题请到此留言：', chalk.cyan('<https://github.com/nshen/mini-shed/issues>'));
+    console.log(chalk.cyan('shed -h') + ' 可显示更多帮助信息');
+    console.log();
+    // console.log('----------------------------------------------------\n');
     // program.help();
 } else {
     // clear();

packages/cli/src/index.ts

@@ -4,6 +4,7 @@
   "description": "examples of @shed/gl",
   "module": "dist/gl-examples.es.js",
   "types": "dist/index.d.ts",
+  "private": true,
   "files": [
     "dist"
   ],

packages/gl-examples/package.json

@@ -1,6 +1,6 @@
 # MathUtils 
 
-提供数学常用函数，与常量。
+提供数学常用函数与常量。
 
 ## 常数
 

packages/math/docs/mathUtils.md

@@ -1,6 +1,6 @@
 # @shed/platform
 
-:hammer: 以微信小游戏为基准，统一各小游戏平台提供的`API` ，并 `Promise` 化，
+:hammer: 以微信小游戏为基准，统一各小游戏平台提供的`API`，并 `Promise` 化
 
 各个小游戏平台均实现了 `IPlatform` 接口
 

packages/platform/README.md

@@ -1,7 +1,7 @@
 {
   "name": "@shed/starter",
   "version": "0.2.0",
-  "description": "mini-shed starter",
+  "description": "mini-shed 小游戏示例项目",
   "module": "dist/mini-game.es.js",
   "keywords": [
     "mini-game",