generator-jhipster-sentry-module 1.0.4 → 1.0.6

package/generators/app/index.js

@@ -1,82 +1,33 @@
 const path = require('path');
+const fs = require('fs');
 const chalk = require('chalk');
 const semver = require('semver');
-
-// Resolve generator-jhipster so the module works when installed globally (peer dependency
-// is not under this package's node_modules). Prefer project cwd, then global npm.
-function resolveGeneratorJhipster() {
-  // When installed globally, __dirname is .../node_modules/generator-jhipster-sentry-module/generators/app.
-  // The folder that contains node_modules (sibling of our package) is one level up from module root = 3 levels from __dirname.
-  const globalNodeModulesParent = path.resolve(__dirname, '..', '..', '..', '..');
-  const searchPaths = [
-    process.cwd(),
-    path.join(process.cwd(), 'node_modules'),
-    globalNodeModulesParent
-  ];
-  try {
-    const pkgPath = require.resolve('generator-jhipster/package.json', { paths: searchPaths });
-    return path.dirname(pkgPath);
-  } catch (e) {
-    throw new Error(
-      'Could not find generator-jhipster. Install it in your project (npm install generator-jhipster) or globally (npm install -g generator-jhipster).'
-    );
-  }
-}
-
-const jhipsterRoot = resolveGeneratorJhipster();
-// v8+ publishes built files under dist/generators/<name>/index.js; older versions use generators/<name>.js
-function requireJhipsterSubpath(subpath) {
-  const distPath = path.join(jhipsterRoot, 'dist', 'generators', subpath, 'index.js');
-  const legacyPath = path.join(jhipsterRoot, 'generators', subpath);
-  const fs = require('fs');
-  if (fs.existsSync(distPath)) {
-    return require(distPath);
-  }
-  if (fs.existsSync(legacyPath) || fs.existsSync(`${legacyPath}.js`)) {
-    return require(legacyPath);
-  }
-  throw new Error(`Could not find generator-jhipster subpath: ${subpath}`);
-}
-const GeneratorBase = requireJhipsterSubpath('generator-base');
-const jhipsterConstants = requireJhipsterSubpath('generator-constants');
+const Generator = require('yeoman-generator');
 const packageJson = require('../../package.json');
 
