# init

Nx [`init`](https://www.hyperfrontend.dev/docs/libraries/features/nx/generators/init/#api-initGenerator) generator. Ensures [`@hyperfrontend/features`](https://www.hyperfrontend.dev/docs/libraries/features.md) is declared in the
consumer workspace's root `package.json`. `nx add @hyperfrontend/features`
installs the package and then runs this generator automatically; it can also be
run directly. Registered via the package's `generators.json`.

A declaration in any dependency section (including [`devDependencies`](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devdependencies), where
`nx add`'s install step places it) satisfies the check and is never moved
between sections. When the package is undeclared it is added to [`dependencies`](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies)
(the SDK is a runtime dependency), pinned to a caret range on the running
plugin's own version. Repeat runs are no-ops.

When the workspace has `@nx/devkit` installed, staged files are formatted with
it before Nx writes them to disk. The generator returns an install callback
that Nx runs after flushing: it installs dependencies only when the manifest
actually changed, through the workspace's own `@nx/devkit`
[`installPackagesTask`](https://nx.dev/reference/core-api/devkit/documents/installPackagesTask) when resolvable, otherwise through a built-in installer
that detects the package manager from the workspace lockfile. The callback
then verifies that rollup's native binding for the current platform is
installed and, when it is missing, prints the exact install command to fix it
(the `hf build` command and the [`build`](https://www.hyperfrontend.dev/docs/libraries/features/nx/executors/build.md) executor need that binding to bundle).

The root `package.json` is the only file the generator touches. Nothing else
in the workspace needs configuration: the package resolves from
node_modules, so no tsconfig path mappings are required in either classic
or TS-solution workspaces; its generators and executors resolve by package
name without an `nx.json` plugins entry; no lint plugin ships, so ESLint
configuration stays untouched; and the package's own runtime requirements
([`tslib`](https://www.npmjs.com/package/tslib), [`typescript`](https://www.npmjs.com/package/typescript)) install transitively as its dependencies.

## Usage

```bash
nx add @hyperfrontend/features
# or directly
nx g @hyperfrontend/features:init
```

| Option                                                                                                                                                | Required | Description                                                                                                      |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| [`keepExistingVersions`](https://www.hyperfrontend.dev/docs/libraries/features/nx/generators/init/#api-InitGeneratorSchema-prop-keepExistingVersions) | no       | Keep an existing declaration's range untouched (default `true`); `false` re-pins it to the plugin's own version. |

---

Canonical page: https://www.hyperfrontend.dev/docs/libraries/features/nx/generators/init/
This file: https://www.hyperfrontend.dev/docs/libraries/features/nx/generators/init.md
Documentation index: https://www.hyperfrontend.dev/llms.txt