@hyperfrontend/features/nx/executors

executors

Nx executors for hyperfrontend features — build packages a feature's shell by delegating to the SDK's headless hf build, serve runs the SDK dev server as a long-lived target.

import { runBuildExecutor, serveExecutor } from '@hyperfrontend/features/nx/executors'

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

Executors

Executor	Purpose
`build`	Builds the feature's shell package against the executing project's root; explains a missing rollup binding.
`serve`	Starts the dev server, yields the startup result, and keeps the servers alive until a shutdown signal arrives.

When a build fails, the executor 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.

Usage

{
  "targets": {
    "build": {
      "executor": "@hyperfrontend/features:build",
      "options": { "config": "./feature.config.json" }
    },
    "serve": {
      "executor": "@hyperfrontend/features:serve",
      "options": { "port": "4600" }
    }
  }
}

See the build and serve docs for the full option tables.

API Reference

◈ Interfaces

§interface

BuildExecutorSchema

Options for the build executor; mirrors schema.json.

Properties

§allowOpen?:boolean

Acknowledge an explicit none protocol and build an open, unauthenticated shell.

§config?:string

Path to the feature config object.

§contract?:string

Path to the contract file.

§name?:string

Feature name override.

§out?:string

Output directory for the built shell.

§protocol?:string

Security envelope to enforce at build time: none, v1, or v2.

§url?:string

URL the generated shell loads the feature from.

§version?:string

Feature version override.

View source →

§interface

ServeExecutorSchema

Options for the serve executor; mirrors schema.json.

Properties

§apps?:string

Path to the dev-server apps array.

§config?:string

Path to the dev-server config object.

§port?:string

Port the dev server's debug UI listens on.

View source →

● 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.

View source →

§type

serveExecutor

Serve a hyperfrontend feature dev server by delegating to the SDK's hf dev.
Long-running async-iterator executor: it starts the dev server, yields the startup result, stays alive until a shutdown signal, then closes the servers.

View source →