generator-jhipster-yellowbricks-spring-boot-contextpath 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# generator-jhipster-yellowbricks-spring-boot-contextpath
+
+A [JHipster](https://www.jhipster.tech/) blueprint that sets `server.servlet.context-path` in `application.yml` to a configurable context path.
+
+[![NPM version][npm-image]][npm-url]
+[![Generator][github-generator-image]][github-generator-url]
+![GitHub Maintained](https://img.shields.io/maintenance/yes/2026)
+
+## JHipster source
+
+- Generator: [`generators/spring-boot`](https://github.com/jhipster/generator-jhipster/tree/main/generators/spring-boot)
+- Template: [`application.yml.ejs`](https://github.com/jhipster/generator-jhipster/blob/main/generators/spring-boot/templates/src/main/resources/config/application.yml.ejs)
+
+## What it does
+
+Patches `src/main/resources/config/application.yml` during generation to insert `context-path` as the first key in `server.servlet`:
+
+```diff
+ server:
+   servlet:
++    context-path: /jh/
+     session:
+       cookie:
+         http-only: true
+```
+
+The value is configurable — any context path can be used.
+
+## Prerequisites
+
+- Node.js `^22.18.0 || >=24.11.0`
+- JHipster 9
+
+## Installation
+
+```bash
+npm install -g generator-jhipster-yellowbricks-spring-boot-contextpath
+```
+
+## Usage
+
+Create a `.yo-rc.json` in your project directory with the desired context path:
+
+```json
+{
+  "generator-jhipster-yellowbricks-spring-boot-contextpath": {
+    "contextPath": "/jh/"
+  }
+}
+```
+
+Then run JHipster with this blueprint:
+
+```bash
+# Standard generator
+jhipster --blueprints yellowbricks-spring-boot-contextpath
+
+# With JDL
+jhipster import-jdl your-app.jdl --blueprints yellowbricks-spring-boot-contextpath
+```
+
+Replace `/jh/` with your actual context path. The trailing slash is required.
+
+## Pre-release
+
+To use the latest unreleased version directly from GitHub:
+
+```bash
+npm install -g idNoRD/generator-jhipster-yellowbricks-spring-boot-contextpath#main
+```
+
+[npm-image]: https://img.shields.io/npm/v/generator-jhipster-yellowbricks-spring-boot-contextpath.svg
+[npm-url]: https://npmjs.org/package/generator-jhipster-yellowbricks-spring-boot-contextpath
+[github-generator-image]: https://github.com/idNoRD/generator-jhipster-yellowbricks-spring-boot-contextpath/actions/workflows/generator.yml/badge.svg
+[github-generator-url]: https://github.com/idNoRD/generator-jhipster-yellowbricks-spring-boot-contextpath/actions/workflows/generator.yml

package/cli/cli-customizations.cjs

@@ -0,0 +1,2 @@
+// This file will not be overwritten by generate-blueprint
+module.exports = {};

package/cli/cli.cjs

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+const { basename, dirname, join } = require('path');
+
+const { bin, version } = require('../package.json');
+
+// Get package name to use as namespace.
+// Allows blueprints to be aliased.
+const packagePath = dirname(__dirname);
+const packageFolderName = basename(packagePath);
+const devBlueprintPath = join(packagePath, '.blueprint');
+const blueprint = packageFolderName.startsWith('jhipster-') ? `generator-${packageFolderName}` : packageFolderName;
+
+(async () => {
+  const { runJHipster, done, logger } = await import('generator-jhipster/cli');
+  const executableName = Object.keys(bin)[0];
+
+  runJHipster({
+    executableName,
+    executableVersion: version,
+    defaultCommand: 'app',
+    devBlueprintPath,
+    blueprints: {
+      [blueprint]: version,
+    },
+    printBlueprintLogo: () => {
+      console.log('===================== JHipster Yellowbricks Spring Boot Contextpath =====================');
+      console.log('');
+    },
+    lookups: [{ packagePaths: [packagePath] }],
+    ...require('./cli-customizations.cjs'),
+  }).catch(done);
+
+  process.on('unhandledRejection', up => {
+    logger.error('Unhandled promise rejection at:');
+    logger.fatal(up);
+  });
+})();

package/generators/spring-boot/command.js

@@ -0,0 +1,13 @@
+import { asCommand } from 'generator-jhipster';
+
+export default asCommand({
+  configs: {
+    contextPath: {
+      description: 'Context path to set as server.servlet.context-path in application.yml (e.g. /jh/)',
+      cli: {
+        type: String,
+      },
+      scope: 'blueprint',
+    },
+  },
+});

package/generators/spring-boot/generator.js

@@ -0,0 +1,159 @@
+import BaseApplicationGenerator from 'generator-jhipster/generators/base-application';
+
+export default class extends BaseApplicationGenerator {
+  constructor(args, opts, features) {
+    super(args, opts, {
+      ...features,
+
+      sbsBlueprint: true,
+    });
+  }
+
+  get [BaseApplicationGenerator.INITIALIZING]() {
+    return this.asInitializingTaskGroup({
+      async initializingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.PROMPTING]() {
+    return this.asPromptingTaskGroup({
+      async promptingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.CONFIGURING]() {
+    return this.asConfiguringTaskGroup({
+      async configuringTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.COMPOSING]() {
+    return this.asComposingTaskGroup({
+      async composingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.COMPOSING_COMPONENT]() {
+    return this.asComposingComponentTaskGroup({
+      async composingComponentTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.LOADING]() {
+    return this.asLoadingTaskGroup({
+      async loadingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.PREPARING]() {
+    return this.asPreparingTaskGroup({
+      async preparingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_PREPARING]() {
+    return this.asPostPreparingTaskGroup({
+      async postPreparingTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.DEFAULT]() {
+    return this.asDefaultTaskGroup({
+      async defaultTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.WRITING]() {
+    return this.asWritingTaskGroup({
+      async writingTemplateTask({ application }) {
+        await this.writeFiles({
+          sections: {
+            files: [{ templates: ['template-file-spring-boot'] }],
+          },
+          context: application,
+        });
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.MULTISTEP_TRANSFORM]() {
+    return this.asMultistepTransformTaskGroup({
+      async multistepTransformTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_WRITING]() {
+    return this.asPostWritingTaskGroup({
+      async addContextPath() {
+        const contextPath = this.blueprintConfig.contextPath;
+        if (!contextPath) {
+          this.log.warn(
+            '[context-path blueprint] contextPath not configured — add {"generator-jhipster-yellowbricks-spring-boot-contextpath":{"contextPath":"/jh/"}} to .yo-rc.json',
+          );
+          return;
+        }
+
+        this.editFile('src/main/resources/config/application.yml', { ignoreNonExisting: true }, content => {
+          // Drift detection: verify expected surrounding structure
+          if (!/^server:$/m.test(content)) {
+            this.log.warn('[context-path blueprint] application.yml: server section not found — manual intervention needed');
+            return content;
+          }
+          if (!/ {2}servlet:/.test(content)) {
+            this.log.warn('[context-path blueprint] application.yml: server.servlet section not found — manual intervention needed');
+            return content;
+          }
+          if (!/^\s+session:$/m.test(content)) {
+            this.log.warn(
+              '[context-path blueprint] application.yml: server.servlet.session section not found — manual intervention needed',
+            );
+            return content;
+          }
+          // End drift detection
+
+          // Capture existing context-path value if present
+          const previousMatch = content.match(/^ {4}context-path: (.+)$/m);
+          const previousContextPath = previousMatch ? previousMatch[1].trim() : null;
+
+          // Remove existing context-path line, then insert as first key under servlet:
+          let updated = content.replace(/^ {4}context-path: .+\n/m, '');
+          updated = updated.replace(/^( {2}servlet:\n)/m, `$1    context-path: ${contextPath}\n`);
+
+          if (previousContextPath && previousContextPath !== contextPath) {
+            this.log.info(
+              `[context-path blueprint] application.yml: context-path renamed from "${previousContextPath}" to "${contextPath}"`,
+            );
+          } else {
+            this.log.info(`[context-path blueprint] application.yml: context-path "${contextPath}" added successfully`);
+          }
+
+          return updated;
+        });
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.TRANSFORM]() {
+    return this.asTransformTaskGroup({
+      async transformTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.INSTALL]() {
+    return this.asInstallTaskGroup({
+      async installTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_INSTALL]() {
+    return this.asPostInstallTaskGroup({
+      async postInstallTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.END]() {
+    return this.asEndTaskGroup({
+      async endTemplateTask() {},
+    });
+  }
+}

package/generators/spring-boot/index.js

@@ -0,0 +1,2 @@
+export { default } from './generator.js';
+export { default as command } from './command.js';

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "generator-jhipster-yellowbricks-spring-boot-contextpath",
+  "version": "1.0.0",
+  "description": "JHipster blueprint to configure Spring Boot application context-path",
+  "keywords": [
+    "yeoman-generator",
+    "jhipster-blueprint",
+    "jhipster-9",
+    "generator-jhipster-yellowbricks"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/idNoRD/generator-jhipster-yellowbricks-spring-boot-contextpath.git"
+  },
+  "license": "MIT",
+  "author": "idNoRD",
+  "bin": {
+    "jhipster-yellowbricks-spring-boot-contextpath": "cli/cli.cjs"
+  },
+  "files": [
+    "cli",
+    "generators",
+    "!**/__*",
+    "!**/*.snap",
+    "!**/*.spec.?(c|m)js"
+  ],
+  "scripts": {
+    "ejslint": "ejslint generators/**/*.ejs",
+    "lint": "eslint .",
+    "lint-fix": "npm run ejslint && npm run lint -- --fix",
+    "prepare": "husky",
+    "prettier-check": "prettier --check \"{,**/}*.{md,json,yml,html,cjs,mjs,js,cts,mts,ts,tsx,css,scss,vue,java}\"",
+    "prettier-format": "prettier --write \"{,**/}*.{md,json,yml,html,cjs,mjs,js,cts,mts,ts,tsx,css,scss,vue,java}\"",
+    "pretest": "npm run prettier-check && npm run lint",
+    "test": "vitest run",
+    "update-snapshot": "vitest run --update",
+    "vitest": "vitest"
+  },
+  "dependencies": {
+    "generator-jhipster": "9.0.0-beta.3"
+  },
+  "devDependencies": {
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.4",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "ejs-lint": "2.0.1",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-prettier": "5.5.5",
+    "globals": "17.3.0",
+    "husky": "9.1.7",
+    "jiti": "2.6.1",
+    "lint-staged": "16.2.7",
+    "prettier": "3.8.1",
+    "prettier-plugin-packagejson": "3.0.0",
+    "semantic-release": "^25.0.3",
+    "vitest": "4.0.18",
+    "yeoman-test": ">=10"
+  },
+  "engines": {
+    "generator-jhipster": "9.0.0-beta.3",
+    "node": "^22.18.0 || >=24.11.0"
+  }
+}