node-macos-name-uuid

node-macos-name-uuid: A native Node.js module to get macOS computer name and the hardware UUID

This project was bootstrapped by create-neon.

Building node-macos-name-uuid

Building node-macos-name-uuid requires a supported version of Node and Rust.

To run the build, run:

$ npm run build

This command uses the @neon-rs/cli utility to assemble the binary Node addon from the output of cargo.

Example

After building node-macos-name-uuid, you can use it as a normal CommonJS module:

const { getComputerName, getHardwareUuid } = require('node-macos-name-uuid');
console.log(getComputerName());
console.log(getHardwareUuid());

Available Scripts

In the project directory, you can run:

npm install

Installs the project, including running npm run build.

npm run build

Builds the Node addon (index.node) from source, generating a release build with cargo --release.

Additional cargo build arguments may be passed to npm run build and similar commands. For example, to enable a cargo feature:

npm run build -- --feature=beetle

You can also specify :x86_64 or :arm64 to specify target arch.

npm run debug

Similar to npm run build but generates a debug build with cargo.

npm test

Runs the unit tests by calling cargo test. You can learn more about adding tests to your Rust code from the Rust book.

Project Layout

The directory structure of this project is:

node-macos-name-uuid/
├── Cargo.toml
├── README.md
├── src/
|   └── lib.rs
├── index.node
├── package.json
└── target/

| Entry | Purpose | |----------------|------------------------------------------------------------------------------------------------------------------------------------------| | Cargo.toml | The Cargo manifest file, which informs the cargo command. | | README.md | This file. | | src/ | The directory tree containing the Rust source code for the project. | | lib.rs | Entry point for the Rust source code. | | index.node | The main module, a Node addon generated by the build and pointed to by "main" in package.json. | | package.json | The npm manifest file, which informs the npm command. | | target/ | Binary artifacts generated by the Rust build. |