创建一个盒子
要创建一个 TronBox 盒子,你需要一些东西:
- 一个 GitHub 存储库
- 一个配置文件
配置文件应当放在你仓库的顶级目录。有了这些文件,以及你在 GitHub 上的仓库,unbox 命令为:tronbox unbox {USER_NAME || ORG_NAME}/{REPO_NAME}
配置文件
所有 TronBox 盒子都包含一个配置文件,tronbox.json. 该文件具有三个属性:ignore
, commands
和 hooks
。
ignore
(array)
ignore
(array)TronBox 在解开盒子(unbox)时忽略的文件或相对路径的数组。常见文件包括 readme.md
或 .gitignore
。这些文件在解开盒子时不会从 盒子的仓库中复制过来。
"ignore": [
"README.md",
".gitignore"
]
commands
(object)
commands
(object)一个对象,其键和值对分别是描述和控制台命令。一旦成功解开盒子,这些键值对将显示给用户。可将这些视为快速介绍。
例如,下面的示例不仅给用户提供编译、迁移和测试智能合约的命令,同时还提供了开发前端的命令。
"commands": {
"Compile": "tronbox compile",
"Migrate": "tronbox migrate",
"Test contracts": "tronbox test",
"Test dapp": "npm test",
"Run dev server": "npm run start",
"Build for production": "npm run build"
}
hooks
(object)
hooks
(object)一个对象,其中包含在解开盒子后执行的控制台命令。由于我们使用 Node.js,因此最常见的是包含 npm install
。
"hooks": {
"post-unpack": "npm install"
}