generator-jhipster-yellowbricks-angular-contextpath 0.1.0

package/README.md

@@ -0,0 +1,58 @@
+# generator-jhipster-yellowbricks-angular-contextpath
+
+A [JHipster](https://www.jhipster.tech/) blueprint that sets the Angular `baseHref` in `angular.json` to a configurable context path.
+
+[![NPM version][npm-image]][npm-url]
+[![Generator][github-generator-image]][github-generator-url]
+
+## What it does
+
+Patches `angular.json` during generation to insert `baseHref` as the first key in `build.options`:
+
+```diff
+  "architect": {
+    "build": {
+      "builder": "@angular-builders/custom-esbuild:application",
+      "options": {
++       "baseHref": "/jh/",
+        ...
+```
+
+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-angular-contextpath
+```
+
+## Usage
+
+Run JHipster with this blueprint and pass your desired context path:
+
+```bash
+jhipster --blueprints yellowbricks-angular-contextpath \
+  --yellowbricks-angular-contextpath-config='{"contextPath":"/jh/"}'
+```
+
+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-angular-contextpath#main
+jhipster --blueprints yellowbricks-angular-contextpath \
+  --yellowbricks-angular-contextpath-config='{"contextPath":"/jh/"}'
+```
+
+[npm-image]: https://img.shields.io/npm/v/generator-jhipster-yellowbricks-angular-contextpath.svg
+[npm-url]: https://npmjs.org/package/generator-jhipster-yellowbricks-angular-contextpath
+[github-generator-image]: https://github.com/idNoRD/generator-jhipster-yellowbricks-angular-contextpath/actions/workflows/generator.yml/badge.svg
+[github-generator-url]: https://github.com/idNoRD/generator-jhipster-yellowbricks-angular-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 Angular 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/angular/command.js

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

package/generators/angular/generator.js

@@ -0,0 +1,169 @@
+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-angular'] }],
+          },
+          context: application,
+        });
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.MULTISTEP_TRANSFORM]() {
+    return this.asMultistepTransformTaskGroup({
+      async multistepTransformTemplateTask() {},
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_WRITING]() {
+    return this.asPostWritingTaskGroup({
+      async addBaseHref() {
+        const contextPath = this.blueprintConfig.contextPath;
+        if (!contextPath) {
+          this.log.warn(
+            '[base-href blueprint] contextPath not configured — pass --yellowbricks-angular-contextpath-config=\'{"contextPath":"/jh/"}\' when running jhipster',
+          );
+          return;
+        }
+
+        this.editFile('angular.json', { ignoreNonExisting: true }, content => {
+          const json = JSON.parse(content);
+          const projectName = Object.keys(json.projects ?? {})[0];
+          const build = json.projects?.[projectName]?.architect?.build;
+
+          // --- drift detection: verify expected surrounding structure ---
+          const expectedBuilder = '@angular-builders/custom-esbuild:application';
+
+          if (!build) {
+            this.log.warn('[base-href blueprint] angular.json: architect.build section not found — manual intervention needed');
+            return content;
+          }
+          if (build.builder !== expectedBuilder) {
+            this.log.warn(
+              `[base-href blueprint] angular.json: expected builder "${expectedBuilder}" but found "${build.builder ?? 'undefined'}" — manual intervention needed`,
+            );
+            return content;
+          }
+          if (!build.options) {
+            this.log.warn('[base-href blueprint] angular.json: architect.build.options not found — manual intervention needed');
+            return content;
+          }
+          if (!Array.isArray(build.options.plugins)) {
+            this.log.warn('[base-href blueprint] angular.json: build.options.plugins array not found — manual intervention needed');
+            return content;
+          }
+          if (!build.options.outputPath) {
+            this.log.warn('[base-href blueprint] angular.json: build.options.outputPath not found — manual intervention needed');
+            return content;
+          }
+          // --- end drift detection ---
+
+          const previousBaseHref = build.options.baseHref;
+
+          // Remove existing baseHref (if any) then insert as the first key in options
+          const { baseHref: _removed, ...remainingOptions } = build.options;
+          build.options = { baseHref: contextPath, ...remainingOptions };
+
+          if (previousBaseHref && previousBaseHref !== contextPath) {
+            this.log.info(`[base-href blueprint] angular.json: baseHref renamed from "${previousBaseHref}" to "${contextPath}"`);
+          } else {
+            this.log.info(`[base-href blueprint] angular.json: baseHref "${contextPath}" added successfully`);
+          }
+
+          return `${JSON.stringify(json, null, 2)}\n`;
+        });
+      },
+    });
+  }
+
+  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/angular/index.js

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

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "generator-jhipster-yellowbricks-angular-contextpath",
+  "version": "0.1.0",
+  "description": "JHipster blueprint to configure Angular application baseHref via a custom context path",
+  "keywords": [
+    "yeoman-generator",
+    "jhipster-blueprint",
+    "jhipster-9",
+    "generator-jhipster-yellowbricks"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/idNoRD/generator-jhipster-yellowbricks-angular-contextpath.git"
+  },
+  "license": "MIT",
+  "author": "idNoRD",
+  "bin": {
+    "jhipster-yellowbricks-angular-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": {
+    "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",
+    "vitest": "4.0.18",
+    "yeoman-test": ">=10"
+  },
+  "engines": {
+    "generator-jhipster": "9.0.0-beta.3",
+    "node": "^22.18.0 || >=24.11.0"
+  }
+}