near-syn

near-syn 是一个库和命令行工具，旨在简化 NEAR 协议的合约开发。它利用 Rust 的 syn 生成 TypeScript 绑定和 Markdown 文档。

near-syn 命令行工具包含两个子命令

• ts 从 Rust 源文件生成 TypeScript 绑定。
• md 从 Rust 源文件生成 Markdown 文档。

有关更多详细信息，请参阅 near-syn --help。

安装

要安装 near-syn 命令行工具，请使用

cargo install near-syn

或者，您可以直接从 GitHub 安装它（请参阅更多 install 选项）

cargo install --git https://github.com/acuarica/near-syn --branch main

用法

near-syn ts 工具从一组 Rust 源文件中提取，并输出生成的 TypeScript 绑定。

near-syn ts path/to/src/lib.rs > src/contract.ts

同样，near-syn md 工具从一组 Rust 源文件中提取，并输出生成的 Markdown 文档。

near-syn md path/to/src/lib.rs > path/to/README.md

发布

我们使用 cargo-release 来验证、发布和标记新版本。首先，安装

cargo install cargo-release

确保您已使用 cargo 登录

cargo login

进行试运行

cargo release --verbose [LEVEL]

要实际发布、标记和发布新版本，请运行

cargo release --verbose --execute [LEVEL]

其中 [LEVEl] 是用于获取新版本的 bump 级别 的增量。例如

cargo release --verbose --execute patch