Flutter插件beyond_cli的安装与使用方法详解

beyond_cli 是一个用于 beyond 框架的命令行工具。它可用于多种 beyond 项目操作，包括：

1. 初始化 beyond 项目。
2. 从 JSON 文件生成模型。
3. 创建 beyond 模型（modelv2）。
4. 创建控制器（WIP 🚧）。
5. 创建用例（WIP 🚧）。
6. 创建异常（WIP 🚧）。

安装 🚀

要安装 beyond_cli，只需运行以下命令：

dart pub global activate beyond_cli

然后运行以下命令检查是否已成功安装 beyond_cli：

beyond -v

初始化 beyond 项目

项目名称只能是一个单词，或者使用蛇形命名法，例如 example_project：

beyond create project_name

示例

假设我们要创建一个名为 my_project 的项目：

beyond create my_project

执行后，beyond_cli 会在当前目录下创建一个名为 my_project 的文件夹，并初始化一个基本的 beyond 项目结构。

从 JSON 文件生成模型

要从 JSON 文件生成模型，可以使用以下命令：

beyond generate model <ClassName> --path <path to file> --suffix

• <ClassName> 将作为类名的第一部分，同时会转换为蛇形命名法（snake_case）作为文件名。
• --suffix 是可选参数，当使用时，必须跟随所需的前缀，例如 --suffix Model，这样生成的模型将带有指定的后缀。

参数说明

• <ClassName>: 指定生成的类名。
• --path: 指定包含 JSON 数据的文件路径。
• --suffix: 可选参数，用于添加后缀。

示例

假设我们有一个 JSON 文件 data.json，内容如下：

{
  "name": "John",
  "age": 30,
  "isStudent": false
}

我们希望生成一个名为 UserModel 的模型，使用后缀 Model：

beyond generate model User --path data.json --suffix Model

执行后，beyond_cli 会在当前目录下生成一个名为 user_model.dart 的文件，内容如下：

class UserModel {
  String name;
  int age;
  bool isStudent;

  UserModel({
    required this.name,
    required this.age,
    required this.isStudent,
  });

  factory UserModel.fromJson(Map<String, dynamic> json) {
    return UserModel(
      name: json['name'],
      age: json['age'],
      isStudent: json['isStudent'],
    );
  }

  Map<String, dynamic> toJson() => {
        'name': name,
        'age': age,
        'isStudent': isStudent,
      };
}

创建 beyond 模型（modelv2）

要创建一个 beyond 模型（modelv2），可以使用以下命令：

beyond generate model <ClassName>

示例

假设我们要创建一个名为 Product 的模型：

beyond generate model Product

执行后，beyond_cli 会在当前目录下生成一个名为 product.dart 的文件，内容如下：

class Product {
  String id;
  String name;
  double price;

  Product({
    required this.id,
    required this.name,
    required this.price,
  });

  factory Product.fromJson(Map<String, dynamic> json) {
    return Product(
      id: json['id'],
      name: json['name'],
      price: json['price'],
    );
  }

  Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'price': price,
      };
}