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

提供一个命令行工具来处理.did文件，并快速生成与.did文件对应的Dart代码。

生成的代码包括：

• IDL
• Service及其相关方法
• 对应于.did文件的对象及其相关方法

生成的代码依赖于 agent_dart

快速开始

安装CLI

dart pub global activate candid_dart_cli

运行CLI

did2dart -d ./ -r

CLI选项

-p, --path                           指定`.did`文件的路径。
-i, --inject-packages                将带有设置的包导入到每个生成的Dart文件中。
-b, --pre-actor-call                 在调用Actor方法之前注入一段代码，可以引用请求参数`request`和类型为CanisterActor的参数`actor`。
-a, --post-actor-call                在调用Actor方法之后注入一段代码，可以引用请求参数`request`，类型为CanisterActor的参数`actor`，以及方法的返回结果`response`。
-d, --dir                            指定`.did`文件所在的目录。
-r, --recursive                      是否递归搜索`.did`文件，只有在指定目录时才有效。
-f, --freezed                        是否使用`Freezed`。
-e, --equal                          是否生成`equals`和`hashCode`方法。
                                     (默认启用)
-c, --copy-with                      是否生成`copyWith`方法。
                                     (默认启用)
-u, --make-collections-unmodifiable  是否使集合字段不可修改，只有在启用`Freezed`时才有效。
                                     (默认启用)
-h, --help                           查看帮助选项。

许可证

MIT License

版权所有 (c) 2022 AstroxNetwork

特此免费获得一份本软件的副本，以及随附的文档文件（"软件"），以供任何目的使用，包括但不限于分发、复制、修改、合并、发布、分发、再许可和/或销售该软件的副本，并允许向其提供软件的人使用、复制、修改、合并、发布、分发、再许可和/或销售该软件。

以上版权声明和本许可声明必须包含在所有副本或实质性部分的软件中。

软件按"原样"提供，没有任何形式的明示或暗示保证，包括但不限于适销性、特定用途适用性和非侵权的保证。在任何情况下，作者或版权持有者都不应对因软件或软件的使用或其他交易而引起的任何索赔、损害或其他责任负责。

示例代码

假设我们有一个名为example.did的文件，内容如下：

service : example {
    add: (nat) -> ();
    get: () -> (nat);
}

我们可以使用candid_dart_cli生成相应的Dart代码：

did2dart -p ./example.did -d ./generated -r

这将在./generated目录下生成以下文件：

example.did.dart 文件内容：

// Generated by Candid Dart CLI

import 'package:agent_dart/agent_dart.dart';

class ExampleService {
  final Agent agent;

  ExampleService(this.agent);

  Future<void> add(int value) async {
    await agent.update('add', '(nat)', [value]);
  }

  Future<int> get() async {
    return (await agent.query('get', '()', [])) as int;
  }
}

class AddRequest {
  final int value;

  AddRequest({required this.value});

  Map<String, dynamic> toJson() => {'value': value};
}

class GetResponse {
  final int result;

  GetResponse(this.result);

  factory GetResponse.fromJson(Map<String, dynamic> json) =>
      GetResponse(json['result'] as int);
}

这样，我们就成功地使用candid_dart_cli生成了与example.did文件对应的Dart代码。