Flutter命令行工具插件objd_cli的使用

Flutter命令行工具插件objd_cli的使用

objD CLI

objD CLI 是一个附加包，用于处理项目的执行、构建和部署。要激活全局包（使其在系统上的任何位置可用），请运行以下命令：

dart pub global activate objd_cli

这将会将命令添加到您的控制台中。 要运行命令，请执行以下操作：

objd [command] [args]

或者

dart pub global run objd_cli [command] [args]

如果 objd 命令不可用，您需要将 pub 缓存添加到系统路径中。请遵循此教程：https://www.dartlang.org/tools/pub/cmd/pub-global#running-a-script-from-your-path

命令

• help - 打开包含所有命令的帮助菜单
• new [project_name] - 使用模板生成新项目
• run [project_root] - 构建一个项目
• serve [directory] [project_root] - 监视目录以进行更改，并在更改时重新构建项目
• server inject [jar-file] - 在启动服务器之前注入一个服务器文件（使用带有插件的 Bukkit 自动重新加载）（由于法律原因，该文件未包含在包中）
• server start [world_dir] - 将世界复制到服务器目录并启动服务器

构建选项

您可以使用某些参数将选项传递给构建方法。 此参数列表可以直接在 createProject 中编辑：

createProject(
	Project(...),
	["arg1","arg2", ... ] // 参数作为可选的 List
)

或者（我推荐的方式）您可以直接从 main 函数中获取程序参数：

void main(List<String> args) {
  createProject(
    Project(...),
    args
  );
}

这样可以在执行命令时使用参数，例如：

• dart index.dart arg1 --min
• objd run index.dart arg1 --min
• objd serve . index.dart --min

所有可用参数：

• --hotreload: 保存项目的状态，并仅比较最近的更改。
• --full: 生成完整的项目（仅适用于 objd serve）。
• --min: 通过忽略 .mcmeta 和 .tag 文件来减少文件数量。
• --gen: 使用此标志在 objd 之前运行 dart 的 build_runner，以应用所有必要的代码生成器。
• --clean: 轻松删除由 objD 生成的所有文件和文件夹，以便轻松清理垃圾。
• --prod: 这会为您的项目创建生产构建，并将其保存为压缩的数据包。
  在生产模式下，注释和换行符会被移除，并且每个小部件都可以在上下文中访问 prod 值以获得通知。
• --debug: 这会在项目根目录中创建一个调试 JSON 文件，列出所有属性和其他生成的文件。
• --zip: 创建 ZIP 存档而不是包含数据包内容的文件夹（默认在生产模式下）。
• --no-zip: 强制通常的文件夹输出而不是 ZIP。
• --useIsolates: 实验性选项，为每个文件系统操作启动单独的隔离（多线程），通常较慢。

热重载

热重载功能是一个实验性功能，它仅检查自上次构建以来的更改内容。这对于具有许多生成的 .mcfunction 文件的大项目来说可以显著提高性能。

对于 objd serve，如果包含参数，则默认启用此功能。您可以使用 --full 参数禁用它。

如何工作：

objD 在项目的 objd.json 文件中保存项目的表示形式。 对于每次新的构建或重新加载，它都会检查项目的哪些部分发生了变化，并仅生成必要的新文件以在数据包中实现更改。

完整示例 DEMO

以下是一个完整的示例，展示如何使用 objd_cli 插件：

1. 安装插件

   dart pub global activate objd_cli
   

2. 创建新项目

   objd new my_project
   

3. 运行项目

   objd run my_project --prod
   

4. 监视项目目录并自动重新构建

   objd serve . my_project --hotreload
   

5. 生成调试文件

   objd run my_project --debug
   

6. 生成生产版本并打包为 ZIP

   objd run my_project --prod --zip