Default out path to {build}/{configuration} directory and refactored pathSuffix naming strategy

[kraenhansen]

This is to align with the behavior of "cmake-js" to address some of the concerns raised in #146.

Merging this PR will:

• Change cmake-rn to save the final prebuilds into ./{build}/{configuration} (ex. ./build/Release)
• Change the Babel plugin to look for the ./build/Release prebuilds when transforming require("bindings")(...) statements.
• Change the shared code in the host package to strip the sub-path of addons by default to avoid having build-Release as a part of the library name.
• Refactor the "path-utils" tests, into individually failing tests (which might have to be deleted once Refactor C++ loader: extract cache and addon registry, resolve TODOs #104 merge)

The naming strategy will now be controlled by a pathSuffix option passed to the Babel plugin (the following are the docs for the option):

Controls how the path of the addon inside a package is transformed into a library name.
The transformation is needed to disambiguate and avoid conflicts between addons with the same name (but in different sub-paths or packages).

As an example, if the package name is my-pkg and the path of the addon within the package is build/Release/my-addon.node:

• "omit": Only the package name is used and the library name will be my-pkg.
• "strip" (the default): Path gets stripped to its basename and the library name will be my-pkg--my-addon.
• "keep": The full path is kept and the library name will be my-pkg--build-Release-my-addon.

Or when linking through a --path-suffix option or the NODE_API_PATH_SUFFIX environment variable.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 883978b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[kraenhansen]

I was contemplating actually interpreting the --out parameter as a template and replace in the value of the --build and --configuration arguments. This would make it a bit more flexible for users wanting to provide values for --out based on other arguments too 🤔

[Copilot]

Pull Request Overview

Aligns the default output directory with cmake-js (./build/{configuration}) and refactors the naming strategy for Node-API modules to use a pathSuffix option instead of a boolean flag.

• Default --out path is now {build}/{configuration} in the CMake RN CLI.
• Replaces stripPathSuffix boolean with a pathSuffix enum (omit/strip/keep) across host CLI, Babel plugin, and path-utils.
• Updates tests, Podspec, and scripts to reflect the new naming strategy and output defaults.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
path-utils.ts	Swapped stripPathSuffix for pathSuffix and updated getLibraryName logic.
path-utils.test.ts	Expanded tests for strip, keep, and omit path suffix modes.
cli/program.ts	Replaced the old --strip-path-suffix option with --path-suffix.
cli/options.ts	Added pathSuffixOption with validation against `"strip"
babel-plugin/plugin.ts	Updated plugin to consume pathSuffix and added findNodeAddonForBindings.
babel-plugin/plugin.test.ts	Added comprehensive tests for all pathSuffix modes in both require and bindings.
react-native-node-api.podspec	Removed legacy --strip-path-suffix logic from the Podspec.
package.json	Added --out flag to weak-node-api build scripts.
cmake-rn/src/cli.ts	Introduced outPathOption and defaulted globalContext.out to <build>/<configuration>.

Comments suppressed due to low confidence (2)

packages/host/react-native-node-api.podspec:9

• The Podspec no longer exposes a way to pass --path-suffix when copying frameworks. Consider re-adding logic to read NODE_API_PATH_SUFFIX (or default) and include --path-suffix <strategy> in the CLI invocation.

COPY_FRAMEWORKS_COMMAND ||= "#{CLI_COMMAND} link --apple '#{Pod::Config.instance.installation_root}'"

packages/host/src/node/cli/program.ts:71

• [nitpick] Previously the CLI warned when stripping suffixes to avoid naming collisions. You may want to reintroduce a warning when pathSuffix is set to strip or omit, as both modes can cause collisions.

  .action(async (pathArg, { force, prune, pathSuffix, android, apple }) => {

[Copilot]

assertOptions still only checks stripPathSuffix and does not validate the new pathSuffix property. Update it to assert that opts.pathSuffix, if present, is one of 'strip', 'keep', or 'omit', and remove any leftover stripPathSuffix branches.

[Copilot]

The .default(false, "./{build}/{configuration}") call will set the default to false rather than the intended path string. Use .default("./{build}/{configuration}") so --out defaults correctly.

Suggested change

	).default(false, "./{build}/{configuration}");
	).default("./{build}/{configuration}");

[kraenhansen]

This is on purpose, since we need the values of build and configuration to construct the default value, we're setting it to false to defer defining its actual value.

[kraenhansen]

I need this merged to progress on the example repo, please review in retrospect 🙏