Node.js Binding

The node.js binding for the cpp-linter-rs rust project (built using napi-rs and yarn).

Install

Install with npm:

npm -g install @cpp-linter/cpp-linter

Usage

For usage in a CI workflow, see the cpp-linter/cpp-linter-action repository.

For the description of supported Command Line Interface options, see the CLI documentation.

Development

After the native module is built using yarn build:debug, you can invoke the executable script as a normal CLI app:

npx cpp-linter --help

Scripts

If an available script is not described below, it should be considered a convenience tool for the CI/CD workflow.

yarn build

This script builds the native module for distribution (with release profile optimizations).

yarn build:debug

Same as yarn build but does not use the release profile optimizations. You should use this script when testing locally.

yarn test

This script runs a simple test to ensure the native module was built correctly.

Folder structure

Name	Description
__test__	The location of the unit test(s).
npm	The required metadata for publishing platform-specific packages to npm.
src	The location for all rust sources related to binding the cpp-linter library.
build.rs	The cargo-specific build script used when compiling the binding.
Cargo.toml	Metadata about the binding's rust package (which is not intended to be published to crates.io).
package.json	Metadata about the npm package (platform agnostic).
cli.js	The executable script invoked as a Command Line Interface.
index.d.ts	The generated TypeScript typing info the describes the exposing functionality in the built native module.
index.js	The generated script that delegates which platform-specific package to import.
cpp-linter.x-y-z.node	Then native module built for a specific platform (where x-y-z denotes the platform's name using compilation target).

Hidden files and folders are not described in the table above. If they are not ignored by a gitignore specification, then they should be considered important only for maintenance or distribution.