create-odoo-module 1.0.0

package/src/cli/index.js

@@ -0,0 +1,272 @@
+'use strict';
+
+const path    = require('path');
+const chalk   = require('chalk');
+const fs      = require('fs-extra');
+const ora     = require('ora');
+const boxen   = require('boxen');
+const figures = require('figures');
+
+const { askInteractiveQuestions } = require('./prompts');
+const { validateModuleName }      = require('./validator');
+const { parseExtraDepends }       = require('./args-parser');
+const { verifyProLicense }        = require('../utils/license-check');
+const { generateOdooModule }      = require('../generators/odoo-generator');
+const { generateFlutterApp }      = require('../generators/flutter-generator');
+const { generateApiLayer }        = require('../generators/api-generator');
+const { generateUiLayer }         = require('../generators/ui-generator');
+const { generateDeployScripts }   = require('../generators/deploy-generator');
+const { toSnakeCase, toPascalCase, toKebabCase } = require('../utils/string-utils');
+const logger  = require('../utils/logger');
+
+// ─── List templates ───────────────────────────────────────────────────────────
+function listTemplates() {
+  const templates = [
+    { name: 'fleet',     label: 'Fleet Management',   free: false, desc: 'Vehicle tracking, maintenance, fuel logs' },
+    { name: 'hr',        label: 'Human Resources',    free: false, desc: 'Employees, contracts, payroll, leaves' },
+    { name: 'inventory', label: 'Inventory',          free: false, desc: 'Products, lots, barcode scanner, moves' },
+    { name: 'pos',       label: 'Point of Sale',      free: false, desc: 'POS extension with custom payment methods' },
+    { name: 'crm',       label: 'CRM Pipeline',       free: false, desc: 'Leads, pipeline, activities, dashboard' },
+  ];
+
+  console.log(chalk.bold('\n  Available Templates:\n'));
+  templates.forEach(t => {
+    const badge = t.free ? chalk.green('[FREE]') : chalk.yellow('[PRO] ');
+    console.log(`  ${badge}  ${chalk.cyan(t.name.padEnd(12))} ${chalk.bold(t.label)}`);
+    console.log(`           ${chalk.dim(t.desc)}\n`);
+  });
+  console.log(chalk.dim('  Get Pro access → https://create-odoo-module.dev/pro\n'));
+}
+
+// ─── Main CLI runner ──────────────────────────────────────────────────────────
+async function runCLI(moduleName, options) {
+  logger.setVerbose(!!options.verbose);
+
+  // ── 1. Interactive mode when no module name given ─────────────────────────
+  if (!moduleName) {
+    if (options.interactive === false) {
+      logger.error('Module name is required when using --no-interactive');
+      process.exit(1);
+    }
+    const answers = await askInteractiveQuestions(null, options);
+    moduleName = answers.moduleName;
+    options = { ...options, ...answers };
+  }
+
+  // ── 2. Validate module name ───────────────────────────────────────────────
+  const validation = validateModuleName(moduleName);
+  if (!validation.valid) {
+    logger.error(`Invalid module name: ${validation.error}`);
+    logger.info('Module names must be lowercase with hyphens or underscores (e.g. fleet-manager)');
+    process.exit(1);
+  }
+
+  // ── 3. Gather remaining options interactively if needed ───────────────────
+  let config = buildConfig(moduleName, options);
+
+  if (options.interactive !== false && !hasMinimalFlags(options)) {
+    const answers = await askInteractiveQuestions(moduleName, options);
+    config = buildConfig(moduleName, { ...options, ...answers });
+  }
+
+  // ── 4. Pro license verification ───────────────────────────────────────────
+  if (config.proKey || config.template) {
+    logger.verbose('Verifying Pro license...');
+    const isValid = await verifyProLicense(config.proKey);
+    if (!isValid && config.template) {
+      logger.warn(`Template "${config.template}" requires a Pro license.`);
+      logger.info('Get Pro access → https://create-odoo-module.dev/pro');
+      config.template = null;
+    }
+  }
+
+  // ── 5. Target directory ───────────────────────────────────────────────────
+  const targetDir = path.resolve(process.cwd(), toKebabCase(moduleName));
+
+  if (await fs.pathExists(targetDir)) {
+    const { default: inquirer } = await import('inquirer');
+    const { overwrite } = await inquirer.prompt([{
+      type: 'confirm',
+      name: 'overwrite',
+      message: chalk.yellow(`Directory ${chalk.bold(toKebabCase(moduleName))} already exists. Overwrite?`),
+      default: false,
+    }]);
+    if (!overwrite) {
+      logger.info('Aborted.');
+      process.exit(0);
+    }
+    await fs.remove(targetDir);
+  }
+
+  // ── 6. Start generation ───────────────────────────────────────────────────
+  console.log();
+  logger.info(`Creating Odoo module: ${chalk.bold.cyan(config.moduleName)}`);
+  logger.info(`Target: ${chalk.dim(targetDir)}`);
+  console.log();
+
+  const steps = buildSteps(config);
+  let stepIndex = 0;
+
+  const spinner = ora({
+    spinner: 'dots2',
+    color: 'magenta',
+  });
+
+  try {
+    // Step: Odoo module
+    spinner.start(chalk.bold('Generating Odoo module...'));
+    await generateOdooModule(targetDir, config);
+    spinner.succeed(chalk.green(`${figures.tick} Odoo module`) + chalk.dim(` → odoo_module/`));
+
+    // Step: REST API
+    if (config.withApi) {
+      spinner.start(chalk.bold('Generating REST API controllers...'));
+      await generateApiLayer(targetDir, config);
+      spinner.succeed(chalk.green(`${figures.tick} REST API layer`) + chalk.dim(` → odoo_module/controllers/`));
+    }
+
+    // Step: XML Views & OWL
+    spinner.start(chalk.bold('Generating Odoo views...'));
+    await generateUiLayer(targetDir, config);
+    spinner.succeed(chalk.green(`${figures.tick} Odoo views`) + chalk.dim(` → odoo_module/views/`));
+
+    // Step: Flutter app
+    if (config.withUi) {
+      spinner.start(chalk.bold('Generating Flutter application...'));
+      await generateFlutterApp(targetDir, config);
+      spinner.succeed(chalk.green(`${figures.tick} Flutter app`) + chalk.dim(` → flutter_app/`));
+    }
+
+    // Step: Deploy scripts
+    spinner.start(chalk.bold('Generating deploy scripts...'));
+    await generateDeployScripts(targetDir, config);
+    spinner.succeed(chalk.green(`${figures.tick} Deploy scripts`) + chalk.dim(` → scripts/`));
+
+    // Step: Git init
+    if (options.git !== false) {
+      spinner.start(chalk.bold('Initializing git repository...'));
+      await initGitRepo(targetDir);
+      spinner.succeed(chalk.green(`${figures.tick} Git initialized`));
+    }
+
+    console.log();
+    printSuccessMessage(config, targetDir);
+
+  } catch (err) {
+    spinner.fail(chalk.red(`Generation failed: ${err.message}`));
+    logger.verbose(err.stack);
+    await fs.remove(targetDir).catch(() => {});
+    process.exit(1);
+  }
+}
+
+// ─── Build config object ──────────────────────────────────────────────────────
+function buildConfig(moduleName, options) {
+  const snake    = toSnakeCase(moduleName);
+  const pascal   = toPascalCase(moduleName);
+  const kebab    = toKebabCase(moduleName);
+  const odooModel = snake.replace(/_/g, '.');
+
+  return {
+    // Names
+    moduleName,
+    moduleNameSnake:  snake,
+    moduleNamePascal: pascal,
+    moduleNameKebab:  kebab,
+    moduleNameOdoo:   odooModel,      // e.g. fleet.manager
+    moduleNameClass:  pascal,         // e.g. FleetManager
+    moduleNameLabel:  pascal.replace(/([A-Z])/g, ' $1').trim(), // Fleet Manager
+
+    // Odoo config
+    odooVersion:  options.odooVersion || '17',
+    category:     options.category    || 'Custom',
+    author:       options.author      || 'Your Company',
+    website:      options.website     || 'https://yourcompany.com',
+    extraDepends: parseExtraDepends(options.depends || ''),
+
+    // Feature flags
+    withApi:     !!options.withApi,
+    withUi:      !!options.withUi,
+    withTests:   !!options.withTests,
+    withReports: !!options.withReports,
+    withOwl:     !!options.withOwl,
+    withWizard:  !!options.withWizard,
+    withDocker:  options.withDocker !== false,
+    withCi:      !!options.withCi,
+
+    // Pro
+    proKey:   options.proKey   || null,
+    template: options.template || null,
+
+    // Meta
+    year: new Date().getFullYear(),
+    generatedAt: new Date().toISOString(),
+  };
+}
+
+function hasMinimalFlags(options) {
+  return options.withApi || options.withUi || options.withTests ||
+         options.template || options.interactive === false;
+}
+
+function buildSteps(config) {
+  const steps = ['Odoo Module', 'XML Views'];
+  if (config.withApi)     steps.push('REST API');
+  if (config.withUi)      steps.push('Flutter App');
+  if (config.withReports) steps.push('QWeb Reports');
+  steps.push('Deploy Scripts', 'Git Init');
+  return steps;
+}
+
+// ─── Git init ─────────────────────────────────────────────────────────────────
+async function initGitRepo(dir) {
+  const { execa } = require('execa');
+  try {
+    await execa('git', ['init'], { cwd: dir });
+    await execa('git', ['add', '-A'], { cwd: dir });
+    await execa('git', ['commit', '--allow-empty', '-m', 'chore: initial commit from create-odoo-module'], { cwd: dir });
+  } catch (_) {
+    // git may not be installed — not fatal
+  }
+}
+
+// ─── Success message ──────────────────────────────────────────────────────────
+function printSuccessMessage(config, targetDir) {
+  const dirName = path.basename(targetDir);
+
+  const lines = [
+    chalk.green.bold(`${figures.tick} Your Odoo project is ready!`),
+    '',
+    chalk.bold('Get started:'),
+    `  ${chalk.cyan(`cd ${dirName}`)}`,
+    `  ${chalk.cyan('cp .env.example .env')}   ${chalk.dim('← add your credentials')}`,
+    config.withDocker
+      ? `  ${chalk.cyan('npm run dev')}            ${chalk.dim('← start local Odoo via Docker')}`
+      : '',
+    `  ${chalk.cyan('npm run deploy')}         ${chalk.dim('← upload module to Odoo')}`,
+    config.withUi
+      ? `  ${chalk.cyan('npm run flutter:run')}    ${chalk.dim('← start Flutter app')}`
+      : '',
+    '',
+    chalk.bold('What was generated:'),
+    `  ${chalk.yellow('odoo_module/')}  Full Odoo Python module`,
+    config.withApi     ? `  ${chalk.yellow('controllers/')}  REST API (GET/POST/PUT/DELETE)` : '',
+    config.withUi      ? `  ${chalk.yellow('flutter_app/')}  Production-ready Flutter app` : '',
+    config.withReports ? `  ${chalk.yellow('report/')}       QWeb PDF reports` : '',
+    `  ${chalk.yellow('scripts/')}      Deploy + Docker Compose`,
+    '',
+    `${chalk.dim('Docs:')}  https://create-odoo-module.dev/docs`,
+    `${chalk.dim('Pro:')}   https://create-odoo-module.dev/pro`,
+  ].filter(l => l !== '');
+
+  console.log(
+    boxen(lines.join('\n'), {
+      padding: 1,
+      margin: { top: 0, bottom: 1, left: 0, right: 0 },
+      borderStyle: 'round',
+      borderColor: 'green',
+    })
+  );
+}
+
+module.exports = { runCLI, listTemplates };

