junobuild-didc 0.2.0

A CLI tool for generating JavaScript or TypeScript content from a DID file using the didc tool.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# JunoBuild-Didc

`junobuild-didc` is a CLI tool for generating JavaScript, TypeScript, or DID output from a Candid `.did` file using the [didc](https://github.com/dfinity/candid) tool.

This utility is designed to be integrated in Juno's CLI.

## Installation

You can install `junobuild-didc` globally using Cargo by running:

```bash
cargo install junobuild-didc
```

## Usage

You can use the `junobuild-didc` command to generate JavaScript or TypeScript bindings from a DID file.

```bash
junobuild-didc --input <input_file.did> --target <js|ts> [--output <output_file>]
```

### Example

```bash
junobuild-didc --input ./path/to/interface.did --target ts --output ./generated/output.ts
```

- `--input` or `-i`: Path to the `.did` file.
- `--target` or `-t`: Choose either `js` for JavaScript or `ts` for TypeScript output.
- `--output` or `-o`: (Optional) Specify the output file. If omitted, the generated content will be printed to the console.

## Development

### Building from Source

If you want to build the tool from the source, you can clone the repository and build it yourself.

```bash
git clone https://github.com/junobuild/didc
cd didc
cargo build --release
```

Once built, the binary will be located in `target/release`. You can run it from the root directory:

```bash
./target/release/junobuild-didc --help
```

This will display the available commands and usage instructions.

### Running Tests

You can run the tests with:

```bash
cargo test
```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.