candid_dart_cli 1.1.5

Provide a command-line tool for handing `.did` files and quickly generate Dart code corresponding to the `.did` file.

Candid Dart CLI

English | 简体中文

Provide a command-line tool for handing .did files and quickly generate Dart code corresponding to the .did file.

The generated code includes:

• IDL
• Service and related methods
• Object corresponding to the .did file and related methods

The generated code depends on agent_dart

• Quick Start
  • Install CLI
  • Run CLI
• CLI Options
• License

Quick Start

Install CLI

dart pub global activate candid_dart_cli

Run CLI

did2dart -d ./ -r

CLI Options

-p, --path                           Specify the path of the `.did` file.
-i, --inject-packages                Import packages with settings into each generated Dart file.
-b, --pre-actor-call                 Inject a piece of code before calling the Actor method, which can reference the request parameters `request` and the parameter of type CanisterActor `actor`.
-a, --post-actor-call                Inject a piece of code after calling the Actor method, which can reference the request parameters `request`, the parameter of type CanisterActor `actor`, and the return result of the method `response`.
-d, --dir                            Specify the directory where the `.did` file is located.
-r, --recursive                      Whether to recursively search for `.did` files, only valid when specifying a directory.
-f, --freezed                        Whether to use `Freezed`.
-e, --equal                          Whether to generate `equals` and `hashCode` methods.
                                     (Enabled by default)
-c, --copy-with                      Whether to generate `copyWith` method.
                                     (Enabled by default)
-u, --make-collections-unmodifiable  Whether collection fields are unmodifiable, only valid when `Freezed` is enabled.
                                     (Enabled by default)
-h, --help                           View help options.

License

MIT License

Copyright (c) 2022 AstroxNetwork

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.