package/src/cli/prompts.js

@@ -0,0 +1,151 @@
+'use strict';
+
+const chalk = require('chalk');
+
+/**
+ * Interactive CLI prompts using Inquirer.js
+ * Runs when user calls `npx create-odoo-module` without sufficient flags.
+ */
+async function askInteractiveQuestions(moduleName, existingOptions = {}) {
+  // Inquirer v9+ is ESM — dynamic import required
+  const { default: inquirer } = await import('inquirer');
+
+  const questions = [];
+
+  // ── Module name ────────────────────────────────────────────────────────────
+  if (!moduleName) {
+    questions.push({
+      type: 'input',
+      name: 'moduleName',
+      message: chalk.cyan('Module name') + chalk.dim(' (e.g. fleet-manager):'),
+      validate: (input) => {
+        if (!input.trim()) return 'Module name is required';
+        if (!/^[a-z][a-z0-9_-]*$/.test(input.trim())) {
+          return 'Use lowercase letters, numbers, hyphens or underscores only';
+        }
+        return true;
+      },
+      filter: (input) => input.trim().toLowerCase(),
+    });
+  }
+
+  // ── Odoo version ───────────────────────────────────────────────────────────
+  questions.push({
+    type: 'list',
+    name: 'odooVersion',
+    message: chalk.cyan('Odoo version:'),
+    choices: [
+      { name: '18.0  (latest)', value: '18' },
+      { name: '17.0  (stable) ← recommended', value: '17' },
+      { name: '16.0  (LTS)',   value: '16' },
+    ],
+    default: '17',
+    when: !existingOptions.odooVersion,
+  });
+
+  // ── Features to include ────────────────────────────────────────────────────
+  questions.push({
+    type: 'checkbox',
+    name: 'features',
+    message: chalk.cyan('Select features to include:'),
+    choices: [
+      {
+        name: `${chalk.bold('REST API')}           ${chalk.dim('GET/POST/PUT/DELETE endpoints')}`,
+        value: 'withApi',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('Flutter App')}        ${chalk.dim('Mobile app with login + CRUD')}`,
+        value: 'withUi',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('Unit Tests')}         ${chalk.dim('Python pytest + Dart flutter_test')}`,
+        value: 'withTests',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('QWeb Reports')}       ${chalk.dim('PDF report template')}`,
+        value: 'withReports',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('OWL Components')}     ${chalk.dim('JavaScript UI widgets')}`,
+        value: 'withOwl',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('Wizard')}             ${chalk.dim('Transient model dialog')}`,
+        value: 'withWizard',
+        checked: false,
+      },
+      {
+        name: `${chalk.bold('Docker Compose')}     ${chalk.dim('Local Odoo dev environment')}`,
+        value: 'withDocker',
+        checked: true,
+      },
+      {
+        name: `${chalk.bold('GitHub Actions CI')}  ${chalk.dim('Automated testing pipeline')}`,
+        value: 'withCi',
+        checked: false,
+      },
+    ],
+  });
+
+  // ── Author info ────────────────────────────────────────────────────────────
+  questions.push(
+    {
+      type: 'input',
+      name: 'author',
+      message: chalk.cyan('Author / Company name:'),
+      default: existingOptions.author || 'Your Company',
+    },
+    {
+      type: 'input',
+      name: 'category',
+      message: chalk.cyan('Odoo app category:'),
+      default: existingOptions.category || 'Custom',
+      choices: ['Custom', 'Accounting', 'CRM', 'Human Resources', 'Inventory', 'Manufacturing', 'Sales', 'Website'],
+    }
+  );
+
+  // ── Server URL (for .env pre-fill) ────────────────────────────────────────
+  questions.push({
+    type: 'input',
+    name: 'odooUrl',
+    message: chalk.cyan('Odoo server URL') + chalk.dim(' (for .env):'),
+    default: 'http://localhost:8069',
+  });
+
+  questions.push({
+    type: 'input',
+    name: 'odooDb',
+    message: chalk.cyan('Odoo database name') + chalk.dim(' (for .env):'),
+    default: 'odoo',
+  });
+
+  // ─────────────────────────────────────────────────────────────────────────
+  const answers = await inquirer.prompt(questions);
+
+  // Flatten features array into boolean flags
+  const features = answers.features || [];
+
+  return {
+    moduleName:   answers.moduleName  || moduleName,
+    odooVersion:  answers.odooVersion || existingOptions.odooVersion || '17',
+    author:       answers.author      || existingOptions.author,
+    category:     answers.category    || existingOptions.category,
+    odooUrl:      answers.odooUrl     || 'http://localhost:8069',
+    odooDb:       answers.odooDb      || 'odoo',
+    withApi:      features.includes('withApi')     || !!existingOptions.withApi,
+    withUi:       features.includes('withUi')      || !!existingOptions.withUi,
+    withTests:    features.includes('withTests')   || !!existingOptions.withTests,
+    withReports:  features.includes('withReports') || !!existingOptions.withReports,
+    withOwl:      features.includes('withOwl')     || !!existingOptions.withOwl,
+    withWizard:   features.includes('withWizard')  || !!existingOptions.withWizard,
+    withDocker:   features.includes('withDocker')  !== false,
+    withCi:       features.includes('withCi')      || !!existingOptions.withCi,
+  };
+}
+
+module.exports = { askInteractiveQuestions };

package/src/cli/validator.js

@@ -0,0 +1,72 @@
+'use strict';
+
+const RESERVED_NAMES = new Set([
+  'base', 'web', 'mail', 'portal', 'website', 'sale', 'purchase',
+  'account', 'stock', 'hr', 'crm', 'project', 'mrp', 'point_of_sale',
+  'fleet', 'maintenance', 'helpdesk', 'sign', 'survey', 'timesheet',
+  'node_modules', 'dist', 'build', 'src', 'test', 'tests', 'public',
+  'static', 'assets', 'config', 'setup', 'install', 'odoo', 'openerp',
+]);
+
+const MAX_LENGTH = 64;
+const MIN_LENGTH = 2;
+
+/**
+ * Validate an Odoo module name.
+ * Rules:
+ *  - Lowercase letters, digits, hyphens, underscores only
+ *  - Must start with a letter
+ *  - Length between 2 and 64 chars
+ *  - Not a reserved Odoo core module name
+ *
+ * @param {string} name
+ * @returns {{ valid: boolean, error?: string, warnings?: string[] }}
+ */
+function validateModuleName(name) {
+  if (typeof name !== 'string' || !name) {
+    return { valid: false, error: 'Module name must be a non-empty string' };
+  }
+
+  const trimmed = name.trim();
+
+  if (trimmed.length < MIN_LENGTH) {
+    return { valid: false, error: `Module name must be at least ${MIN_LENGTH} characters` };
+  }
+
+  if (trimmed.length > MAX_LENGTH) {
+    return { valid: false, error: `Module name must be at most ${MAX_LENGTH} characters` };
+  }
+
+  if (!/^[a-z]/.test(trimmed)) {
+    return { valid: false, error: 'Module name must start with a lowercase letter' };
+  }
+
+  if (!/^[a-z][a-z0-9_-]*$/.test(trimmed)) {
+    return {
+      valid: false,
+      error: 'Module name may only contain lowercase letters, digits, hyphens (-) and underscores (_)',
+    };
+  }
+
+  const snakeName = trimmed.replace(/-/g, '_');
+  if (RESERVED_NAMES.has(snakeName) || RESERVED_NAMES.has(trimmed)) {
+    return {
+      valid: false,
+      error: `"${trimmed}" is a reserved Odoo module name. Choose a more specific name (e.g. custom-fleet-manager)`,
+    };
+  }
+
+  const warnings = [];
+
+  if (trimmed.startsWith('custom_') || trimmed.startsWith('custom-')) {
+    warnings.push('Prefix "custom_" is redundant — consider removing it');
+  }
+
+  if (trimmed.includes('--') || trimmed.includes('__')) {
+    warnings.push('Consecutive separators (-- or __) may cause issues');
+  }
+
+  return { valid: true, name: trimmed, warnings };
+}
+
+module.exports = { validateModuleName };

package/src/config/defaults.js

@@ -0,0 +1,41 @@
+'use strict';
+
+/**
+ * Default configuration values used throughout the CLI.
+ */
+const DEFAULTS = {
+  odooVersion:  '17',
+  author:       'Your Company',
+  website:      'https://yourcompany.com',
+  category:     'Custom',
+  license:      'LGPL-3',
+  withApi:      false,
+  withUi:       false,
+  withTests:    false,
+  withReports:  false,
+  withOwl:      false,
+  withWizard:   false,
+  withDocker:   true,
+  withCi:       false,
+};
+
+/**
+ * Core Odoo module depends — always included.
+ */
+const CORE_DEPENDS = ['base', 'mail', 'web'];
+
+/**
+ * Odoo version → compatibility_date mapping.
+ */
+const COMPATIBILITY_DATES = {
+  '16': '2023-01-01',
+  '17': '2024-01-01',
+  '18': '2025-01-01',
+};
+
+/**
+ * Supported Pro templates.
+ */
+const PRO_TEMPLATES = ['fleet', 'hr', 'inventory', 'pos', 'crm'];
+
+module.exports = { DEFAULTS, CORE_DEPENDS, COMPATIBILITY_DATES, PRO_TEMPLATES };

package/src/config/pro-config.js

@@ -0,0 +1,55 @@
+'use strict';
+
+/**
+ * Pro template metadata.
+ * Each entry describes what extra depends, models, and features
+ * a Pro template adds on top of the base scaffold.
+ */
+const PRO_TEMPLATE_CONFIG = {
+  fleet: {
+    label:       'Fleet Management',
+    description: 'Vehicle tracking, maintenance schedules, fuel logs, driver assignments',
+    depends:     ['fleet', 'maintenance'],
+    models:      ['vehicle', 'maintenance_request', 'fuel_log'],
+    hasReports:  true,
+    hasDashboard: true,
+  },
+  hr: {
+    label:       'Human Resources',
+    description: 'Employees, contracts, payroll integration, leave management',
+    depends:     ['hr', 'hr_payroll', 'hr_holidays'],
+    models:      ['employee_extension', 'contract_extension'],
+    hasReports:  true,
+    hasDashboard: true,
+  },
+  inventory: {
+    label:       'Inventory',
+    description: 'Products, lots/serials, barcode scanner, stock moves',
+    depends:     ['stock', 'product'],
+    models:      ['product_extension', 'stock_move_extension'],
+    hasReports:  true,
+    hasDashboard: false,
+  },
+  pos: {
+    label:       'Point of Sale',
+    description: 'POS session extension, custom payment methods, receipt customization',
+    depends:     ['point_of_sale'],
+    models:      ['pos_order_extension', 'pos_config_extension'],
+    hasReports:  true,
+    hasDashboard: false,
+  },
+  crm: {
+    label:       'CRM Pipeline',
+    description: 'Leads, pipeline stages, activities, OWL dashboard with charts',
+    depends:     ['crm', 'sale_crm'],
+    models:      ['crm_lead_extension', 'crm_stage_extension'],
+    hasReports:  false,
+    hasDashboard: true,
+  },
+};
+
+function getProTemplateConfig(templateName) {
+  return PRO_TEMPLATE_CONFIG[templateName] || null;
+}
+
+module.exports = { PRO_TEMPLATE_CONFIG, getProTemplateConfig };