file-tree

此项目由 create-neon 引导。

安装 file-tree

安装 file-tree 需要 支持的 Node 和 Rust 版本。

您可以使用 npm 安装项目。在项目目录中运行

$ npm install

这将完全安装项目，包括安装任何依赖项和运行构建。

构建 file-tree

如果您已经安装了项目并且只想运行构建，请运行

$ npm run build

此命令使用 cargo-cp-artifact 工具运行 Rust 构建，并将构建的库复制到 ./index.node。

探索 file-tree

构建 file-tree 后，您可以在 Node REPL 中探索其导出项

$ npm install
$ node
> require('.').hello()
"hello node"

可用脚本

在项目目录中，您可以运行

npm install

安装项目，包括运行 npm run build。

npm build

从源构建 Node 插件（index.node）。

npm test

通过调用 cargo test 运行单元测试。您可以从 Rust 书籍 中了解更多关于 将测试添加到 Rust 代码 的信息。

项目布局

此项目的目录结构如下

file-tree/
├── Cargo.toml
├── README.md
├── index.node
├── package.json
├── src/
|   └── lib.rs
└── target/

Cargo.toml

Cargo 清单文件，它通知 cargo 命令。

README.md

此文件。

index.node

由构建项目生成的 Node 插件——即二进制 Node 模块。这是此包的主模块，由 package.json 中的 "main" 键指定。

在底层，一个 Node 插件 是一个 动态链接共享对象。构建脚本通过从 target/ 目录复制它来生成此文件，这是 Rust 构建生成共享对象的位置。

package.json

npm 清单文件，它通知 npm 命令。

src/

包含项目 Rust 源代码的目录树。

src/lib.rs

Rust 库的主模块。

target/

Rust 构建生成的二进制工件。

了解更多

要了解更多关于 Neon 的信息，请参阅 Neon 文档。

要了解更多关于 Rust 的信息，请参阅 Rust 文档。

要了解更多关于 Node 的信息，请参阅 Node 文档。