@hyperfrontend/features/nx/executors/build

build

Nx build executor. A thin wrapper that builds a hyperfrontend feature's shell package by delegating to the SDK's headless hf build, run against the executing project's root directory. When the build fails, it checks whether rollup's native binding for the current platform is installed and, when it is missing, prints the exact install command for the workspace's package manager on stderr. Registered via the package's executors.json.

Usage

{
  "targets": {
    "build": {
      "executor": "@hyperfrontend/features:build",
      "options": { "config": "./feature.config.json" }
    }
  }
}
OptionRequiredDescription
confignoPath to the feature config object.
outnoOutput directory for the built shell.
protocolnoSecurity envelope: none, v3, or v4.
namenoFeature name override.
versionnoFeature version override.
urlnoURL the generated shell loads the feature from.
contractnoPath to the contract file.
allowOpennoAcknowledge an explicit none protocol and build an open, unauthenticated shell.

API Reference§

◈ Interfaces

§interface

BuildExecutorSchema

Options for the build executor; mirrors schema.json.
Properties
§config?:stringPath to the feature config object.
§out?:stringOutput directory for the built shell.
§protocol?:stringSecurity envelope to enforce at build time: none, v3, or v4.
§name?:stringFeature name override.
§version?:stringFeature version override.
§url?:stringURL the generated shell loads the feature from.
§contract?:stringPath to the contract file.
§allowOpen?:booleanAcknowledge an explicit none protocol and build an open, unauthenticated shell.

● Variables

§type

runBuildExecutor

Build a hyperfrontend feature's shell package by delegating to the SDK's hf build.
Maps the executor options to headless CLI flags and runs the build against the executing project's root directory.
Example

Running the executor programmatically

const result = await runBuildExecutor({ config: './feature.config.json' }, context)