1 个不稳定版本

0.100.0 2022年1月16日

#1368文件系统

每月下载量 29 次

MIT 许可证

5KB

metap

metap: (WIP) 元编程工具

该项目由 create-neon 引入。

安装 metap

安装 metap 需要 支持的 Node 和 Rust 版本

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

$ npm install

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

构建 metap

如果您已安装项目并只想运行构建,请运行

$ npm run build

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

探索 metap

构建 metap 后,您可以在 Node REPL 中探索其导出项。

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

可用脚本

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

npm install

安装项目,包括运行 npm run build

npm build

从源代码构建 Node 扩展(index.node)。

您可以将额外的 cargo build 参数传递给 npm buildnpm build-* 命令。例如,要启用 cargo 功能

npm run build -- --feature=beetle

npm build-debug

npm build 的别名。

npm build-release

npm build 相同,但使用 release 配置构建模块。发布构建将编译得更慢,但运行更快。

npm test

通过调用 cargo test 运行单元测试。您可以从 Rust 手册 中了解如何将测试添加到 Rust 代码中。

项目布局

该项目的目录结构如下

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

Cargo.toml

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

README.md

此文件。

index.node

节点插件——即由构建项目生成的二进制节点模块。这是本包的主模块,由 "main" 键在 package.json 中的指定。

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

package.json

NPM的清单文件,它通知npm命令。

src/

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

src/lib.rs

Rust库的主模块。

target/

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

了解更多

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

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

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

依赖项

~765KB
~15K SLoC