# cmake-node > node.js toolchain for cmake Latest version **0.2.0** (published 2021-10-26) · MIT license · 0 weekly downloads ## Install ```sh npm install cmake-node pnpm add cmake-node yarn add cmake-node bun add cmake-node ``` Provides the command `cmake-node`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.0 | | Published | 2021-10-26 | | First published | 2020-07-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8.0.0 | | Dependencies | 0 | | Unpacked size | 93.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | Christopher Jeffrey | | Maintainers | chjj | | Keywords | build, cmake, gyp | ## Links - npm: https://www.npmjs.com/package/cmake-node - Repository: https://github.com/chjj/cmake-node - Issues: https://github.com/chjj/cmake-node/issues - npm.io page: https://npm.io/package/cmake-node ## Alternatives - [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads - [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads - [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads - [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads - [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads ## Recent versions - 0.2.0 (latest) — 2021-10-26 - 0.1.1 — 2020-07-25 - 0.1.0 — 2020-07-25 - 0.0.16 — 2020-07-23 - 0.0.15 — 2020-07-22 - 0.0.14 — 2020-07-21 - 0.0.13 — 2020-07-21 - 0.0.12 — 2020-07-21 - 0.0.11 — 2020-07-20 - 0.0.10 — 2020-07-20 - 0.0.9 — 2020-07-20 ## README # cmake-node Node.js build system on top of CMake. ## Features - No node.js dependencies - No network IO (no downloading headers or import libraries) - MinGW support for cross-compiling to Windows - WASM support (see below for an explanation) ## Todo - [osxcross] support for cross-compiling to Darwin ## Design cmake-node provides an include file and an accompanying wrapper for CMake. In contrast to other projects, it avoids modification of the global state, and instead exposes just two functions: `add_node_library` and `add_node_module`. cmake-node is very lightweight and requires no dependencies. This provides a nice alternative to other node build systems, which pull in half of npm just to build a project. The latest NAPI headers are bundled and automatically added to your include paths. While there is a chance cmake-node could fall behind in updating these headers, it should not be that severe of a issue as NAPI provides a stable ABI. Support for other node headers (v8, node, openssl, nan, etc) is intentionally excluded for this reason. While cmake-node requires no _node.js_ dependencies, it does require that the user have certain other dependencies: this includes CMake itself, Visual Studio on Windows, Xcode on OSX, and Make on unix. ## Example CMakeLists.txt: ``` cmake project(my_project LANGUAGES C) include(NodeJS) add_node_library(my_library STATIC src/my_lib.c) add_node_module(my_project src/my_code.c) target_compile_definitions(my_project PRIVATE FOOBAR=1) target_link_libraries(my_project PRIVATE my_library) ``` To build: ``` sh $ cmake-node rebuild ``` To load (CJS): ``` js const cmake = require('cmake-node'); const binding = cmake.load('my_project', __dirname); ``` To load (ESM): ``` js import cmake from 'cmake-node'; const binding = cmake.load('my_project', import.meta.url); ``` ## Building for production cmake-node commands accept a `--production` flag which will clean the workspace for release. This removes all files generated during the build aside from your resulting `.node` file. ``` sh $ cmake-node rebuild --production ``` It is recommended to put this in your package.json's `install` script. ## MinGW Support cmake-node allows native modules to be cross-compiled for win32 using the mingw toolchain. ``` sh $ cmake-node rebuild --mingw --arch=x64 ``` The prefixed mingw toolchain must be in your `PATH`. ## WASM Support A while ago, some node.js contributors had the brilliant idea of [exposing NAPI to WASM][wasm-napi]. In theory, this means you can cross-compile your NAPI module to WASM and have it work transparently. Combined with WASI, this means only minimal (or no) changes need to be made to your code. cmake-node has experimental support for this. ``` sh $ cmake-node rebuild --wasm --wasi-sdk=/path/to/wasi-sdk ``` This feature requires wasi-sdk 12 or above as it requires reactor support (i.e. `-mexec-model=reactor`). You can find a proof-of-concept WASM NAPI module [here][napi-module] (credit to @devsnek). ## Usage ``` Usage: cmake-node [options] [command] -- [cmake args] Options: -v, --version output the version number -c, --config build type (default: Release) -C, --cmake path to cmake binary (default: cmake{,.exe}) -r, --root path to root directory (default: .) -p, --production clean all files except for .node files --node-bin name of node binary (win32 only) --node-def path to node.def (win32 only) --node-lib path to node.lib (win32 only) --node-exp path to node.exp/libnode.x (aix/zos only) --mingw cross-compile for win32 using mingw --wasm cross-compile for wasm using wasi-sdk --toolchain path to toolchain file -G, --gen generator name (see cmake --help) -A, --arch select win32 arch (ia32, x64, arm, arm64) --wasi-sdk path to wasi-sdk -h, --help output usage information Commands: install install necessary files list list currently installed files clear clear cache configure configure package build build package clean clean root directory reconfigure reconfigure package rebuild rebuild package ui open ui for package (ccmake/cmake-gui) ``` ## Contribution and License Agreement If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work. `` ## License - Copyright (c) 2020, Christopher Jeffrey (MIT License). See LICENSE for more info. [wasm-napi]: https://github.com/nodejs/abi-stable-node/issues/375 [napi-module]: https://gist.github.com/devsnek/db5499bf774f078e9ebb679680bd2cd1 [osxcross]: https://github.com/tpoechtrager/osxcross --- _Source: https://npm.io/package/cmake-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._