@toolstackhq/create-qa-patterns 1.0.14 → 1.0.15

package/lib/args.js

@@ -0,0 +1,139 @@
+const path = require('node:path');
+
+function parseCliOptions(args, { resolveTemplate, supportedTemplateIds }) {
+  const options = {
+    yes: false,
+    noInstall: false,
+    noSetup: false,
+    noTest: false,
+    safe: false,
+    templateName: null,
+    positionalArgs: []
+  };
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+
+    switch (arg) {
+      case '--yes':
+        options.yes = true;
+        break;
+      case '--no-install':
+        options.noInstall = true;
+        break;
+      case '--no-setup':
+        options.noSetup = true;
+        break;
+      case '--no-test':
+        options.noTest = true;
+        break;
+      case '--safe':
+        options.safe = true;
+        break;
+      case '--template': {
+        const templateValue = args[index + 1];
+        if (!templateValue) {
+          throw new Error('Missing value for --template.');
+        }
+
+        const templateName = resolveTemplate(templateValue);
+        if (!templateName) {
+          throw new Error(
+            `Unsupported template "${templateValue}". Supported templates: ${supportedTemplateIds.join(', ')}.`
+          );
+        }
+
+        options.templateName = templateName;
+        index += 1;
+        break;
+      }
+      default:
+        options.positionalArgs.push(arg);
+        break;
+    }
+  }
+
+  return options;
+}
+
+function resolveNonInteractiveArgs(args, options) {
+  const {
+    templateName,
+    resolveTemplate,
+    supportedTemplateIds,
+    defaultTemplate
+  } = options;
+
+  if (templateName) {
+    if (args.length > 1) {
+      throw new Error(
+        'Too many arguments. Run `create-qa-patterns --help` for usage.'
+      );
+    }
+
+    if (args.length === 0) {
+      return {
+        templateName,
+        targetDirectory: process.cwd(),
+        generatedInCurrentDirectory: true
+      };
+    }
+
+    return {
+      templateName,
+      targetDirectory: path.resolve(process.cwd(), args[0]),
+      generatedInCurrentDirectory: false
+    };
+  }
+
+  if (args.length === 0) {
+    return {
+      templateName: defaultTemplate,
+      targetDirectory: process.cwd(),
+      generatedInCurrentDirectory: true
+    };
+  }
+
+  if (args.length === 1) {
+    const explicitTemplate = resolveTemplate(args[0]);
+
+    if (explicitTemplate) {
+      return {
+        templateName: explicitTemplate,
+        targetDirectory: process.cwd(),
+        generatedInCurrentDirectory: true
+      };
+    }
+
+    return {
+      templateName: defaultTemplate,
+      targetDirectory: path.resolve(process.cwd(), args[0]),
+      generatedInCurrentDirectory: false
+    };
+  }
+
+  if (args.length === 2) {
+    const explicitTemplate = resolveTemplate(args[0]);
+
+    if (!explicitTemplate) {
+      throw new Error(
+        `Unsupported template "${args[0]}". Supported templates: ${supportedTemplateIds.join(', ')}.`
+      );
+    }
+
+    return {
+      templateName: explicitTemplate,
+      targetDirectory: path.resolve(process.cwd(), args[1]),
+      generatedInCurrentDirectory: false
+    };
+  }
+
+  throw new Error(
+    'Too many arguments. Run `create-qa-patterns --help` for usage.'
+  );
+}
+
+module.exports = {
+  parseCliOptions,
+  resolveNonInteractiveArgs
+};

package/lib/constants.js

