birc-generator 0.9.0 → 1.0.0

package/lib/project.js

@@ -0,0 +1,234 @@
+const fs = require('fs');
+const path = require('path');
+const { randomBytes, randomInt } = require('node:crypto');
+const { projectConfigMissingMessage, toPascalCaseName } = require('../bin/cli-util');
+
+// .env 的 DB 密碼用：16 碼混合大小寫英文 + 數字，隨機生成，避免 change_me 這種預設值。
+function randomDbPassword() {
+  const chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+  return Array.from({ length: 16 }, () => chars[randomInt(chars.length)]).join('');
+}
+
+// HS256 要 256 bit。48 bytes 的 base64 跟 openssl rand -base64 48 一樣長。
+function randomJwtSecret() {
+  return randomBytes(48).toString('base64');
+}
+
+function fillJwtSecretInEnv(envPath, secret) {
+  if (!fs.existsSync(envPath)) {
+    fs.writeFileSync(envPath, `JWT_SECRET=${secret}\n`);
+    return 'created .env with JWT_SECRET';
+  }
+  const text = fs.readFileSync(envPath, 'utf8');
+  const match = text.match(/^JWT_SECRET=(.*)$/m);
+  if (match && match[1].trim() !== '') {
+    return 'skipped (JWT_SECRET already set)';
+  }
+  if (match) {
+    fs.writeFileSync(envPath, text.replace(/^JWT_SECRET=.*$/m, `JWT_SECRET=${secret}`));
+    return 'filled JWT_SECRET';
+  }
+  const suffix = text.endsWith('\n') ? '' : '\n';
+  fs.writeFileSync(envPath, `${text}${suffix}JWT_SECRET=${secret}\n`);
+  return 'appended JWT_SECRET';
+}
+
+function projectRoot() {
+  return process.env.BIRC_PROJECT_ROOT || process.cwd();
+}
+
+function projectConfigPath() {
+  return path.join(projectRoot(), '.bircrc.json');
+}
+
+function loadProjectConfig() {
+  const configPath = projectConfigPath();
+  if (!fs.existsSync(configPath)) {
+    throw new Error(projectConfigMissingMessage());
+  }
+  return JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+}
+
+function detectMultiModule(config) {
+  if (typeof config.multiModule === 'boolean') {
+    return config.multiModule;
+  }
+  if (config.daoPath && String(config.daoPath).includes('database-config')) {
+    return true;
+  }
+  const modulesDir = path.join(projectRoot(), 'modules');
+  if (!fs.existsSync(modulesDir)) {
+    return false;
+  }
+  return fs.readdirSync(modulesDir).some((name) => name.endsWith('-database-config'));
+}
+
+function inferProjectNameKebab(config) {
+  if (config.projectNameKebab) {
+    return config.projectNameKebab;
+  }
+  const modulesDir = path.join(projectRoot(), 'modules');
+  if (fs.existsSync(modulesDir)) {
+    const match = fs.readdirSync(modulesDir).find((name) => name.endsWith('-database-config'));
+    if (match) {
+      return match.replace(/-database-config$/, '');
+    }
+  }
+  return path.basename(projectRoot());
+}
+
+function persistenceLayout(basePackage, { multiModule, projectNameKebab, srcPath }) {
+  const basePackagePath = basePackage.replace(/\./g, '/');
+  const src = srcPath || 'src/main/java';
+  if (multiModule) {
+    const dbRoot = `modules/${projectNameKebab}-database-config/src/main/java/${basePackagePath}/databaseconfig`;
+    return {
+      entityPackage: `${basePackage}.databaseconfig.entity`,
+      daoPackage: `${basePackage}.databaseconfig.dao`,
+      entityRoot: `${dbRoot}/entity`,
+      daoRoot: `${dbRoot}/dao`
+    };
+  }
+  return {
+    entityPackage: `${basePackage}.entity`,
+    daoPackage: `${basePackage}.dao`,
+    entityRoot: `${src}/${basePackagePath}/entity`,
+    daoRoot: `${src}/${basePackagePath}/dao`
+  };
+}
+
+function resolvePersistence(config) {
+  if (config.entityPath && config.daoPath && config.entityPackage && config.daoPackage) {
+    return {
+      entityPackage: config.entityPackage,
+      daoPackage: config.daoPackage,
+      entityRoot: config.entityPath,
+      daoRoot: config.daoPath
+    };
+  }
+  return persistenceLayout(config.basePackage, {
+    multiModule: detectMultiModule(config),
+    projectNameKebab: inferProjectNameKebab(config),
+    srcPath: config.srcPath
+  });
+}
+
+function toKebab(name) {
+  return String(name || '')
+    .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+    .replace(/[\s_]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .toLowerCase();
+}
+
+const JAVA_RESERVED_WORDS = new Set([
+  'abstract', 'assert', 'boolean', 'break', 'byte', 'case', 'catch', 'char', 'class',
+  'const', 'continue', 'default', 'do', 'double', 'else', 'enum', 'exports', 'extends',
+  'false', 'final', 'finally', 'float', 'for', 'goto', 'if', 'implements', 'import',
+  'instanceof', 'int', 'interface', 'long', 'module', 'native', 'new', 'non-sealed',
+  'null', 'open', 'opens', 'package', 'permits', 'private', 'protected', 'provides',
+  'public', 'record', 'requires', 'return', 'sealed', 'short', 'static', 'strictfp',
+  'super', 'switch', 'synchronized', 'this', 'throw', 'throws', 'to', 'transient',
+  'transitive', 'true', 'try', 'uses', 'var', 'void', 'volatile', 'while', 'with',
+  'yield', '_'
+]);
+
+const CREATE_DEFAULTS = Object.freeze({
+  projectName: 'Practice',
+  basePackage: 'tw.edu.ntub.birc.practice'
+});
+
+function validateProjectName(value) {
+  const projectName = toKebab(value);
+  if (!projectName) {
+    return '專案名稱轉成 kebab-case 後不可為空。';
+  }
+  if (!/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(projectName)) {
+    return '專案名稱只能包含英文字母、數字、空白、底線或連字號。';
+  }
+  return true;
+}
+
+function validateJavaPackage(value) {
+  const packageName = String(value || '').trim();
+  if (!packageName) {
+    return 'Base package 不可為空。';
+  }
+  const segments = packageName.split('.');
+  if (segments.some((segment) => !/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(segment))) {
+    return 'Base package 的每一段都必須是合法 Java identifier。';
+  }
+  if (segments.some((segment) => JAVA_RESERVED_WORDS.has(segment))) {
+    return 'Base package 不可使用 Java 保留字。';
+  }
+  return true;
+}
+
+function validatePascalCase(value) {
+  return /^[A-Z][A-Za-z0-9]*$/.test(toPascalCaseName(value))
+    ? true
+    : '名稱必須是英文字母開頭，例如 Activity 或 activity。';
+}
+
+function validateMigrationName(value) {
+  const raw = String(value || '').trim();
+  if (!raw) return '遷移名稱不可為空。';
+  // 白名單擋掉 SQL 特殊字元與路徑字元：名稱會進 Flyway SQL 與檔名。
+  return /^[a-zA-Z0-9_]+$/.test(raw)
+    ? true
+    : '遷移名稱只能包含英文字母、數字和底線，例如 create_users_table。';
+}
+
+const YML_ANCHOR = '# birc-generator:config-anchor';
+const GRADLE_ANCHOR = '// birc-generator:dependency-anchor';
+const GRADLE_PLUGIN_ANCHOR = '// birc-generator:plugin-anchor';
+const GRADLE_ALLPROJECTS_ANCHOR = '// birc-generator:allprojects-anchor';
+
+// 插進 yml / gradle 的每段 fragment 都用成對 marker 包起來，這樣才知道它從哪裡到哪裡。
+// 只有開頭 anchor 的話，冪等只能靠比對整段文字，template 改一個字就會重複插；
+// 也沒有辦法把某個 feature 的設定再拿掉。
+function fragmentMarkers(commentToken, marker) {
+  return {
+    begin: `${commentToken} birc:begin:${marker}`,
+    end: `${commentToken} birc:end:${marker}`
+  };
+}
+
+function requireGradleAnchor(errors, featureKey, destBase, gradlePath, anchor) {
+  const target = path.resolve(destBase, gradlePath);
+  if (!fs.existsSync(target)) {
+    errors.push(`${featureKey}: 找不到 ${gradlePath}`);
+  } else if (!fs.readFileSync(target, 'utf8').includes(anchor)) {
+    errors.push(`${featureKey}: ${gradlePath} 沒有 ${anchor}`);
+  }
+}
+
+function gradleAnchorPattern(anchor) {
+  return new RegExp(`${anchor.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}\\n`);
+}
+
+module.exports = {
+  randomDbPassword,
+  randomJwtSecret,
+  fillJwtSecretInEnv,
+  projectRoot,
+  projectConfigPath,
+  loadProjectConfig,
+  detectMultiModule,
+  inferProjectNameKebab,
+  persistenceLayout,
+  resolvePersistence,
+  toKebab,
+  CREATE_DEFAULTS,
+  validateProjectName,
+  validateJavaPackage,
+  validatePascalCase,
+  validateMigrationName,
+  YML_ANCHOR,
+  GRADLE_ANCHOR,
+  GRADLE_PLUGIN_ANCHOR,
+  GRADLE_ALLPROJECTS_ANCHOR,
+  fragmentMarkers,
+  requireGradleAnchor,
+  gradleAnchorPattern
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "birc-generator",
-  "version": "0.9.0",
+  "version": "1.0.0",
   "description": "Spring Boot 4 CRUD scaffold generator built on Plop.js",
   "license": "MIT",
   "author": "lucashsu95",
@@ -20,6 +20,7 @@
   "files": [
     "bin",
     "plopfile.js",
+    "lib",
     "versions.js",
     "templates",
     "project-docs",
@@ -43,12 +44,14 @@
   "c8": {
     "include": [
       "plopfile.js",
+      "lib",
       "versions.js",
       "bin/cli-util.js"
     ],
     "reporter": [
       "text",
-      "json-summary"
+      "json-summary",
+      "cobertura"
     ],
     "check-coverage": true,
     "lines": 80,
@@ -62,7 +65,6 @@
     "plop": "^4.0.1"
   },
   "dependencies": {
-    "js-yaml": "^5.3.0",
     "node-plop": "^0.32.3"
   }
 }