generator-jhipster-sentry-module 1.0.0 → 1.0.2

package/README.md

@@ -44,6 +44,40 @@ To update this module:
 yarn global upgrade generator-jhipster-sentry-module
 ```
 
+## Using the module locally (development)
+
+To use your local clone of this module without publishing to npm (e.g. for development or testing):
+
+**Step 1 – Link from the module directory:**
+
+```bash
+cd d:\code\jhipster_sentry   # or your module path
+npm link
+```
+
+This makes your local module available globally.
+
+**Step 2 – Link in your JHipster project:**
+
+```bash
+cd /path/to/your/jhipster-app
+npm link generator-jhipster-sentry-module
+```
+
+Then run the generator as usual:
+
+```bash
+yo jhipster-sentry-module
+```
+
+**Alternative – install from folder:** In your JHipster project you can instead run:
+
+```bash
+npm install /path/to/jhipster_sentry
+```
+
+For more detail and troubleshooting, see [LINKING_GUIDE.md](LINKING_GUIDE.md).
+
 # Usage
 
 After installing the module, run it in your JHipster project:

package/generators/app/index.js

@@ -1,211 +1,193 @@
+const path = require('path');
 const chalk = require('chalk');
 const semver = require('semver');
-const BaseGenerator = require('generator-jhipster/generators/generator-base');
-const jhipsterConstants = require('generator-jhipster/generators/generator-constants');
-const packagejs = require('../../package.json');
-
-module.exports = class extends BaseGenerator {
-    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');
-                }
-            },
-
-            displayLogo() {
-                this.printJHipsterLogo();
-                this.log(
-                    `\nWelcome to the ${chalk.bold.yellow(
-                        'JHipster Sentry Module'
-                    )} generator! ${chalk.yellow(`v${packagejs.version}\n`)}`
-                );
-            },
-
-            checkJhipster() {
-                const currentJhipsterVersion = this.jhipsterAppConfig.jhipsterVersion;
-                const minimumJhipsterVersion = packagejs.dependencies['generator-jhipster'];
-
-                if (!semver.satisfies(currentJhipsterVersion, minimumJhipsterVersion)) {
-                    this.warning(
-                        `\nYour generated project uses JHipster ${currentJhipsterVersion}. ` +
-                        `Minimum required is ${minimumJhipsterVersion}\n`
-                    );
-                }
-            }
-        };
-    }
-
-    prompting() {
-        const prompts = [
-            {
-                type: 'confirm',
-                name: 'enableSentry',
-                message: 'Do you want to enable Sentry error tracking?',
-                default: true
-            },
-            {
-                when: answers => answers.enableSentry,
-                type: 'input',
-                name: 'sentryDsn',
-                message: 'Enter your Sentry DSN'
-            }
-        ];
-
-        const done = this.async();
-        this.prompt(prompts).then(answers => {
-            this.promptAnswers = answers;
-            done();
-        });
-    }
-
-    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;
-
-        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;
-
-        /* -------------------------------
-         * Persist config (regen safe)
-         * ----------------------------- */
-        this.jhipsterAppConfig.sentry = {
-            enabled: this.promptAnswers.enableSentry,
-            dsn: this.promptAnswers.sentryDsn
-        };
-
-        // Save config back to .yo-rc.json
-        const configPath = this.destinationPath('.yo-rc.json');
-        const fs = require('fs');
-        if (fs.existsSync(configPath)) {
-            const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
-            if (!config['generator-jhipster']) {
-                config['generator-jhipster'] = {};
-            }
-            config['generator-jhipster'].sentry = this.jhipsterAppConfig.sentry;
-            fs.writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n');
-        }
 
-        /* -------------------------------
-         * 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--- 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');
-
-        if (!this.promptAnswers.enableSentry) {
-            this.log(chalk.yellow('Sentry is disabled — skipping integration'));
-            return;
+// 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();
+const GeneratorBase = require(path.join(jhipsterRoot, 'generators', 'generator-base'));
+const jhipsterConstants = require(path.join(jhipsterRoot, 'generators', 'generator-constants'));
+const packageJson = require('../../package.json');
+
+module.exports = class extends GeneratorBase {
+  get initializing() {
+    return {
+      init(args) {
+        if (args === 'default') {
+          this.message = 'default message';
         }
+      },
 
-        /* -------------------------------
-         * Backend (Spring Boot)
-         * ----------------------------- */
-        if (this.buildTool === 'maven') {
-            this.addMavenDependency(
-                'io.sentry',
-                'sentry-spring-boot-starter',
-                '7.3.0'
-            );
+      readConfig() {
+        this.jhipsterAppConfig = this.getAllJhipsterConfig();
+        if (!this.jhipsterAppConfig) {
+          this.error('Cannot read .yo-rc.json');
         }
-
-        if (this.buildTool === 'gradle') {
-            this.addGradleDependency(
-                'implementation',
-                'io.sentry:sentry-spring-boot-starter:7.3.0'
-            );
-        }
-
-        this.template(
-            'server/sentry-application.yml.ejs',
-            `${resourceDir}config/sentry.yml`
+      },
+
+      displayLogo() {
+        this.printJHipsterLogo();
+        this.log(
+          `\nWelcome to the ${chalk.bold.yellow('JHipster Sentry Module')} generator! ${chalk.yellow(
+            `v${packageJson.version}\n`
+          )}`
         );
+      },
 
-        /* -------------------------------
-         * Frontend
-         * ----------------------------- */
-        if (this.clientFramework === 'react') {
-            this.addNpmDependency('@sentry/react', '^7.3.0');
+      checkJhipster() {
+        const currentJhipsterVersion = this.jhipsterAppConfig.jhipsterVersion;
+        const minimumJhipsterVersion = '>=8.0.0';
 
-            this.template(
-                'client/react/sentry.ts.ejs',
-                `${webappDir}app/sentry.ts`
-            );
+        if (!semver.satisfies(currentJhipsterVersion, minimumJhipsterVersion)) {
+          this.warning(
+            `\nYour generated project uses JHipster ${currentJhipsterVersion}. Minimum required is ${minimumJhipsterVersion}\n`
+          );
         }
+      }
+    };
+  }
+
+  async prompting() {
+    const prompts = [
+      {
+        type: 'confirm',
+        name: 'enableSentry',
+        message: 'Do you want to enable Sentry error tracking?',
+        default: true
+      },
+      {
+        when: answers => answers.enableSentry,
+        type: 'input',
+        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;
+
+    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;
+
+    // Persist Sentry config
+    this.jhipsterAppConfig.sentry = {
+      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);
+    }
 
-        if (this.clientFramework === 'angularX') {
-            this.addNpmDependency('@sentry/angular', '^7.3.0');
+    // 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--- 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');
+
+    if (!this.promptAnswers.enableSentry) {
+      this.log(chalk.yellow('Sentry is disabled — skipping integration'));
+      return;
+    }
 
-            this.template(
-                'client/angular/sentry.ts.ejs',
-                `${webappDir}app/sentry.ts`
-            );
-        }
+    // Backend
+    if (this.buildTool === 'maven') {
+      this.addMavenDependency('io.sentry', 'sentry-spring-boot-starter', '7.3.0');
+    }
+    if (this.buildTool === 'gradle') {
+      this.addGradleDependency('implementation', 'io.sentry:sentry-spring-boot-starter:7.3.0');
+    }
+    this.template('server/sentry-application.yml.ejs', `${resourceDir}config/sentry.yml`);
 
-        /* -------------------------------
-         * 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`
-            );
-        }
+    // Frontend
+    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`);
     }
 
-    install() {
-        const logMsg = `To install dependencies manually, run: ${chalk.yellow.bold(
-            `${this.clientPackageManager} install`
-        )}`;
+    // 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`);
+    }
+  }
 
