JHipster Generator

Common errors

• Cannot find package 'yeoman-test'

  cause An issue in `generator-jhipster@9.0.0-beta.1` caused `yeoman-test` to be incorrectly resolved when the generator was installed globally.
  fix Upgrade `generator-jhipster` to version `9.0.0-beta.3` or any subsequent stable release (e.g., `npm install -g generator-jhipster@latest`).

• Maximum call stack size exceeded

  cause A bug in the `chevrotain` dependency used by `generator-jhipster@9.0.0-beta.2` led to stack overflow errors during JDL file parsing.
  fix Upgrade `generator-jhipster` to version `9.0.0-beta.3` or any subsequent stable release (e.g., `npm install -g generator-jhipster@latest`).

Warnings

• breaking JHipster v9 introduces significant technology stack upgrades, including Spring Boot 4, Angular 21 (with zoneless by default), React 19 (replacing reactstrap with react-bootstrap), minimum Java 21, and minimum Node.js 22. Existing projects must update their environment and potentially migrate codebases.
  Fix: Review the official JHipster v9 release notes and migration guide. Ensure your development environment meets the new Java and Node.js requirements. For frontends, be aware of zoneless Angular changes and the React-bootstrap transition.
• breaking React applications generated with JHipster v9 now use `react-bootstrap` instead of `reactstrap`. This change requires refactoring any custom React components that previously relied on `reactstrap`'s API or components.
  Fix: Migrate your React component code to use `react-bootstrap` components and utilities. Consult `react-bootstrap` documentation for equivalent components and API changes.
• breaking Angular applications generated with JHipster v9 are now zoneless by default. This significantly changes change detection mechanisms and might require adjustments to code that explicitly relied on Zone.js, particularly for third-party libraries or manual change detection triggers.
  Fix: Familiarize yourself with Angular's zoneless change detection. Update components to use signals or other Angular reactive primitives. Debugging tools might need to be adjusted for zoneless applications.
• gotcha Version 9.0.0-beta.1 was broken, causing the CLI to fail with 'Cannot find package 'yeoman-test'' errors when installed globally.
  Fix: Avoid installing or using `v9.0.0-beta.1`. Upgrade to `v9.0.0-beta.3` or later stable versions.
• gotcha Version 9.0.0-beta.2 was broken, leading to 'Maximum call stack size exceeded' errors when parsing JDL (JHipster Domain Language) files.
  Fix: Avoid installing or using `v9.0.0-beta.2`. Upgrade to `v9.0.0-beta.3` or later stable versions.

Install

• npm install generator-jhipster npm
• yarn add generator-jhipster yarn
• pnpm add generator-jhipster pnpm

Imports

• JHipsterGenerator
  wrong:

  const JHipsterGenerator = require('generator-jhipster');

  correct:

  import { JHipsterGenerator } from 'generator-jhipster';

  This represents the main generator class, primarily for programmatic testing or extending JHipster. Version 9 is ESM-first, so CommonJS `require` is incorrect for direct imports.
• type JHipsterApplicationConfiguration
  wrong:

  import { JHipsterApplicationConfiguration } from 'generator-jhipster';

  correct:

  import type { JHipsterApplicationConfiguration } from 'generator-jhipster';

  Use `import type` for type-only imports to prevent bundling issues and ensure correct type inference for configuration objects. This type defines the structure of the application's `.yo-rc.json`.
• JDLParser
  wrong:

  import JDLParser from 'generator-jhipster/lib/jdl-parser';

  correct:

  import { JDLParser } from 'generator-jhipster';

  For parsing JHipster Domain Language (JDL) files programmatically. Older CommonJS versions might have used direct submodule paths or default exports; V9 uses a flattened ESM structure with named exports.

Quickstart

This quickstart outlines the essential steps to install the JHipster generator and scaffold a new full-stack application using the `yo jhipster` command-line interface.

// Quickstart for JHipster v9.0.0
// This demonstrates the typical setup and generation of a JHipster application.

// 1. Install Yeoman globally if you haven't already.
// Yeoman is the scaffolding tool that runs JHipster generators.
console.log('Installing Yeoman globally...');
// npm install -g yo

// 2. Install the JHipster generator globally.
console.log('Installing JHipster generator globally...');
// npm install -g generator-jhipster

// 3. Create a new directory for your application and navigate into it.
// mkdir myapp
// cd myapp

// 4. Run the JHipster generator. This will start an interactive prompt
// where you can configure your application's type, technologies, and features.
console.log('Running JHipster generator...');
// yo jhipster

// During the interactive process, you'll be asked questions such as:
// - Which type of application would you like to create? (Monolithic, Microservice, Gateway)
// - Which front-end framework would you like to use? (Angular, React, Vue)
// - Which type of authentication would you like to use? (JWT, OAuth 2.0, Session)
// - Which database would you like to use? (SQL, MongoDB, Cassandra, etc.)
// - Which build tool would you like to use? (Maven, Gradle)

// After generation, you can run your application.
console.log('JHipster application generated. To run:');
console.log('  cd myapp');
console.log('  ./mvnw (for Maven) or ./gradlew (for Gradle) to build and run the backend.');
console.log('  npm start or yarn start (in the frontend folder) to run the frontend.');

// This provides a full-stack application ready for development.