-module.exports = class extends GeneratorBase {
-  get initializing() {
-    return {
-      init(args) {
-        if (args === 'default') {
-          this.message = 'default message';
-        }
-      },
-
-      readConfig() {
-        this.jhipsterAppConfig = this.getAllJhipsterConfig();
-        if (!this.jhipsterAppConfig) {
-          this.error('Cannot read .yo-rc.json');
-        }
-      },
+// JHipster constants
+const jhipsterConstants = {
+  SERVER_MAIN_SRC_DIR: 'src/main/java/',
+  SERVER_MAIN_RES_DIR: 'src/main/resources/',
+  CLIENT_MAIN_SRC_DIR: 'src/main/webapp/'
+};
 
-      displayLogo() {
-        this.printJHipsterLogo();
-        this.log(
-          `\nWelcome to the ${chalk.bold.yellow('JHipster Sentry Module')} generator! ${chalk.yellow(
-            `v${packageJson.version}\n`
-          )}`
-        );
-      },
+module.exports = class extends Generator {
+  async initializing() {
+    // Read JHipster config
+    this.jhipsterAppConfig = this.fs.readJSON(this.destinationPath('.yo-rc.json'), {})['generator-jhipster'];
+    if (!this.jhipsterAppConfig) {
+      this.log(chalk.red('Cannot read .yo-rc.json or JHipster config missing'));
+      process.exit(1);
+    }
 
-      checkJhipster() {
-        const currentJhipsterVersion = this.jhipsterAppConfig.jhipsterVersion;
-        const minimumJhipsterVersion = '>=8.0.0';
+    this.log(`\nWelcome to the ${chalk.bold.yellow('JHipster Sentry Module')} generator! ${chalk.yellow(`v${packageJson.version}\n`)}`);
 
-        if (!semver.satisfies(currentJhipsterVersion, minimumJhipsterVersion)) {
-          this.warning(
-            `\nYour generated project uses JHipster ${currentJhipsterVersion}. Minimum required is ${minimumJhipsterVersion}\n`
-          );
-        }
-      }
-    };
+    // 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`));
+    }
   }
 
   async prompting() {
@@ -94,7 +45,6 @@ module.exports = class extends GeneratorBase {
         message: 'Enter your Sentry DSN'
       }
     ];
-
     this.promptAnswers = await this.prompt(prompts);
   }
 
@@ -107,8 +57,6 @@ module.exports = class extends GeneratorBase {
     this.clientPackageManager = this.jhipsterAppConfig.clientPackageManager;
     this.buildTool = this.jhipsterAppConfig.buildTool;
 
-    this.angularAppName = this.getAngularAppName();
-
     const javaDir = `${jhipsterConstants.SERVER_MAIN_SRC_DIR}${this.packageFolder}/`;
     const resourceDir = jhipsterConstants.SERVER_MAIN_RES_DIR;
     const webappDir = jhipsterConstants.CLIENT_MAIN_SRC_DIR;
@@ -118,16 +66,11 @@ module.exports = class extends GeneratorBase {
       enabled: this.promptAnswers.enableSentry,
       dsn: this.promptAnswers.sentryDsn
     };
-
-    // Write to .yo-rc.json safely
-    const fs = require('fs');
     const configPath = this.destinationPath('.yo-rc.json');
-    if (fs.existsSync(configPath)) {
-      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);
-    }
+    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 ---');
@@ -135,12 +78,6 @@ module.exports = class extends GeneratorBase {
     this.log(`packageName=${this.packageName}`);
     this.log(`clientFramework=${this.clientFramework}`);
     this.log(`buildTool=${this.buildTool}`);
-
-    this.log('\n--- Directories ---');
-    this.log(`javaDir=${javaDir}`);
-    this.log(`resourceDir=${resourceDir}`);
-    this.log(`webappDir=${webappDir}`);
-
     this.log('\n--- Sentry ---');
     this.log(`enabled=${this.promptAnswers.enableSentry}`);
     this.log('----------------------\n');
@@ -150,54 +87,59 @@ module.exports = class extends GeneratorBase {
       return;
     }
 
-    // Backend
+    // Backend dependencies
     if (this.buildTool === 'maven') {
-      this.addMavenDependency('io.sentry', 'sentry-spring-boot-starter', '7.3.0');
+      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>`
+          );
+          fs.writeFileSync(pomPath, pom);
+        }
+      }
     }
+
     if (this.buildTool === 'gradle') {
-      this.addGradleDependency('implementation', 'io.sentry:sentry-spring-boot-starter:7.3.0');
+      const buildGradle = this.destinationPath('build.gradle');
+      if (fs.existsSync(buildGradle)) {
+        let gradle = fs.readFileSync(buildGradle, '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);
+        }
+      }
     }
-    this.template('server/sentry-application.yml.ejs', `${resourceDir}config/sentry.yml`);
 
-    // Frontend
+    // Frontend templates
     if (this.clientFramework === 'react') {
-      this.addNpmDependency('@sentry/react', '^7.3.0');
-      this.template('client/react/sentry.ts.ejs', `${webappDir}app/sentry.ts`);
-    }
-    if (this.clientFramework === 'angularX') {
-      this.addNpmDependency('@sentry/angular', '^7.3.0');
-      this.template('client/angular/sentry.ts.ejs', `${webappDir}app/sentry.ts`);
-    }
-
-    // Register module hook
-    try {
-      this.registerModule(
-        'generator-jhipster-sentry-module',
-        'app',
-        'post',
-        'app',
-        'Adds Sentry integration'
-      );
-    } catch (err) {
-      this.log(`${chalk.red.bold('WARN!')} Could not register JHipster hook`);
+      this.fs.copyTpl(this.templatePath('client/react/sentry.ts.ejs'), `${webappDir}app/sentry.ts`);
+    } else if (this.clientFramework === 'angularX') {
+      this.fs.copyTpl(this.templatePath('client/angular/sentry.ts.ejs'), `${webappDir}app/sentry.ts`);
     }
   }
 
   install() {
-    const logMsg = `To install dependencies manually, run: ${chalk.yellow.bold(
-      `${this.clientPackageManager} install`
-    )}`;
+    if (!this.promptAnswers.enableSentry) return;
 
-    if (this.options['skip-install']) {
-      this.log(logMsg);
-      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');
     }
 
-    this.installDependencies({
-      npm: this.clientPackageManager === 'npm',
-      yarn: this.clientPackageManager === 'yarn',
-      bower: false
-    });
+    if (packages.length > 0) {
+      const cmd = this.clientPackageManager === 'yarn' ? 'add' : 'install';
+      this.spawnCommandSync(this.clientPackageManager, [...(this.clientPackageManager === 'yarn' ? ['add'] : ['install']), ...packages]);
+    }
   }
 
   end() {

package/package.json

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