cargo-messages 0.0.8

package/README.md

@@ -0,0 +1,121 @@
+# cargo-messages
+
+**cargo-messages:** A streaming reader for JSON messages emitted from Cargo
+
+This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
+
+## Installing cargo-messages
+
+Installing cargo-messages requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
+
+You can install the project with npm. In the project directory, run:
+
+```sh
+$ npm install
+```
+
+This fully installs the project, including installing any dependencies and running the build.
+
+## Building cargo-messages
+
+If you have already installed the project and only want to run the build, run:
+
+```sh
+$ npm run build
+```
+
+This command uses the [cargo-cp-artifact](https://github.com/neon-bindings/cargo-cp-artifact) utility to run the Rust build and copy the built library into `./index.node`.
+
+## Exploring cargo-messages
+
+After building cargo-messages, you can explore its exports at the Node REPL:
+
+```sh
+$ npm install
+$ node
+> require('.').hello()
+"hello node"
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm install`
+
+Installs the project, including running `npm run build`.
+
+### `npm build`
+
+Builds the Node addon (`index.node`) from source.
+
+Additional [`cargo build`](https://doc.rust-lang.org/cargo/commands/cargo-build.html) arguments may be passed to `npm build` and `npm build-*` commands. For example, to enable a [cargo feature](https://doc.rust-lang.org/cargo/reference/features.html):
+
+```
+npm run build -- --feature=beetle
+```
+
+#### `npm build-debug`
+
+Alias for `npm build`.
+
+#### `npm build-release`
+
+Same as [`npm build`](#npm-build) but, builds the module with the [`release`](https://doc.rust-lang.org/cargo/reference/profiles.html#release) profile. Release builds will compile slower, but run faster.
+
+### `npm test`
+
+Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).
+
+## Project Layout
+
+The directory structure of this project is:
+
+```
+cargo-messages/
+├── Cargo.toml
+├── README.md
+├── index.node
+├── package.json
+├── src/
+|   └── lib.rs
+└── target/
+```
+
+### Cargo.toml
+
+The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.
+
+### README.md
+
+This file.
+
+### index.node
+
+The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the `"main"` key in `package.json`.
+
+Under the hood, a [Node addon](https://nodejs.org/api/addons.html) is a [dynamically-linked shared object](https://en.wikipedia.org/wiki/Library_(computing)#Shared_libraries). The `"build"` script produces this file by copying it from within the `target/` directory, which is where the Rust build produces the shared object.
+
+### package.json
+
+The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.
+
+### src/
+
+The directory tree containing the Rust source code for the project.
+
+### src/lib.rs
+
+The Rust library's main module.
+
+### target/
+
+Binary artifacts generated by the Rust build.
+
+## Learn More
+
+To learn more about Neon, see the [Neon documentation](https://neon-bindings.com).
+
+To learn more about Rust, see the [Rust documentation](https://www.rust-lang.org).
+
+To learn more about Node, see the [Node documentation](https://nodejs.org).

package/cjs/index.cjs

@@ -0,0 +1,50 @@
+const path = require("path");
+const { load, currentTarget } = require('@neon-rs/load');
+
+const {
+  fromStdin,
+  fromFile,
+  findArtifact,
+  findFileByCrateType
+} = load(path.join(__dirname, "..")) || require(`@cargo-messages/${currentTarget()}`);
+
+const PRIVATE = {};
+
+function enforcePrivate(nonce, className) {
+  if (nonce !== PRIVATE) {
+    throw new Error(`${className} constructor is private`);
+  }
+}
+
+class CargoArtifact {
+  constructor(nonce, kernel) {
+    enforcePrivate(nonce, 'CargoArtifact');
+    this._kernel = kernel;
+  }
+
+  findFileByCrateType(crateType) {
+    return findFileByCrateType(this._kernel, crateType);
+  }
+}
+
+class CargoMessages {
+  constructor(options) {
+    options = options || {};
+    this._mount = options.mount || null;
+    this._manifestPath = options.manifestPath || null;
+    this._kernel = options.file
+      ? fromFile(options.file, this._mount, this._manifestPath)
+      : fromStdin(this._mount, this._manifestPath);
+  }
+
+  findArtifact(crateName) {
+    const found = findArtifact(this._kernel, crateName);
+    return found
+      ? new CargoArtifact(PRIVATE, found)
+      : null;
+  }
+}
+
+module.exports = {
+  CargoMessages
+};

package/esm/index.js

@@ -0,0 +1,5 @@
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+
+export const CargoMessages = require("../cjs/index.cjs").CargoMessages;

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "cargo-messages",
+  "private": false,
+  "version": "0.0.8",
+  "description": "A streaming reader for JSON messages emitted from Cargo.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/esm/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "require": {
+        "types": "./types/cjs/index.d.ts",
+        "default": "./cjs/index.cjs"
+      }
+    }
+  },
+  "types": "./types/cjs/index.d.ts",
+  "main": "./cjs/index.cjs",
+  "files": [
+    "README.md",
+    "cjs/index.cjs",
+    "types/cjs/index.d.ts",
+    "esm/index.js",
+    "types/esm/index.d.ts"
+  ],
+  "scripts": {
+    "test": "cargo test",
+    "debug": "cargo build --message-format=json | neon dist",
+    "build": "cargo build --message-format=json --release | neon dist",
+    "cross": "cross build --message-format=json --release | neon dist -m /target",
+    "pack-build": "neon pack-build",
+    "prepack": "neon install-builds"
+  },
+  "author": "David Herman <david.herman@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@neon-rs/cli": "0.0.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dherman/neon-rs.git"
+  },
+  "keywords": [
+    "Rust",
+    "Neon"
+  ],
+  "bugs": {
+    "url": "https://github.com/dherman/neon-rs/issues"
+  },
+  "homepage": "https://github.com/dherman/neon-rs#readme",
+  "dependencies": {
+    "@neon-rs/load": "^0.0.5"
+  },
+  "neon": {
+    "targets": {
+      "x86_64-pc-windows-msvc": "@cargo-messages/win32-x64-msvc",
+      "aarch64-pc-windows-msvc": "@cargo-messages/win32-arm64-msvc",
+      "x86_64-apple-darwin": "@cargo-messages/darwin-x64",
+      "aarch64-apple-darwin": "@cargo-messages/darwin-arm64",
+      "x86_64-unknown-linux-gnu": "@cargo-messages/linux-x64-gnu",
+      "armv7-unknown-linux-gnueabihf": "@cargo-messages/linux-arm-gnueabihf",
+      "armv7-linux-androideabi": "@cargo-messages/android-arm-eabi"
+    }
+  },
+  "optionalDependencies": {
+    "@cargo-messages/android-arm-eabi": "0.0.8",
+    "@cargo-messages/darwin-arm64": "0.0.8",
+    "@cargo-messages/darwin-x64": "0.0.8",
+    "@cargo-messages/linux-arm-gnueabihf": "0.0.8",
+    "@cargo-messages/linux-x64-gnu": "0.0.8",
+    "@cargo-messages/win32-arm64-msvc": "0.0.8",
+    "@cargo-messages/win32-x64-msvc": "0.0.8"
+  }
+}

package/types/cjs/index.d.ts

@@ -0,0 +1,19 @@
+export type CrateType =
+  | 'dylib'
+  | 'cdylib'
+  | 'rlib';
+
+export interface CargoArtifact {
+  findFileByCrateType(crateType: CrateType): string | null;
+}
+
+export type CargoMessageOptions = {
+  mount?: string,
+  manifestPath?: string,
+  file?: string
+};
+
+export class CargoMessages {
+  constructor(options?: CargoMessageOptions);
+  findArtifact(crateName: string): CargoArtifact | null;
+}

package/types/esm/index.d.ts

@@ -0,0 +1,3 @@
+import { CrateType, CargoArtifact, CargoMessageOptions, CargoMessages } from '../cjs/index.d.ts';
+
+export { CrateType, CargoArtifact, CargoMessageOptions, CargoMessages };