-        if (this.options['skip-install']) {
-            this.log(logMsg);
-            return;
-        }
+  install() {
+    const logMsg = `To install dependencies manually, run: ${chalk.yellow.bold(
+      `${this.clientPackageManager} install`
+    )}`;
 
-        this.installDependencies({
-            npm: this.clientPackageManager === 'npm',
-            yarn: this.clientPackageManager === 'yarn',
-            bower: false
-        });
+    if (this.options['skip-install']) {
+      this.log(logMsg);
+      return;
     }
 
-    end() {
-        this.log(chalk.green('✔ Sentry module generation complete'));
-    }
-};
+    this.installDependencies({
+      npm: this.clientPackageManager === 'npm',
+      yarn: this.clientPackageManager === 'yarn',
+      bower: false
+    });
+  }
+
+  end() {
+    this.log(chalk.green('✔ Sentry module generation complete'));
+  }
+};

package/generators/app/templates/client/angular/sentry.ts.ejs

@@ -1,6 +1,6 @@
-import * as Sentry from '@sentry/angular';
-
-Sentry.init({
-  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
-  environment: 'dev',
-});
+import * as Sentry from '@sentry/angular';
+
+Sentry.init({
+  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
+  environment: 'dev',
+});

package/generators/app/templates/client/react/sentry.ts.ejs

