Skip to content

Generators ​

Documents the generators provided by the Nx Forge plugin.

Append --help or -h for any of the plugin generators to explore all available options.

Application ​

shell
nx generate @toolsplus/nx-forge:app apps/<nx-forge-app-name>

Generates a blank Forge app project named <nx-forge-app-name>. In almost all cases, you probably want to run the Forge app registration task immediately after this generator to register the app with the Forge platform.

Options ​

OptionTypeDescriptionDefault
--directory
--dir
string [required]Directory of the new application-
--namestringName of the application.
Pattern: ^[a-zA-Z][^:]*$
-
--linterstringTool to use for running lint checks.
Choices: "eslint", "none"
"eslint"
--unitTestRunnerstringTest runner to use for unit tests.
Choices: "jest", "vitest", "none"
"jest"
--bundlerstringBundler which is used to package the application
Choices: "esbuild", "webpack"
"webpack"
--tags
-t
stringAdd tags to the project (used for linting)-
--swcJestbooleanUse @swc/jest instead ts-jest for faster test compilation.false
--babelJestbooleanUse babel instead of ts-jest.
Deprecated: Use --swcJest instead for faster compilation
false
--jsbooleanGenerate JavaScript files rather than TypeScript files.false
--enableTypedLintingbooleanWhether to enable typed linting. For flat configs, this configures the recommended parserOptions.projectService and tsconfigRootDir. For legacy .eslintrc configs, this configures parserOptions.project. We do not enable this by default for lint performance reasons.false

Released under the MIT License.