@@ -0,0 +1,115 @@
+const DEFAULT_TEMPLATE = 'playwright-template';
+const CLI_PACKAGE_VERSION = require('../package.json').version;
+const METADATA_FILENAME = '.qa-patterns.json';
+const MIN_NODE_VERSION = {
+  major: 18,
+  minor: 18,
+  patch: 0
+};
+
+const DEFAULT_GITIGNORE = `node_modules/
+
+.env
+.env.*
+!.env.example
+
+.DS_Store
+*.log
+*.tgz
+.idea/
+.vscode/
+.nyc_output/
+coverage/
+dist/
+build/
+tmp/
+temp/
+downloads/
+cypress.env.json
+reports/
+cypress/screenshots/
+cypress/videos/
+reports/screenshots/
+reports/videos/
+allure-results/
+allure-report/
+test-results/
+playwright-report/
+`;
+
+const MANAGED_FILE_PATTERNS = {
+  common: [
+    '.env.example',
+    '.gitignore',
+    'package.json',
+    'package-lock.json',
+    'tsconfig.json',
+    'eslint.config.mjs',
+    'allurerc.mjs',
+    'config/**',
+    'scripts/**',
+    '.github/**'
+  ],
+  'playwright-template': [
+    'playwright.config.ts',
+    'docker/**',
+    'lint/**',
+    'reporters/**',
+    'utils/logger.ts',
+    'utils/test-step.ts'
+  ],
+  'cypress-template': ['cypress.config.ts'],
+  'wdio-template': [
+    'wdio.conf.ts',
+    'lint/**',
+    'reporters/**',
+    'utils/logger.ts',
+    'utils/test-step.ts'
+  ]
+};
+
+const TEMPLATE_CATALOG = [
+  {
+    id: DEFAULT_TEMPLATE,
+    aliases: ['playwright', 'pw'],
+    label: 'Playwright Template',
+    description:
+      'TypeScript starter with page objects, fixtures, multi-environment config, reporting, linting, CI and Docker.',
+    defaultPackageName: 'playwright-template',
+    demoAppsManagedByTemplate: true,
+    setup: {
+      availability: 'npx',
+      prompt: 'Run npx playwright install now?',
+      summaryLabel: 'Playwright browser install',
+      nextStep: 'npx playwright install'
+    }
+  },
+  {
+    id: 'cypress-template',
+    aliases: ['cypress', 'cy'],
+    label: 'Cypress Template',
+    description:
+      'TypeScript starter with Cypress e2e specs, custom commands, page modules, env-based config, CI, and a bundled demo app.',
+    defaultPackageName: 'cypress-template',
+    demoAppsManagedByTemplate: true
+  },
+  {
+    id: 'wdio-template',
+    aliases: ['webdriverio', 'wdio'],
+    label: 'WebdriverIO Template',
+    description:
+      'TypeScript starter with WebdriverIO + Mocha, page objects, env-based config, CI, and a bundled demo app.',
+    defaultPackageName: 'wdio-template',
+    demoAppsManagedByTemplate: true
+  }
+];
+
+module.exports = {
+  CLI_PACKAGE_VERSION,
+  DEFAULT_GITIGNORE,
+  DEFAULT_TEMPLATE,
+  MANAGED_FILE_PATTERNS,
+  METADATA_FILENAME,
+  MIN_NODE_VERSION,
+  TEMPLATE_CATALOG
+};

package/lib/interactive.js

