birc-generator 0.5.5

package/bin/cli-util.js

@@ -0,0 +1,428 @@
+const fs = require('fs');
+const path = require('path');
+const { spawnSync } = require('child_process');
+
+function pathForBash(filePath, ostype) {
+  const withSlashes = String(filePath || '').replace(/\\/g, '/');
+  const match = withSlashes.match(/^([A-Za-z]):\/(.*)$/);
+  if (!match) {
+    return withSlashes;
+  }
+  const drive = match[1].toLowerCase();
+  const rest = match[2];
+  const type = String(ostype || '').toLowerCase();
+  if (type.includes('msys') || type.includes('cygwin') || type.includes('mingw')) {
+    return `/${drive}/${rest}`;
+  }
+  return `/mnt/${drive}/${rest}`;
+}
+
+function bashOstype() {
+  const result = spawnSync('bash', ['-c', 'printf %s "$OSTYPE"'], {
+    encoding: 'utf8',
+    timeout: 8000
+  });
+  if (result.error) {
+    throw result.error;
+  }
+  if (result.status !== 0) {
+    throw new Error(result.stderr ? String(result.stderr).trim() : 'bash 結束狀態非 0');
+  }
+  return (result.stdout || '').trim();
+}
+
+function resolveGradleWrapper(root, platform = process.platform, exists = fs.existsSync) {
+  const unixWrapper = path.join(root, 'gradlew');
+  const windowsWrapper = path.join(root, 'gradlew.bat');
+  if (platform === 'win32') {
+    if (exists(windowsWrapper)) {
+      return { command: windowsWrapper, shell: true };
+    }
+    return null;
+  }
+  if (exists(unixWrapper)) {
+    return { command: unixWrapper, shell: false };
+  }
+  return null;
+}
+
+function gradleWrapperMissingMessage(platform = process.platform) {
+  return platform === 'win32'
+    ? '找不到 gradlew.bat，請在 birc create 產出的專案根目錄執行。'
+    : '找不到 ./gradlew，請在 birc create 產出的專案根目錄執行。';
+}
+
+function projectConfigMissingMessage() {
+  return '找不到 .bircrc.json，先在專案根目錄建立設定檔（可複製 .bircrc.example.json 改名，或用 birc create 建新專案）';
+}
+
+function findProjectRoot(startDir, exists = fs.existsSync) {
+  let current = path.resolve(startDir || '');
+  const { root } = path.parse(current);
+  while (true) {
+    if (exists(path.join(current, '.bircrc.json'))) {
+      return current;
+    }
+    if (current === root) {
+      return null;
+    }
+    const parent = path.dirname(current);
+    if (parent === current) {
+      return null;
+    }
+    current = parent;
+  }
+}
+
+function toKebabName(value) {
+  return String(value || '')
+    .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+    .replace(/[\s_]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .toLowerCase();
+}
+
+function deriveBasePackage(projectName) {
+  const kebab = toKebabName(projectName);
+  if (!kebab) {
+    return null;
+  }
+  return `tw.edu.ntub.birc.${kebab.replace(/-/g, '.')}`;
+}
+
+function featureAliasMap(featureKeys) {
+  const aliases = new Map();
+  for (const key of featureKeys || []) {
+    aliases.set(key, key);
+    aliases.set(String(key).toLowerCase(), key);
+    aliases.set(toKebabName(key), key);
+  }
+  return aliases;
+}
+
+function resolveFeatureArgs(args, featureKeys) {
+  const names = Array.isArray(args) ? args : [];
+  if (names.length === 0) {
+    return { keys: null };
+  }
+  const aliases = featureAliasMap(featureKeys);
+  const keys = [];
+  const unknown = [];
+  for (const name of names) {
+    const key = aliases.get(String(name)) || aliases.get(String(name).toLowerCase());
+    if (!key) {
+      unknown.push(name);
+    } else if (!keys.includes(key)) {
+      keys.push(key);
+    }
+  }
+  if (unknown.length > 0) {
+    const knownNames = [];
+    for (const key of featureKeys || []) {
+      knownNames.push(key);
+      const kebab = toKebabName(key);
+      if (kebab && kebab !== key) knownNames.push(kebab);
+    }
+    const suggestions = [...new Set(
+      unknown.map((name) => suggestCommand(name, knownNames)).filter(Boolean)
+    )];
+    const lines = [`找不到功能: ${unknown.join(', ')}`];
+    if (suggestions.length > 0) {
+      lines.push(`你要的大概是 ${suggestions.join('、')}。`);
+    }
+    lines.push(`可用: ${(featureKeys || []).join(', ')}`);
+    return { error: lines.join('\n') };
+  }
+  return { keys };
+}
+
+function applyAddFeatureArgs(prompts, args, featureKeys) {
+  const resolved = resolveFeatureArgs(args, featureKeys);
+  if (resolved.error || !resolved.keys) {
+    return resolved;
+  }
+  for (const prompt of prompts || []) {
+    if (prompt.name === 'features') {
+      prompt.when = () => false;
+    }
+    if (prompt.name === 'gitlabProjectPath' && typeof prompt.when === 'function') {
+      const originalWhen = prompt.when;
+      prompt.when = (answers) => originalWhen({ ...answers, features: resolved.keys });
+    }
+  }
+  return resolved;
+}
+
+function applyCreatePromptDefaults(prompts, positionals = []) {
+  const [projectName, basePackage] = positionals;
+  const derivedPackage = projectName ? deriveBasePackage(projectName) : null;
+  for (const prompt of prompts) {
+    if (prompt.name === 'projectName' && projectName) {
+      prompt.default = projectName;
+    }
+    if (prompt.name === 'basePackage') {
+      if (basePackage) {
+        prompt.default = basePackage;
+      } else if (derivedPackage) {
+        prompt.default = derivedPackage;
+      }
+    }
+  }
+  return prompts;
+}
+
+function applyCreateYes(prompts, positionals = [], defaultFeatures = []) {
+  applyCreatePromptDefaults(prompts, positionals);
+  const answers = {};
+  for (const prompt of prompts || []) {
+    prompt.when = () => false;
+    if (prompt.name === 'projectName') {
+      answers.projectName = prompt.default;
+    }
+    if (prompt.name === 'basePackage') {
+      answers.basePackage = typeof prompt.default === 'function'
+        ? prompt.default(answers)
+        : prompt.default;
+    }
+    if (prompt.name === 'features') {
+      answers.features = [...defaultFeatures];
+    }
+    if (prompt.name === 'injectDocs') {
+      answers.injectDocs = prompt.default !== undefined ? prompt.default : true;
+    }
+  }
+  return answers;
+}
+
+function alreadyExistsMessage(fail = {}) {
+  const err = String(fail.error || fail.message || '');
+  if (!/already exists/i.test(err)) {
+    return null;
+  }
+  const fromError = err.match(/->\s*(.+)$/m);
+  const rawPath = fail.path || (fromError && fromError[1].trim()) || '';
+  const fileName = path.basename(String(rawPath).trim());
+  if (!fileName) {
+    return '檔案已在，要覆寫用 --force';
+  }
+  return `${fileName} 已在，要覆寫用 --force`;
+}
+
+function fieldsWithoutExampleMessage(flags = {}) {
+  const hasFields = Boolean(String(flags.fields || '').trim());
+  if (!hasFields || flags.example) {
+    return null;
+  }
+  return '--fields 要配 --example 才會寫進 Entity';
+}
+
+function levenshtein(left, right) {
+  const a = String(left || '');
+  const b = String(right || '');
+  const rows = a.length + 1;
+  const cols = b.length + 1;
+  const prev = new Array(cols);
+  const cur = new Array(cols);
+  for (let j = 0; j < cols; j += 1) prev[j] = j;
+  for (let i = 1; i < rows; i += 1) {
+    cur[0] = i;
+    for (let j = 1; j < cols; j += 1) {
+      const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+      cur[j] = Math.min(prev[j] + 1, cur[j - 1] + 1, prev[j - 1] + cost);
+    }
+    for (let j = 0; j < cols; j += 1) prev[j] = cur[j];
+  }
+  return prev[b.length];
+}
+
+function suggestCommand(name, known) {
+  const raw = String(name || '');
+  if (!raw) return null;
+  const commands = known || [];
+  const colonNormalized = raw.replace(/::/g, ':');
+  if (colonNormalized !== raw && commands.includes(colonNormalized)) {
+    return colonNormalized;
+  }
+  const dashNormalized = colonNormalized.replace(/-/g, ':');
+  if (dashNormalized !== raw && commands.includes(dashNormalized)) {
+    return dashNormalized;
+  }
+  const needle = colonNormalized.toLowerCase();
+  let best = null;
+  let bestDist = Infinity;
+  for (const command of commands) {
+    const dist = levenshtein(needle, String(command).toLowerCase());
+    if (dist < bestDist) {
+      bestDist = dist;
+      best = command;
+    }
+  }
+  const maxDist = needle.length <= 4 ? 1 : 2;
+  if (best && bestDist > 0 && bestDist <= maxDist) {
+    return best;
+  }
+  return null;
+}
+
+function shouldPrintBanner(command, flags = {}) {
+  if (flags.help || flags.version || !command || command === 'help') {
+    return true;
+  }
+  return command === 'create';
+}
+
+function formatAddNextSteps(answers = {}, { changed } = {}) {
+  const features = answers.features || [];
+  if (features.length === 0) {
+    return ['', '沒有加入任何功能。用 space 勾選後 enter，或 birc add email。', ''];
+  }
+  if (!changed) {
+    return ['', '這些功能已安裝，沒有改檔。要覆寫用 birc add --force。', ''];
+  }
+  const lines = ['', `已加入 ${features.join('、')}。`];
+  if (features.includes('docker')) {
+    lines.push('啟動資料庫：docker compose up -d db');
+  }
+  lines.push('');
+  return lines;
+}
+
+function formatMakeNextSteps(name, answers = {}) {
+  const command = String(name || '');
+  const wantsMigrate = command === 'make:migration'
+    || command === 'migration'
+    || Boolean(answers.migration)
+    || Boolean(answers.seed);
+  if (wantsMigrate) {
+    return ['', '套用遷移：', '  birc migrate', ''];
+  }
+  if (command === 'make' || command.startsWith('make:')) {
+    return ['', '骨架已寫好。建表可加 --migration，再 birc migrate。', ''];
+  }
+  return [];
+}
+
+function applyMakeFieldsFlag(prompts, fields) {
+  const value = fields == null ? '' : String(fields).trim();
+  if (!value) {
+    return prompts;
+  }
+  for (const prompt of prompts || []) {
+    if (prompt.name === 'fields') {
+      prompt.when = () => false;
+      prompt.default = value;
+    }
+  }
+  return prompts;
+}
+
+function parseArgv(argv) {
+  const flags = {
+    help: false,
+    version: false,
+    force: false,
+    yes: false,
+    example: false,
+    dto: false,
+    mapper: false,
+    migration: false,
+    seed: false,
+    controller: false,
+    softDelete: false,
+    fields: undefined,
+    positionals: []
+  };
+  const suggestable = [
+    '--help', '--version', '--force', '--yes', '--example', '--dto', '--mapper',
+    '--migration', '--seed', '--controller', '--soft-delete', '--fields', '--dest'
+  ];
+  const args = Array.isArray(argv) ? argv : [];
+  for (let i = 0; i < args.length; i += 1) {
+    const arg = args[i];
+    if (arg === '-h' || arg === '--help') flags.help = true;
+    else if (arg === '-v' || arg === '--version') flags.version = true;
+    else if (arg === '-f' || arg === '--force') flags.force = true;
+    else if (arg === '-y' || arg === '--yes') flags.yes = true;
+    else if (arg === '--example' || arg === '--exmaple') flags.example = true;
+    else if (arg === '--dto') flags.dto = true;
+    else if (arg === '--mapper') flags.mapper = true;
+    else if (arg === '--migration') flags.migration = true;
+    else if (arg === '--seed') flags.seed = true;
+    else if (arg === '--controller') flags.controller = true;
+    else if (arg === '--soft-delete') flags.softDelete = true;
+    else if (arg === '--fields') {
+      const next = args[i + 1];
+      if (next && !next.startsWith('-')) {
+        flags.fields = next;
+        i += 1;
+      } else {
+        flags.fields = '';
+      }
+    } else if (arg.startsWith('--fields=')) {
+      flags.fields = arg.slice('--fields='.length);
+    } else if (arg === '--dest') {
+      i += 1;
+    } else if (String(arg).startsWith('-')) {
+      const name = String(arg).includes('=') ? String(arg).slice(0, String(arg).indexOf('=')) : arg;
+      const suggestion = suggestCommand(name, suggestable);
+      const lines = [`找不到選項: ${name}`];
+      if (suggestion) lines.push(`你要的大概是 ${suggestion}。`);
+      lines.push('看全部選項：birc --help');
+      return { error: lines.join('\n') };
+    } else {
+      flags.positionals.push(arg);
+    }
+  }
+  return { flags };
+}
+
+function createDestConflict({ cwd, projectName, exists = fs.existsSync } = {}) {
+  const root = path.resolve(cwd || '');
+  const marker = path.join(root, '.bircrc.json');
+  if (exists(marker)) {
+    return `這裡已經是 BIRC 專案（${marker}）。換一個空目錄再 birc create。`;
+  }
+  const dir = toKebabName(projectName);
+  if (!dir) return null;
+  const dest = path.join(root, dir);
+  if (exists(dest)) {
+    return `目標資料夾已存在：${dest}。換名稱，或刪掉後再 create。`;
+  }
+  return null;
+}
+
+function toPascalCaseName(value) {
+  const raw = String(value || '').trim();
+  if (!raw) return '';
+  return raw
+    .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+    .split(/[^A-Za-z0-9]+/)
+    .filter(Boolean)
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join('');
+}
+
+module.exports = {
+  pathForBash,
+  bashOstype,
+  resolveGradleWrapper,
+  gradleWrapperMissingMessage,
+  projectConfigMissingMessage,
+  findProjectRoot,
+  deriveBasePackage,
+  toKebabName,
+  resolveFeatureArgs,
+  applyAddFeatureArgs,
+  applyCreatePromptDefaults,
+  applyCreateYes,
+  alreadyExistsMessage,
+  fieldsWithoutExampleMessage,
+  suggestCommand,
+  shouldPrintBanner,
+  formatAddNextSteps,
+  formatMakeNextSteps,
+  applyMakeFieldsFlag,
+  toPascalCaseName,
+  parseArgv,
+  createDestConflict
+};