Truffle 5 手册:Truffle Box API

Truffle Box概述

Truffle Box是Truffle提供的预定义项目模板。要创建一个Truffle Box需要 以下工作:

  • 一个Github仓库
  • 一个配置文件
  • 可选的,一大一小两个图像用于在官网展示你的Box 配置文件和图像文件应当放在你的box仓库的顶级目录。当Github仓库中这些文件 就绪的情况下,下面的unbox命令就可以安装你的box:
truffle unbox {USER_NAME || ORG_NAME}/{REPO_NAME}

如果你是从零开始制作box,我们已经创建了一个蓝图项目,其中的配置文件包含了 常用的设置,以及大小两个图像文件。

如果你使用已有的项目,那么从这里下载文件然后解压到你的项目中。

Truffle Box 配置文件

所有的truffle box都需要一个配置文件,名称为truffle-box.json。这个文件包含三个属性:ignore、commands和hooks。

ignore

ignore属性用来表示在解开盒子(unboxing)时需要忽略的文件路径。常见的包括readme.md或.gitignore。 在unboxing时在ignore中声明的文件将不会拷贝到目标文件夹。

"ignore": [ "README.md", ".gitignore" ]

commands

commands属性是一个包含可用的控制台命令的对象,键为描述,值为控制台命令。 一旦成功解开盒子,这些键值对将显示给用户。可将其视为快速帮助信息。

例如,下面的示例不仅给用户提供编译、迁移和测试智能合约的命令,同时还提供了 开发前端的命令:

"commands": {
  "Compile": "truffle compile",
  "Migrate": "truffle migrate",
  "Test contracts": "truffle test",
  "Test dapp": "npm test",
  "Run dev server": "npm run start",
  "Build for production": "npm run build"
}

hooks

hooks对象包含了解开盒子时需要执行的命令。由于我们使用Node.js,因此 大多数情况下这里包含的都是npm install:

"hooks": {
  "post-unpack": "npm install"
}

Truffle Box图像规范

大图像

Truffle Box要求大图像为348 x 348像素正方形,每边20px留空: 如果没有指定图像文件,我们将使用包含Truffle Logo的默认图像:

小图像为

小图像为 510 x 100像素,左侧20像素留空,最小宽度330像素,包括左侧留空。 banner固定于左侧,当窗口变窄时将自动裁剪右侧: 如果没有指定图像文件,我们将使用包含Truffle Logo的默认banner:

Truffle Box发布流程

在将你的Box发布到Truffle官网之前,我们需要进行必要的筛选以确保与Truffle 的兼容。为了启动这个筛选流程,请发邮件给info@trufflesuite.com,并在邮件 中说明你的box名称、简要描述以及你的Github仓库的链接。

全部评论(0)
给作者留言