cokit-cli 1.0.9 → 1.2.0

package/skills/web-testing/scripts/init-playwright.js

@@ -0,0 +1,233 @@
+#!/usr/bin/env node
+/**
+ * Initialize Playwright with best-practice configuration
+ * Usage: node init-playwright.js [--ct] [--dir <path>]
+ *
+ * Options:
+ *   --ct       Include component testing setup
+ *   --dir      Target directory (default: current directory)
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+// Parse arguments
+const args = process.argv.slice(2);
+const includeComponentTesting = args.includes('--ct');
+const dirIndex = args.indexOf('--dir');
+const targetDir = dirIndex !== -1 ? args[dirIndex + 1] : process.cwd();
+
+// Configuration templates
+const playwrightConfig = `import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './tests/e2e',
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: [
+    ['html', { open: 'never' }],
+    ['json', { outputFile: 'test-results/results.json' }],
+  ],
+  use: {
+    baseURL: process.env.BASE_URL || 'http://localhost:3000',
+    trace: 'on-first-retry',
+    screenshot: 'only-on-failure',
+    video: 'retain-on-failure',
+  },
+  projects: [
+    { name: 'chromium', use: { ...devices['Desktop Chrome'] } },
+    { name: 'firefox', use: { ...devices['Desktop Firefox'] } },
+    { name: 'webkit', use: { ...devices['Desktop Safari'] } },
+    { name: 'mobile-chrome', use: { ...devices['Pixel 5'] } },
+    { name: 'mobile-safari', use: { ...devices['iPhone 12'] } },
+  ],
+  webServer: {
+    command: 'npm run dev',
+    url: 'http://localhost:3000',
+    reuseExistingServer: !process.env.CI,
+    timeout: 120 * 1000,
+  },
+});
+`;
+
+const authFixture = `import { test as base, expect, Page } from '@playwright/test';
+
+type AuthFixtures = {
+  authenticatedPage: Page;
+};
+
+export const test = base.extend<AuthFixtures>({
+  authenticatedPage: async ({ browser, request }, use, testInfo) => {
+    // API-based authentication (faster than UI login)
+    const response = await request.post('/api/auth/login', {
+      data: {
+        email: process.env.TEST_USER_EMAIL || 'test@example.com',
+        password: process.env.TEST_USER_PASSWORD || 'password',
+      },
+    });
+
+    if (!response.ok()) {
+      throw new Error(\`Auth failed: \${response.status()}\`);
+    }
+
+    const { token } = await response.json();
+    const context = await browser.newContext();
+
+    // Set auth cookie/header
+    await context.addCookies([
+      {
+        name: 'auth-token',
+        value: token,
+        domain: 'localhost',
+        path: '/',
+      },
+    ]);
+
+    const page = await context.newPage();
+    await use(page);
+    await context.close();
+  },
+});
+
+export { expect };
+`;
+
+const exampleTest = `import { test, expect } from '@playwright/test';
+
+test.describe('Homepage', () => {
+  test('should load successfully', async ({ page }) => {
+    await page.goto('/');
+    await expect(page).toHaveTitle(/./);
+  });
+
+  test('should have navigation', async ({ page }) => {
+    await page.goto('/');
+    const nav = page.getByRole('navigation');
+    await expect(nav).toBeVisible();
+  });
+});
+
+test.describe('Accessibility', () => {
+  test('homepage passes axe checks', async ({ page }) => {
+    await page.goto('/');
+    // Install @axe-core/playwright for full accessibility testing
+    // const results = await new AxeBuilder({ page }).analyze();
+    // expect(results.violations).toEqual([]);
+  });
+});
+`;
+
+const authTest = `import { test, expect } from '../fixtures/auth';
+
+test.describe('Authenticated User', () => {
+  test('can access dashboard', async ({ authenticatedPage: page }) => {
+    await page.goto('/dashboard');
+    await expect(page).toHaveURL(/dashboard/);
+  });
+});
+`;
+
+const globalSetup = `import { chromium, FullConfig } from '@playwright/test';
+
+async function globalSetup(config: FullConfig) {
+  // Run once before all tests
+  // Example: seed database, create test users
+
+  console.log('Global setup running...');
+
+  // Optional: Create authenticated state for reuse
+  // const browser = await chromium.launch();
+  // const page = await browser.newPage();
+  // await page.goto(config.projects[0].use.baseURL + '/login');
+  // // ... login flow
+  // await page.context().storageState({ path: './playwright/.auth/user.json' });
+  // await browser.close();
+}
+
+export default globalSetup;
+`;
+
+const componentTestConfig = `import { defineConfig, devices } from '@playwright/experimental-ct-react';
+
+export default defineConfig({
+  testDir: './src',
+  testMatch: '**/*.ct.{ts,tsx}',
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: 'html',
+  use: {
+    trace: 'on-first-retry',
+    ctPort: 3100,
+  },
+  projects: [
+    { name: 'chromium', use: { ...devices['Desktop Chrome'] } },
+    { name: 'firefox', use: { ...devices['Desktop Firefox'] } },
+  ],
+});
+`;
+
+const envExample = `# Test environment variables
+BASE_URL=http://localhost:3000
+TEST_USER_EMAIL=test@example.com
+TEST_USER_PASSWORD=password
+`;
+
+// File creation helper
+function writeFile(filePath, content) {
+  const fullPath = path.join(targetDir, filePath);
+  const dir = path.dirname(fullPath);
+
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+
+  if (fs.existsSync(fullPath)) {
+    console.log(`⏭️  Skipping (exists): ${filePath}`);
+    return;
+  }
+
+  fs.writeFileSync(fullPath, content);
+  console.log(`✅ Created: ${filePath}`);
+}
+
+// Main execution
+console.log('\n🎭 Initializing Playwright with best practices...\n');
+
+// Core files
+writeFile('playwright.config.ts', playwrightConfig);
+writeFile('tests/e2e/fixtures/auth.ts', authFixture);
+writeFile('tests/e2e/example.spec.ts', exampleTest);
+writeFile('tests/e2e/auth.spec.ts', authTest);
+writeFile('tests/e2e/global-setup.ts', globalSetup);
+writeFile('.env.test.example', envExample);
+
+// Component testing (optional)
+if (includeComponentTesting) {
+  writeFile('playwright-ct.config.ts', componentTestConfig);
+  console.log('\n📦 Component testing config created. Install:');
+  console.log('   npm install -D @playwright/experimental-ct-react');
+}
+
+// Package.json scripts suggestion
+console.log('\n📝 Add to package.json scripts:');
+console.log(`
+  "test:e2e": "playwright test",
+  "test:e2e:ui": "playwright test --ui",
+  "test:e2e:headed": "playwright test --headed",
+  "test:e2e:debug": "playwright test --debug"
+`);
+
+// Install commands
+console.log('\n📦 Install dependencies:');
+console.log('   npm install -D @playwright/test');
+console.log('   npx playwright install');
+
+if (includeComponentTesting) {
+  console.log('   npm install -D @playwright/experimental-ct-react');
+}
+
+console.log('\n✨ Playwright setup complete!\n');

package/src/commands/add.js

@@ -1,93 +1,93 @@
-// add command - Add specific skills
-import { Command } from 'commander';
-import { copyDir, pathExists, listDirs } from '../utils/copy.js';
-import { getSkillsSourceDir, getUserSkillsDir } from '../utils/paths.js';
-import { success, error, info, done, hint, bold, cyan } from '../utils/colors.js';
-import { join } from 'path';
-import { existsSync, mkdirSync } from 'fs';
-
-// Validate skill name to prevent path traversal
-function validateSkillName(skill) {
-  if (!skill || !/^[a-zA-Z0-9_-]+$/.test(skill)) {
-    return false;
-  }
-  return true;
-}
-
-export const addCommand = new Command('add')
-  .description('Add a specific skill')
-  .argument('[skill]', 'Skill name to add')
-  .option('-l, --list', 'List available skills')
-  .option('-g, --global', 'Add to ~/.copilot/skills/ (default)')
-  .option('--local', 'Add to .github/skills/ in current project')
-  .option('--overwrite', 'Overwrite existing files')
-  .action(async (skill, options) => {
-    const skillsSrc = getSkillsSourceDir();
-
-    // List available skills
-    if (options.list || !skill) {
-      console.log();
-      console.log(bold(cyan('Available Skills:')));
-      console.log();
-
-      const skills = listDirs(skillsSrc);
-      if (skills.length === 0) {
-        info('No skills available.');
-      } else {
-        skills.forEach(s => {
-          console.log(`  • ${s}`);
-        });
-        console.log();
-        hint('Run: npx cokit add <skill-name>');
-      }
-      return;
-    }
-
-    // Validate skill name (prevent path traversal)
-    if (!validateSkillName(skill)) {
-      error('Invalid skill name. Use only letters, numbers, hyphens, and underscores.');
-      return;
-    }
-
-    // Validate skill exists
-    const skillSrc = join(skillsSrc, skill);
-    if (!pathExists(skillSrc)) {
-      error(`Skill "${skill}" not found.`);
-      hint('Run: npx cokit add --list');
-      return;
-    }
-
-    // Determine destination
-    let skillDest;
-    if (options.local) {
-      skillDest = join(process.cwd(), '.github', 'skills', skill);
-    } else {
-      skillDest = join(getUserSkillsDir(), skill);
-    }
-
-    // Ensure parent directory exists
-    const parentDir = join(skillDest, '..');
-    if (!existsSync(parentDir)) {
-      mkdirSync(parentDir, { recursive: true });
-    }
-
-    try {
-      console.log();
-      info(`Adding skill: ${skill}`);
-
-      await copyDir(skillSrc, skillDest, {
-        overwrite: options.overwrite,
-        prompt: true
-      });
-
-      console.log();
-      done(`Skill "${skill}" added!`);
-      if (options.local) {
-        hint('Skill added to .github/skills/');
-      } else {
-        hint('Skill added to ~/.copilot/skills/');
-      }
-    } catch (err) {
-      error(`Failed to add skill: ${err.message}`);
-    }
-  });
+// add command - Add specific skills
+import { Command } from 'commander';
+import { copyDir, pathExists, listDirs } from '../utils/copy.js';
+import { getSkillsSourceDir, getUserSkillsDir } from '../utils/paths.js';
+import { success, error, info, done, hint, bold, cyan } from '../utils/colors.js';
+import { join } from 'path';
+import { existsSync, mkdirSync } from 'fs';
+
+// Validate skill name to prevent path traversal
+function validateSkillName(skill) {
+  if (!skill || !/^[a-zA-Z0-9_-]+$/.test(skill)) {
+    return false;
+  }
+  return true;
+}
+
+export const addCommand = new Command('add')
+  .description('Add a specific skill')
+  .argument('[skill]', 'Skill name to add')
+  .option('-l, --list', 'List available skills')
+  .option('-g, --global', 'Add to ~/.copilot/skills/ (default)')
+  .option('--local', 'Add to .github/skills/ in current project')
+  .option('--overwrite', 'Overwrite existing files')
+  .action(async (skill, options) => {
+    const skillsSrc = getSkillsSourceDir();
+
+    // List available skills
+    if (options.list || !skill) {
+      console.log();
+      console.log(bold(cyan('Available Skills:')));
+      console.log();
+
+      const skills = listDirs(skillsSrc);
+      if (skills.length === 0) {
+        info('No skills available.');
+      } else {
+        skills.forEach(s => {
+          console.log(`  • ${s}`);
+        });
+        console.log();
+        hint('Run: npx cokit add <skill-name>');
+      }
+      return;
+    }
+
+    // Validate skill name (prevent path traversal)
+    if (!validateSkillName(skill)) {
+      error('Invalid skill name. Use only letters, numbers, hyphens, and underscores.');
+      return;
+    }
+
+    // Validate skill exists
+    const skillSrc = join(skillsSrc, skill);
+    if (!pathExists(skillSrc)) {
+      error(`Skill "${skill}" not found.`);
+      hint('Run: npx cokit add --list');
+      return;
+    }
+
+    // Determine destination
+    let skillDest;
+    if (options.local) {
+      skillDest = join(process.cwd(), '.github', 'skills', skill);
+    } else {
+      skillDest = join(getUserSkillsDir(), skill);
+    }
+
+    // Ensure parent directory exists
+    const parentDir = join(skillDest, '..');
+    if (!existsSync(parentDir)) {
+      mkdirSync(parentDir, { recursive: true });
+    }
+
+    try {
+      console.log();
+      info(`Adding skill: ${skill}`);
+
+      await copyDir(skillSrc, skillDest, {
+        overwrite: options.overwrite,
+        prompt: true
+      });
+
+      console.log();
+      done(`Skill "${skill}" added!`);
+      if (options.local) {
+        hint('Skill added to .github/skills/');
+      } else {
+        hint('Skill added to ~/.copilot/skills/');
+      }
+    } catch (err) {
+      error(`Failed to add skill: ${err.message}`);
+    }
+  });

package/src/commands/doctor.js

@@ -1,117 +1,117 @@
-// doctor command - Diagnose setup issues
-import { Command } from 'commander';
-import { pathExists, listDirs, countFiles } from '../utils/copy.js';
-import { getUserSkillsDir, getRepoGithubDir, getRepoVscodeDir } from '../utils/paths.js';
-import { success, error, warn, info, hint, bold, cyan } from '../utils/colors.js';
-import { join } from 'path';
-import { readdirSync, existsSync, readFileSync } from 'fs';
-import { execSync } from 'child_process';
-
-export const doctorCommand = new Command('doctor')
-  .description('Diagnose CoKit setup issues')
-  .action(async () => {
-    console.log();
-    console.log(bold(cyan('Checking CoKit setup...')));
-    console.log();
-
-    let hasIssues = false;
-
-    // Check project-level files
-    console.log(bold('Project Files:'));
-    const githubDir = getRepoGithubDir();
-
-    // Check copilot-instructions.md
-    const instructionsFile = join(githubDir, 'copilot-instructions.md');
-    if (pathExists(instructionsFile)) {
-      success('.github/copilot-instructions.md exists');
-    } else {
-      error('.github/copilot-instructions.md not found');
-      hint('Run: npx cokit init');
-      hasIssues = true;
-    }
-
-    // Check prompts directory
-    const promptsDir = join(githubDir, 'prompts');
-    if (pathExists(promptsDir)) {
-      const promptFiles = readdirSync(promptsDir).filter(f => f.endsWith('.prompt.md'));
-      if (promptFiles.length >= 6) {
-        success(`.github/prompts/ has ${promptFiles.length} prompts`);
-      } else {
-        warn(`.github/prompts/ has ${promptFiles.length} prompts (expected 6)`);
-        hasIssues = true;
-      }
-    } else {
-      error('.github/prompts/ not found');
-      hint('Run: npx cokit init');
-      hasIssues = true;
-    }
-
-    console.log();
-
-    // Check global skills
-    console.log(bold('Personal Skills:'));
-    const globalSkillsDir = getUserSkillsDir();
-
-    if (pathExists(globalSkillsDir)) {
-      const skills = listDirs(globalSkillsDir);
-      if (skills.length >= 5) {
-        success(`~/.copilot/skills/ has ${skills.length} skills`);
-      } else if (skills.length > 0) {
-        warn(`~/.copilot/skills/ has ${skills.length} skills (expected 5)`);
-      } else {
-        error('~/.copilot/skills/ is empty');
-        hint('Run: npx cokit init --global');
-        hasIssues = true;
-      }
-    } else {
-      error('~/.copilot/skills/ not found');
-      hint('Run: npx cokit init --global');
-      hasIssues = true;
-    }
-
-    console.log();
-
-    // Check VS Code
-    console.log(bold('Environment:'));
-
-    // Check if VS Code is installed
-    try {
-      execSync('code --version', { stdio: 'pipe' });
-      success('VS Code detected');
-    } catch {
-      warn('VS Code not detected in PATH');
-      hint('Install VS Code or add to PATH');
-    }
-
-    // Check .vscode/settings.json
-    const vscodeSettings = join(getRepoVscodeDir(), 'settings.json');
-    if (pathExists(vscodeSettings)) {
-      success('.vscode/settings.json exists');
-
-      // Check for Copilot settings
-      try {
-        const settings = JSON.parse(readFileSync(vscodeSettings, 'utf-8'));
-        if (settings['github.copilot.chat.useAgentSkills'] === true) {
-          success('Agent Skills enabled in settings');
-        } else {
-          warn('Agent Skills not enabled in settings');
-          hint('Add: "github.copilot.chat.useAgentSkills": true');
-          hasIssues = true;
-        }
-      } catch {
-        // Can't parse settings, skip
-      }
-    } else {
-      info('.vscode/settings.json not found (optional)');
-    }
-
-    console.log();
-
-    // Summary
-    if (hasIssues) {
-      console.log(bold('Found issues. Run suggested commands to fix.'));
-    } else {
-      console.log(bold(cyan('✓ Everything looks good!')));
-    }
-    console.log();
-  });
+// doctor command - Diagnose setup issues
+import { Command } from 'commander';
+import { pathExists, listDirs, countFiles } from '../utils/copy.js';
+import { getUserSkillsDir, getRepoGithubDir, getRepoVscodeDir } from '../utils/paths.js';
+import { success, error, warn, info, hint, bold, cyan } from '../utils/colors.js';
+import { join } from 'path';
+import { readdirSync, existsSync, readFileSync } from 'fs';
+import { execSync } from 'child_process';
+
+export const doctorCommand = new Command('doctor')
+  .description('Diagnose CoKit setup issues')
+  .action(async () => {
+    console.log();
+    console.log(bold(cyan('Checking CoKit setup...')));
+    console.log();
+
+    let hasIssues = false;
+
+    // Check project-level files
+    console.log(bold('Project Files:'));
+    const githubDir = getRepoGithubDir();
+
+    // Check copilot-instructions.md
+    const instructionsFile = join(githubDir, 'copilot-instructions.md');
+    if (pathExists(instructionsFile)) {
+      success('.github/copilot-instructions.md exists');
+    } else {
+      error('.github/copilot-instructions.md not found');
+      hint('Run: npx cokit init');
+      hasIssues = true;
+    }
+
+    // Check prompts directory
+    const promptsDir = join(githubDir, 'prompts');
+    if (pathExists(promptsDir)) {
+      const promptFiles = readdirSync(promptsDir).filter(f => f.endsWith('.prompt.md'));
+      if (promptFiles.length >= 6) {
+        success(`.github/prompts/ has ${promptFiles.length} prompts`);
+      } else {
+        warn(`.github/prompts/ has ${promptFiles.length} prompts (expected 6)`);
+        hasIssues = true;
+      }
+    } else {
+      error('.github/prompts/ not found');
+      hint('Run: npx cokit init');
+      hasIssues = true;
+    }
+
+    console.log();
+
+    // Check global skills
+    console.log(bold('Personal Skills:'));
+    const globalSkillsDir = getUserSkillsDir();
+
+    if (pathExists(globalSkillsDir)) {
+      const skills = listDirs(globalSkillsDir);
+      if (skills.length >= 5) {
+        success(`~/.copilot/skills/ has ${skills.length} skills`);
+      } else if (skills.length > 0) {
+        warn(`~/.copilot/skills/ has ${skills.length} skills (expected 5)`);
+      } else {
+        error('~/.copilot/skills/ is empty');
+        hint('Run: npx cokit init --global');
+        hasIssues = true;
+      }
+    } else {
+      error('~/.copilot/skills/ not found');
+      hint('Run: npx cokit init --global');
+      hasIssues = true;
+    }
+
+    console.log();
+
+    // Check VS Code
+    console.log(bold('Environment:'));
+
+    // Check if VS Code is installed
+    try {
+      execSync('code --version', { stdio: 'pipe' });
+      success('VS Code detected');
+    } catch {
+      warn('VS Code not detected in PATH');
+      hint('Install VS Code or add to PATH');
+    }
+
+    // Check .vscode/settings.json
+    const vscodeSettings = join(getRepoVscodeDir(), 'settings.json');
+    if (pathExists(vscodeSettings)) {
+      success('.vscode/settings.json exists');
+
+      // Check for Copilot settings
+      try {
+        const settings = JSON.parse(readFileSync(vscodeSettings, 'utf-8'));
+        if (settings['github.copilot.chat.useAgentSkills'] === true) {
+          success('Agent Skills enabled in settings');
+        } else {
+          warn('Agent Skills not enabled in settings');
+          hint('Add: "github.copilot.chat.useAgentSkills": true');
+          hasIssues = true;
+        }
+      } catch {
+        // Can't parse settings, skip
+      }
+    } else {
+      info('.vscode/settings.json not found (optional)');
+    }
+
+    console.log();
+
+    // Summary
+    if (hasIssues) {
+      console.log(bold('Found issues. Run suggested commands to fix.'));
+    } else {
+      console.log(bold(cyan('✓ Everything looks good!')));
+    }
+    console.log();
+  });