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

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

Avila Tek Mobile Open Source (ATMOS) CLI

---

`atmos_cli` 是一个基于 `very_good_cli` 的命令行工具，专门为 Avila Tek 移动项目提供了额外的功能。

### 特殊功能

截至目前，`atmos_cli` 几乎与 `very_good_cli` 相同，但具有以下额外功能：

1. **创建 Flutter 应用**：它使用 `atmos_core` 模板，这与 `very_good_core` 稍有不同。
2. **扩展设置过程**：
    - 使用 FVM 设置最新稳定的 Flutter 版本。
    - 运行 `mason get` 并生成在项目中使用的基础砖块：`avilatek_readme`、`avila_codemagic`、`bootstrap_go_routes` 和 `avila_themes`。
    - 提示用户设置 Firebase。这是 `atmos` 中最方便的功能！它将为所有环境（开发、预发布和生产）设置 Firebase，并配置 Dart、Android 和 iOS 的 Firebase 配置文件。在 iOS 中，会创建一个包含每个 `GoogleService-Info.plist` 文件的配置文件夹，并添加一个构建阶段脚本来使用正确的文件。在 Dart 中，会创建一个 `firebase_config.dart` 文件，其中包含每个环境的正确配置。这对开发者来说是一个巨大的时间节省！
    - 最后，添加必要的依赖项并修复 Dart 分析问题。

### 文档 📝

官方文档请访问 [https://cli.vgv.dev](https://cli.vgv.dev)。

### 快速开始 🚀

#### 安装 🧑‍💻

```sh
dart pub global activate atmos_cli

或者安装特定版本：

dart pub global activate atmos_cli <version>

如果尚未设置路径，可能需要 设置路径。

在无法设置路径的情况下（例如 CI 环境），可以通过以下方式运行 atmos 命令：

dart pub global run atmos_cli:atmos <command> <args>

命令 ✨

atmos create

创建基于提供的模板的非常良好的项目。每个模板都有一个对应的子命令（例如，atmos create flutter_app 将生成一个 Flutter 启动应用）。

# 创建一个新的 Flutter 应用名为 my_app
atmos create flutter_app my_app

# 创建一个新的 Flutter 应用名为 my_app，带有一个自定义组织
atmos create flutter_app my_app --desc "My new Flutter app" --org "com.custom.org"

# 创建一个新的 Flutter 应用名为 my_app，带有一个自定义应用 ID
atmos create flutter_app my_app --desc "My new Flutter app" --application-id "com.custom.app.id"

# 创建一个新的 Flame 游戏名为 my_game
atmos create flame_game my_game --desc "My new Flame game"

# 创建一个新的 Wear OS 应用名为 my_wear_app
atmos create flutter_app my_wear_app --desc "My new Wear OS app" --template wear

# 创建一个新的 Flutter 包名为 my_flutter_package
atmos create flutter_package my_flutter_package --desc "My new Flutter package"

# 创建一个新的 Dart 包名为 my_dart_package
atmos create dart_package my_dart_package --desc "My new Dart package"

# 创建一个新的 Dart 包名为 my_dart_package，可发布
atmos create dart_package my_dart_package --desc "My new Dart package" --publishable

# 创建一个新的 Dart CLI 应用名为 my_dart_cli
atmos create dart_cli my_dart_cli --desc "My new Dart CLI package"

# 创建一个新的 Dart CLI 应用名为 my_dart_cli，带有一个自定义可执行文件名
atmos create dart_cli my_dart_cli --desc "My new Dart CLI package" --executable-name my_executable_name

# 创建一个新的 Flutter 插件名为 my_flutter_plugin（所有平台启用）
atmos create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin"

# 创建一个新的 Flutter 插件名为 my_flutter_plugin（仅某些平台）
atmos create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms android,ios,macos

# 创建一个新的文档站点名为 my_docs_site
atmos create docs_site my_docs_site

atmos test

在 Dart 或 Flutter 项目中运行测试。

# 运行所有测试
atmos test

# 运行所有测试并收集覆盖率
atmos test --coverage

# 运行所有测试并强制 100% 覆盖率
atmos test --coverage --min-coverage 100

# 仅运行位于 ./some/other/directory 的测试
atmos test ./some/other/directory

# 递归运行测试
atmos test --recursive

# 递归运行测试（快捷方式）
atmos test -r

atmos packages get

在 Dart 或 Flutter 项目中获取包。

# 在当前目录安装包
atmos packages get

# 在 ./some/other/directory 安装包
atmos packages get ./some/other/directory

# 递归安装包
atmos packages get --recursive

# 递归安装包（快捷方式）
atmos packages get -r

atmos packages check licenses

检查 Dart 或 Flutter 项目中的包许可证。

# 在当前目录检查许可证
atmos packages check licenses

# 仅允许使用某些许可证
atmos packages check licenses --allowed="MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0"

# 拒绝使用某些许可证
atmos packages check licenses --forbidden="unknown"

# 检查某些依赖类型的许可证
atmos packages check licenses --dependency-type="direct-main,transitive"

atmos --help

查看完整的命令列表和使用信息。

🦄 A Very Good Command-Line Interface

Usage: atmos <command> [arguments]

Global options:
-h, --help            Print this usage information.
    --version         Print the current version.
    --[no-]verbose    Noisy logging, including all shell commands executed.

Available commands:
  create     atmos create <subcommand> <project-name> [arguments]
             Creates a new very good project in the specified directory.
  packages   Command for managing packages.
  test       Run tests in a Dart or Flutter project.
  update     Update Very Good CLI.

Run "atmos help <command>" for more information about a command.

完整示例

以下是如何使用 atmos_cli 创建一个新的 Flutter 应用的完整示例：

# 激活 Very Good CLI
dart pub global activate atmos_cli

# 查看可用命令列表
atmos --help

# 创建一个新的 Flutter 应用名为 my_app
atmos create flutter_app my_app

# 运行所有测试
atmos test