@@ -1,6 +1,6 @@
-import * as Sentry from '@sentry/react';
-
-Sentry.init({
-  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
-  environment: 'dev',
-});
+import * as Sentry from '@sentry/react';
+
+Sentry.init({
+  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
+  environment: 'dev',
+});

package/generators/app/templates/server/sentry-application.yml.ejs

@@ -1,4 +1,4 @@
-sentry:
-  dsn: "<%= jhipsterAppConfig.sentry.dsn %>"
-  environment: dev
-  traces-sample-rate: 0.2
+sentry:
+  dsn: "<%= jhipsterAppConfig.sentry.dsn %>"
+  environment: dev
+  traces-sample-rate: 0.2

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "generator-jhipster-sentry-module",
-  "version": "1.0.0",
-  "description": "adding sentry to jhipster generator",
+  "version": "1.0.2",
+  "description": "Adding Sentry integration to JHipster projects",
   "keywords": [
     "yeoman-generator",
     "jhipster-module",
+    "jhipster-generator",
     "jhipster",
     "jhipster-6",
     "jhipster-blueprint",
@@ -20,32 +21,36 @@
   "files": [
     "generators"
   ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "main": "generators/app/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Sara/generator-jhipster-sentry-module.git"
   },
   "dependencies": {
-    "chalk": "3.0.0",
-    "generator-jhipster": ">=6.0.0",
-    "mkdirp": "0.5.1",
-    "semver": "7.1.1",
-    "shelljs": "0.8.3",
-    "yeoman-generator": "4.4.0"
+    "chalk": "^5.3.0",
+    "mkdirp": "^1.0.4",
+    "semver": "^7.5.4",
+    "shelljs": "^0.8.5",
+    "yeoman-generator": "^5.10.0"
+  },
+  "peerDependencies": {
+    "generator-jhipster": ">=8.0.0"
   },
   "devDependencies": {
-    "eslint": "6.8.0",
-    "eslint-config-airbnb-base": "14.0.0",
-    "eslint-config-prettier": "6.9.0",
-    "eslint-plugin-import": "2.19.1",
-    "eslint-plugin-prettier": "3.1.2",
-    "fs-extra": "8.1.0",
-    "husky": "3.1.0",
-    "lint-staged": "9.5.0",
-    "mocha": "6.2.2",
-    "prettier": "1.19.1",
-    "yeoman-assert": "3.1.1",
-    "yeoman-test": "2.0.0"
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "fs-extra": "^11.2.0",
+    "mocha": "^10.4.0",
+    "prettier": "^3.2.5",
+    "yeoman-assert": "^3.1.1",
+    "husky": "^8.0.2",
+    "lint-staged": "^13.2.1"
   },
   "scripts": {
     "prettier:format": "prettier --write \"{,**/}*.{js,json,md,yml}\"",