generator-jhipster-sentry-module 1.0.8 → 1.0.10

package/generators/app/index.js

@@ -5,7 +5,8 @@ const semver = require('semver');
 const Generator = require('yeoman-generator');
 const packageJson = require('../../package.json');
 
-// JHipster constants
+const JHIPSTER_CONFIG_KEY = 'generator-jhipster';
+
 const jhipsterConstants = {
   SERVER_MAIN_SRC_DIR: 'src/main/java/',
   SERVER_MAIN_RES_DIR: 'src/main/resources/',
@@ -13,25 +14,42 @@ const jhipsterConstants = {
 };
 
 module.exports = class extends Generator {
+
   async initializing() {
-    // Read JHipster config
-    this.jhipsterAppConfig = this.fs.readJSON(this.destinationPath('.yo-rc.json'), {})['generator-jhipster'];
+    const yoRcPath = this.destinationPath('.yo-rc.json');
+
+    if (!fs.existsSync(yoRcPath)) {
+      this.log(chalk.red('❌ Not a JHipster project (.yo-rc.json not found)'));
+      process.exit(1);
+    }
+
+    const yoRc = this.fs.readJSON(yoRcPath, {});
+    this.jhipsterAppConfig = yoRc[JHIPSTER_CONFIG_KEY];
+
     if (!this.jhipsterAppConfig) {
-      this.log(chalk.red('Cannot read .yo-rc.json or JHipster config missing'));
+      this.log(chalk.red('❌ JHipster configuration missing inside .yo-rc.json'));
       process.exit(1);
     }
 
-    this.log(`\nWelcome to the ${chalk.bold.yellow('JHipster Sentry Module')} generator! ${chalk.yellow(`v${packageJson.version}\n`)}`);
+    this.log(
+      `\nWelcome to the ${chalk.bold.yellow('JHipster Sentry Module')} generator! ${chalk.yellow(
+        `v${packageJson.version}\n`
+      )}`
+    );
+
+    const currentVersion = this.jhipsterAppConfig.jhipsterVersion;
 
-    // Check JHipster version
-    const currentJhipsterVersion = this.jhipsterAppConfig.jhipsterVersion;
-    if (!semver.satisfies(currentJhipsterVersion, '>=8.0.0')) {
-      this.log(chalk.yellow(`Warning: Your JHipster version is ${currentJhipsterVersion}, minimum required is 8.0.0\n`));
+    if (currentVersion && !semver.satisfies(currentVersion, '>=8.0.0')) {
+      this.log(
+        chalk.yellow(
+          `⚠ Your JHipster version is ${currentVersion}. Recommended >= 8.0.0\n`
+        )
+      );
     }
   }
 
   async prompting() {
-    const prompts = [
+    this.promptAnswers = await this.prompt([
       {
         type: 'confirm',
         name: 'enableSentry',
@@ -44,115 +62,135 @@ module.exports = class extends Generator {
         name: 'sentryDsn',
         message: 'Enter your Sentry DSN'
       }
-    ];
-    this.promptAnswers = await this.prompt(prompts);
+    ]);
   }
 
   writing() {
-    // Read JHipster config
-    this.baseName = this.jhipsterAppConfig.baseName;
-    this.packageName = this.jhipsterAppConfig.packageName;
-    this.packageFolder = this.jhipsterAppConfig.packageFolder;
-    this.clientFramework = this.jhipsterAppConfig.clientFramework;
-    this.clientPackageManager = this.jhipsterAppConfig.clientPackageManager;
-    this.buildTool = this.jhipsterAppConfig.buildTool;
-
-    const javaDir = `${jhipsterConstants.SERVER_MAIN_SRC_DIR}${this.packageFolder}/`;
-    const resourceDir = jhipsterConstants.SERVER_MAIN_RES_DIR;
+    if (!this.promptAnswers.enableSentry) {
+      this.log(chalk.yellow('Sentry disabled — skipping integration'));
+      return;
+    }
+
+    const {
+      baseName,
+      packageName,
+      packageFolder,
+      clientFramework,
+      buildTool
+    } = this.jhipsterAppConfig;
+
     const webappDir = jhipsterConstants.CLIENT_MAIN_SRC_DIR;
 
-    // Persist Sentry config
-    this.jhipsterAppConfig.sentry = {
-      enabled: this.promptAnswers.enableSentry,
+    this.log('\n--- JHipster Config ---');
+    this.log(`baseName=${baseName}`);
+    this.log(`packageName=${packageName}`);
+    this.log(`clientFramework=${clientFramework}`);
+    this.log(`buildTool=${buildTool}`);
+    this.log('------------------------\n');
+
+    /* ============================
+       Persist config in .yo-rc.json
+    ============================= */
+
+    const yoRcPath = this.destinationPath('.yo-rc.json');
+    const yoRc = this.fs.readJSON(yoRcPath, {});
+    yoRc[JHIPSTER_CONFIG_KEY] = yoRc[JHIPSTER_CONFIG_KEY] || {};
+    yoRc[JHIPSTER_CONFIG_KEY].sentry = {
+      enabled: true,
       dsn: this.promptAnswers.sentryDsn
     };
-    const configPath = this.destinationPath('.yo-rc.json');
-    const config = this.fs.readJSON(configPath, {});
-    config['generator-jhipster'] = config['generator-jhipster'] || {};
-    config['generator-jhipster'].sentry = this.jhipsterAppConfig.sentry;
-    this.fs.writeJSON(configPath, config, null, 2);
 
-    // Logging
-    this.log('\n--- JHipster Config ---');
-    this.log(`baseName=${this.baseName}`);
-    this.log(`packageName=${this.packageName}`);
-    this.log(`clientFramework=${this.clientFramework}`);
-    this.log(`buildTool=${this.buildTool}`);
-    this.log('\n--- Sentry ---');
-    this.log(`enabled=${this.promptAnswers.enableSentry}`);
-    this.log('----------------------\n');
+    this.fs.writeJSON(yoRcPath, yoRc, null, 2);
 
-    if (!this.promptAnswers.enableSentry) {
-      this.log(chalk.yellow('Sentry is disabled — skipping integration'));
-      return;
-    }
+    /* ============================
+       Backend Dependency Injection
+    ============================= */
 
-    // Backend dependencies
-    if (this.buildTool === 'maven') {
+    if (buildTool === 'maven') {
       const pomPath = this.destinationPath('pom.xml');
       if (fs.existsSync(pomPath)) {
         let pom = fs.readFileSync(pomPath, 'utf8');
         if (!pom.includes('sentry-spring-boot-starter')) {
           pom = pom.replace(
-            /<\/dependencies>/,
-            `    <dependency>
-        <groupId>io.sentry</groupId>
-        <artifactId>sentry-spring-boot-starter</artifactId>
-        <version>7.3.0</version>
-    </dependency>
-</dependencies>`
+            '</dependencies>',
+            `
+        <dependency>
+            <groupId>io.sentry</groupId>
+            <artifactId>sentry-spring-boot-starter</artifactId>
+            <version>7.3.0</version>
+        </dependency>
+    </dependencies>`
           );
           fs.writeFileSync(pomPath, pom);
         }
       }
     }
 
-    if (this.buildTool === 'gradle') {
-      const buildGradle = this.destinationPath('build.gradle');
-      if (fs.existsSync(buildGradle)) {
-        let gradle = fs.readFileSync(buildGradle, 'utf8');
+    if (buildTool === 'gradle') {
+      const gradlePath = this.destinationPath('build.gradle');
+      if (fs.existsSync(gradlePath)) {
+        let gradle = fs.readFileSync(gradlePath, 'utf8');
         if (!gradle.includes('sentry-spring-boot-starter')) {
-          gradle += '\ndependencies {\n    implementation "io.sentry:sentry-spring-boot-starter:7.3.0"\n}\n';
-          fs.writeFileSync(buildGradle, gradle);
+          gradle += `
+dependencies {
+    implementation "io.sentry:sentry-spring-boot-starter:7.3.0"
+}
+`;
+          fs.writeFileSync(gradlePath, gradle);
         }
       }
     }
 
-    // Frontend templates
-    if (this.clientFramework === 'react') {
+    /* ============================
+       Frontend Dependency Injection
+    ============================= */
+
+    const packagePath = this.destinationPath('package.json');
+    if (fs.existsSync(packagePath)) {
+      const pkg = this.fs.readJSON(packagePath, {});
+      pkg.dependencies = pkg.dependencies || {};
+
+      if (clientFramework === 'react') {
+        pkg.dependencies['@sentry/react'] = '^7.3.0';
+
         this.fs.copyTpl(
-            this.templatePath('client/react/sentry.ts.ejs'),
-            `${webappDir}app/sentry.ts`,
-            {
-              sentryDsn: this.promptAnswers.sentryDsn
-            }
-          );    } else if (this.clientFramework === 'angularX') {
-            this.fs.copyTpl(
-                this.templatePath('client/react/sentry.ts.ejs'),
-                `${webappDir}app/sentry.ts`,
-                {
-                  sentryDsn: this.promptAnswers.sentryDsn
-                }
-              );    }
+          this.templatePath('client/react/sentry.ts.ejs'),
+          `${webappDir}app/sentry.ts`,
+          { sentryDsn: this.promptAnswers.sentryDsn }
+        );
+      }
+
+      if (clientFramework === 'angularX') {
+        pkg.dependencies['@sentry/angular'] = '^7.3.0';
+
+        this.fs.copyTpl(
+          this.templatePath('client/angular/sentry.ts.ejs'),
+          `${webappDir}app/sentry.ts`,
+          { sentryDsn: this.promptAnswers.sentryDsn }
+        );
+      }
+
+      this.fs.writeJSON(packagePath, pkg, null, 2);
+    }
   }
 
   install() {
     if (!this.promptAnswers.enableSentry) return;
 
-    const packages = [];
-    if (this.clientFramework === 'react') {
-      packages.push('@sentry/react@^7.3.0');
-    } else if (this.clientFramework === 'angularX') {
-      packages.push('@sentry/angular@^7.3.0');
-    }
+    const clientPackageManager =
+      this.jhipsterAppConfig.clientPackageManager || 'npm';
 
-    if (packages.length > 0) {
-      const cmd = this.clientPackageManager === 'yarn' ? 'add' : 'install';
-      this.spawnCommandSync(this.clientPackageManager, [...(this.clientPackageManager === 'yarn' ? ['add'] : ['install']), ...packages]);
+    if (this.options['skip-install']) {
+      this.log(
+        `Run ${clientPackageManager} install manually to install dependencies`
+      );
+      return;
     }
+
+    this.spawnCommandSync(clientPackageManager, ['install']);
   }
 
   end() {
-    this.log(chalk.green('✔ Sentry module generation complete'));
+    this.log(chalk.green('\n✔ Sentry module generation complete\n'));
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-jhipster-sentry-module",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Adding Sentry integration to JHipster projects",
   "keywords": [
     "yeoman-generator",