@@ -0,0 +1,131 @@
+const readline = require('node:readline');
+
+function createLineInterface() {
+  return readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+}
+
+function askQuestion(prompt) {
+  const lineInterface = createLineInterface();
+
+  return new Promise((resolve) => {
+    lineInterface.question(prompt, (answer) => {
+      lineInterface.close();
+      resolve(answer.trim());
+    });
+  });
+}
+
+async function askYesNo(prompt, defaultValue = true) {
+  const suffix = defaultValue ? ' [Y/n] ' : ' [y/N] ';
+
+  while (true) {
+    const answer = (await askQuestion(`${prompt}${suffix}`)).toLowerCase();
+
+    if (!answer) {
+      return defaultValue;
+    }
+
+    if (['y', 'yes'].includes(answer)) {
+      return true;
+    }
+
+    if (['n', 'no'].includes(answer)) {
+      return false;
+    }
+
+    process.stdout.write('Please answer yes or no.\n');
+  }
+}
+
+async function selectTemplateInteractively(templates) {
+  if (!process.stdin.isTTY || !process.stdout.isTTY) {
+    return null;
+  }
+
+  readline.emitKeypressEvents(process.stdin);
+
+  if (typeof process.stdin.setRawMode === 'function') {
+    process.stdin.setRawMode(true);
+  }
+
+  let selectedIndex = 0;
+  let renderedLines = 0;
+
+  const render = () => {
+    if (renderedLines > 0) {
+      readline.moveCursor(process.stdout, 0, -renderedLines);
+      readline.clearScreenDown(process.stdout);
+    }
+
+    const lines = [
+      'Select a template',
+      'Use ↑/↓ to choose and press Enter to continue.',
+      ''
+    ];
+
+    for (let index = 0; index < templates.length; index += 1) {
+      const template = templates[index];
+      const marker = index === selectedIndex ? '>' : ' ';
+      lines.push(`${marker} ${template.label}`);
+      lines.push(`  ${template.description}`);
+      lines.push('');
+    }
+
+    renderedLines = lines.length;
+    process.stdout.write(`${lines.join('\n')}\n`);
+  };
+
+  render();
+
+  return new Promise((resolve) => {
+    const handleKeypress = (_, key) => {
+      if (!key) {
+        return;
+      }
+
+      if (key.name === 'up') {
+        selectedIndex =
+          (selectedIndex - 1 + templates.length) % templates.length;
+        render();
+        return;
+      }
+
+      if (key.name === 'down') {
+        selectedIndex = (selectedIndex + 1) % templates.length;
+        render();
+        return;
+      }
+
+      if (key.name === 'return') {
+        process.stdin.off('keypress', handleKeypress);
+        if (typeof process.stdin.setRawMode === 'function') {
+          process.stdin.setRawMode(false);
+        }
+        readline.clearScreenDown(process.stdout);
+        process.stdout.write(`Selected: ${templates[selectedIndex].label}\n\n`);
+        resolve(templates[selectedIndex].id);
+        return;
+      }
+
+      if (key.ctrl && key.name === 'c') {
+        process.stdin.off('keypress', handleKeypress);
+        if (typeof process.stdin.setRawMode === 'function') {
+          process.stdin.setRawMode(false);
+        }
+        process.stdout.write('\n');
+        process.exit(1);
+      }
+    };
+
+    process.stdin.on('keypress', handleKeypress);
+  });
+}
+
+module.exports = {
+  askQuestion,
+  askYesNo,
+  selectTemplateInteractively
+};

package/lib/local-env.js

@@ -0,0 +1,65 @@
+const crypto = require('node:crypto');
+const fs = require('node:fs');
+const path = require('node:path');
+
+function createLocalCredentials(targetDirectory) {
+  const projectSlug = path
+    .basename(targetDirectory)
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .slice(0, 12);
+  const username = `${projectSlug || 'local'}-${crypto.randomBytes(3).toString('hex')}`;
+  const password = `${crypto.randomBytes(9).toString('base64url')}A1!`;
+
+  return {
+    username,
+    password
+  };
+}
+
+function renderLocalEnv(templateId, credentials) {
+  const common = [
+    'TEST_ENV=dev',
+    'TEST_RUN_ID=local',
+    'DEV_UI_BASE_URL=http://127.0.0.1:3000'
+  ];
+
+  if (templateId === 'playwright-template') {
+    common.push('DEV_API_BASE_URL=http://127.0.0.1:3001');
+  }
+
+  common.push(
+    `DEV_APP_USERNAME=${credentials.username}`,
+    `DEV_APP_PASSWORD=${credentials.password}`,
+    `UI_DEMO_USERNAME=${credentials.username}`,
+    `UI_DEMO_PASSWORD=${credentials.password}`
+  );
+
+  return `${common.join('\n')}\n`;
+}
+
+function writeGeneratedLocalEnv(targetDirectory, templateId, credentials) {
+  const envPath = path.join(targetDirectory, '.env');
+
+  if (fs.existsSync(envPath)) {
+    return {
+      created: false,
+      envPath,
+      credentials
+    };
+  }
+
+  fs.writeFileSync(envPath, renderLocalEnv(templateId, credentials), 'utf8');
+  return {
+    created: true,
+    envPath,
+    credentials
+  };
+}
+
+module.exports = {
+  createLocalCredentials,
+  renderLocalEnv,
+  writeGeneratedLocalEnv
+};