@jmruthers/pace-core 0.6.10 → 0.6.11

package/scripts/eslint-audit.cjs

@@ -1,222 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * ESLint Audit Script
- * @package pace-core
- * @module Scripts/eslint-audit
- * 
- * Runs ESLint across the entire repository and outputs results to a timestamped file
- * in the audit directory.
- * 
- * Usage:
- *   npm run audit:eslint
- */
-
-const { execSync } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-
-// ANSI color codes for terminal output
-const colors = {
-  reset: '\x1b[0m',
-  green: '\x1b[32m',
-  yellow: '\x1b[33m',
-  blue: '\x1b[34m',
-  cyan: '\x1b[36m',
-  bold: '\x1b[1m',
-  red: '\x1b[31m'
-};
-
-// Generate timestamp in format yyyymmddHHMM
-function generateTimestamp() {
-  const now = new Date();
-  const year = now.getFullYear();
-  const month = String(now.getMonth() + 1).padStart(2, '0');
-  const day = String(now.getDate()).padStart(2, '0');
-  const hours = String(now.getHours()).padStart(2, '0');
-  const minutes = String(now.getMinutes()).padStart(2, '0');
-  return `${year}${month}${day}${hours}${minutes}`;
-}
-
-/**
- * Converts ESLint output file paths to clickable markdown hyperlinks
- * Creates markdown link syntax: [text](file:///absolute/path:line:column)
- */
-function convertFilePathsToLinks(output, cwd) {
-  const lines = output.split('\n');
-  const convertedLines = [];
-  let currentFileRelative = null;
-  let currentFileAbsolute = null;
-  let inCommandOutput = false;
-  
-  for (let i = 0; i < lines.length; i++) {
-    const line = lines[i];
-    
-    // Detect command output sections (lines starting with ">")
-    if (line.trim().startsWith('>')) {
-      inCommandOutput = true;
-      convertedLines.push(line);
-      continue;
-    }
-    
-    // Reset command output flag on blank lines or when we see ESLint output
-    if (line.trim() === '' || line.startsWith('eslint') || line.match(/^✖|^✔/)) {
-      inCommandOutput = false;
-    }
-    
-    // ESLint file paths appear on their own line (no leading spaces, not in command output)
-    // Pattern: /absolute/path/to/file.tsx or ./relative/path/to/file.tsx
-    // They appear before error/warning lines which have leading spaces
-    // Match paths that start with / or ./ and contain a file extension
-    const filePathMatch = !inCommandOutput && line.match(/^(\/|\.\/)?([^\s]+\.(ts|tsx|js|jsx|mjs|cjs|json|css|scss|sass|less|html|vue|svelte|md|mdx))$/);
-    
-    if (filePathMatch) {
-      const filePath = line.trim();
-      // Convert to absolute path to resolve relative paths
-      const absolutePath = path.isAbsolute(filePath) 
-        ? filePath 
-        : path.resolve(cwd, filePath);
-      
-      // Normalize for file:// URLs (forward slashes)
-      const normalizedAbsolute = absolutePath.replace(/\\/g, '/');
-      
-      // Calculate relative path from cwd (more readable)
-      currentFileRelative = path.relative(cwd, absolutePath).replace(/\\/g, '/');
-      currentFileAbsolute = normalizedAbsolute;
-      
-      // Create markdown link for file path
-      // Format: [relative/path](file:///absolute/path)
-      convertedLines.push(`[${currentFileRelative}](file://${normalizedAbsolute})`);
-    } else {
-      // Check if this is an error/warning line with line:column pattern
-      // Pattern: "  127:7  warning  message" or "  127:7  error  message"
-      // Also handles: "  25:54  warning  message" (multiple spaces possible)
-      const errorLineMatch = line.match(/^(\s+)(\d+):(\d+)\s+(error|warning)\s+(.+)$/);
-      
-      if (errorLineMatch && currentFileRelative && currentFileAbsolute) {
-        const [, indent, lineNum, colNum, severity, message] = errorLineMatch;
-        // Create markdown link with line and column
-        // Use VS Code/Cursor format: file:///absolute/path#Lline for line numbers
-        // The link text shows the readable format, but the URL uses #Lline format
-        const linkText = `${currentFileRelative}:${lineNum}:${colNum}`;
-        const linkUrl = `file://${currentFileAbsolute}#L${lineNum}`;
-        const markdownLink = `[${linkText}](${linkUrl})`;
-        convertedLines.push(`${indent}${markdownLink}  ${severity}  ${message}`);
-      } else {
-        // Regular line - keep as is
-        convertedLines.push(line);
-        // Reset currentFile if we hit a blank line or command output
-        // But keep it if it's just whitespace (might be continuation of previous error)
-        if (line.trim() === '' && (i === 0 || lines[i - 1].trim() === '')) {
-          currentFileRelative = null;
-          currentFileAbsolute = null;
-        } else if (line.startsWith('npm') || line.startsWith('eslint') || line.match(/^✖|^✔/)) {
-          currentFileRelative = null;
-          currentFileAbsolute = null;
-        }
-      }
-    }
-  }
-  
-  return convertedLines.join('\n');
-}
-
-// Main execution
-function main() {
-  const cwd = process.cwd();
-  const auditDir = path.join(cwd, 'audit');
-  const timestamp = generateTimestamp();
-  const outputFile = path.join(auditDir, `${timestamp}-eslint-report.md`);
-  
-  // Create audit directory if it doesn't exist
-  if (!fs.existsSync(auditDir)) {
-    fs.mkdirSync(auditDir, { recursive: true });
-    console.log(`${colors.green}Created audit/ directory${colors.reset}`);
-  }
-  
-  console.log(`${colors.cyan}Running ESLint audit across the repository...${colors.reset}\n`);
-  
-  try {
-    // Run ESLint and capture output
-    const eslintCommand = 'npm run lint 2>&1';
-    const output = execSync(eslintCommand, { 
-      encoding: 'utf8',
-      cwd,
-      stdio: 'pipe'
-    });
-    
-    // Convert file paths to clickable links
-    const outputWithLinks = convertFilePathsToLinks(output, cwd);
-    
-    // Write output to markdown file with clickable links
-    const reportContent = `# ESLint Audit Report
-
-**Generated:** ${new Date().toISOString()}  
-**Timestamp:** ${timestamp}
-
-> **Note:** File paths in this report are clickable links. Click on any file path to navigate directly to that location in your editor.
-
-## ESLint Output
-
-${outputWithLinks}
-`;
-    
-    fs.writeFileSync(outputFile, reportContent, 'utf8');
-    
-    // Check if there are any errors
-    const hasErrors = output.includes('error') || output.includes('✖');
-    const hasWarnings = output.includes('warning') || output.includes('⚠');
-    
-    console.log(`${colors.bold}Audit Summary:${colors.reset}`);
-    if (hasErrors) {
-      console.log(`  ${colors.red}Errors found${colors.reset} - See report for details`);
-    } else if (hasWarnings) {
-      console.log(`  ${colors.yellow}Warnings found${colors.reset} - See report for details`);
-    } else {
-      console.log(`  ${colors.green}No errors or warnings${colors.reset}`);
-    }
-    
-    console.log(`\n${colors.cyan}Report saved to:${colors.reset} ${outputFile}`);
-    console.log(`\n${colors.cyan}To view the report:${colors.reset}`);
-    console.log(`  ${colors.bold}cat ${outputFile}${colors.reset}`);
-    
-  } catch (error) {
-    // ESLint may exit with non-zero code if errors are found
-    // Capture the output anyway
-    const output = error.stdout || error.message || String(error);
-    
-    // Convert file paths to clickable links
-    const outputWithLinks = convertFilePathsToLinks(output, cwd);
-    
-    const reportContent = `# ESLint Audit Report
-
-**Generated:** ${new Date().toISOString()}  
-**Timestamp:** ${timestamp}
-
-> **Note:** File paths in this report are clickable links. Click on any file path to navigate directly to that location in your editor.
-
-## ESLint Output
-
-${outputWithLinks}
-
-**Exit Code:** ${error.status || 1}
-`;
-    
-    fs.writeFileSync(outputFile, reportContent, 'utf8');
-    
-    console.log(`${colors.yellow}ESLint found issues (exit code: ${error.status || 1})${colors.reset}`);
-    console.log(`\n${colors.cyan}Report saved to:${colors.reset} ${outputFile}`);
-    console.log(`\n${colors.cyan}To view the report:${colors.reset}`);
-    console.log(`  ${colors.bold}cat ${outputFile}${colors.reset}`);
-    
-    // Don't exit with error - we've captured the report
-    process.exit(0);
-  }
-}
-
-// Run if called directly
-if (require.main === module) {
-  main();
-}
-
-module.exports = { main, generateTimestamp };

package/scripts/generate-docs.js

@@ -1,157 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Documentation Generator for @jmruthers/pace-core
- * 
- * This script helps generate and maintain documentation by:
- * 1. Extracting JSDoc comments from components
- * 2. Generating API documentation
- * 3. Creating component examples
- * 4. Updating documentation structure
- */
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const SRC_DIR = path.join(__dirname, '../src');
-const DOCS_DIR = path.join(__dirname, '../docs');
-
-/**
- * Extract JSDoc comments from a TypeScript/JavaScript file
- */
-function extractJSDocComments(filePath) {
-  const content = fs.readFileSync(filePath, 'utf-8');
-  const jsdocRegex = /\/\*\*[\s\S]*?\*\//g;
-  const matches = content.match(jsdocRegex) || [];
-  
-  return matches.map(comment => {
-    // Clean up the comment
-    return comment
-      .replace(/\/\*\*/, '')
-      .replace(/\*\//, '')
-      .replace(/^\s*\*\s*/gm, '')
-      .trim();
-  });
-}
-
-/**
- * Generate component documentation from JSDoc comments
- */
-function generateComponentDocs(componentName) {
-  const componentPath = path.join(SRC_DIR, 'components', componentName, `${componentName}.tsx`);
-  
-  if (!fs.existsSync(componentPath)) {
-    console.warn(`Component ${componentName} not found at ${componentPath}`);
-    return;
-  }
-
-  const comments = extractJSDocComments(componentPath);
-  const docPath = path.join(DOCS_DIR, 'components', `${componentName}.md`);
-  
-  // Create basic documentation structure
-  let docContent = `# ${componentName}\n\n`;
-  
-  if (comments.length > 0) {
-    docContent += `## Overview\n\n${comments[0]}\n\n`;
-  }
-  
-  docContent += `## Usage\n\n\`\`\`tsx\nimport { ${componentName} } from '@jmruthers/pace-core';\n\`\`\`\n\n`;
-  docContent += `## Props\n\n| Prop | Type | Default | Description |\n|------|------|---------|-------------|\n`;
-  docContent += `| ... | ... | ... | ... |\n\n`;
-  docContent += `## Examples\n\n### Basic Usage\n\n\`\`\`tsx\n<${componentName} />\n\`\`\`\n\n`;
-  docContent += `## Accessibility\n\nThis component follows accessibility best practices.\n\n`;
-  docContent += `## Testing\n\nThis component includes comprehensive tests.\n\n`;
-  
-  fs.writeFileSync(docPath, docContent);
-  console.log(`Generated documentation for ${componentName}`);
-}
-
-/**
- * Update the components index
- */
-function updateComponentsIndex() {
-  const componentsDir = path.join(SRC_DIR, 'components');
-  const components = fs.readdirSync(componentsDir, { withFileTypes: true })
-    .filter(dirent => dirent.isDirectory())
-    .map(dirent => dirent.name);
-
-  let indexContent = `# Components\n\nThis section contains documentation for all UI components in \`@jmruthers/pace-core\`.\n\n`;
-  indexContent += `## Component List\n\n`;
-
-  components.forEach(component => {
-    indexContent += `- [${component}](./${component}.md) - ${component} component\n`;
-  });
-
-  indexContent += `\n## Design System\n\nAll components follow our design system principles.\n\n`;
-  indexContent += `### Colors\n- **Primary**: Blue-based color scheme\n`;
-  indexContent += `- **Secondary**: Gray-based color scheme\n`;
-  indexContent += `- **Success**: Green for positive actions\n`;
-  indexContent += `- **Warning**: Yellow for caution\n`;
-  indexContent += `- **Error**: Red for errors and destructive actions\n\n`;
-
-  const indexPath = path.join(DOCS_DIR, 'components', 'README.md');
-  fs.writeFileSync(indexPath, indexContent);
-  console.log('Updated components index');
-}
-
-/**
- * Generate API documentation from TypeScript types
- */
-function generateAPIDocs() {
-  const apiDir = path.join(DOCS_DIR, 'api');
-  if (!fs.existsSync(apiDir)) {
-    fs.mkdirSync(apiDir, { recursive: true });
-  }
-
-  // This would typically use TypeDoc or similar tool
-  console.log('API documentation generation would go here');
-}
-
-/**
- * Main function
- */
-function main() {
-  const command = process.argv[2];
-  
-  switch (command) {
-    case 'generate':
-      const componentName = process.argv[3];
-      if (componentName) {
-        generateComponentDocs(componentName);
-      } else {
-        console.log('Usage: npm run docs:generate <component-name>');
-      }
-      break;
-      
-    case 'update-index':
-      updateComponentsIndex();
-      break;
-      
-    case 'generate-api':
-      generateAPIDocs();
-      break;
-      
-    case 'all':
-      updateComponentsIndex();
-      generateAPIDocs();
-      console.log('Documentation generation complete');
-      break;
-      
-    default:
-      console.log(`
-Documentation Generator
-
-Usage:
-  npm run docs:generate <component-name>  - Generate docs for a specific component
-  npm run docs:update-index               - Update the components index
-  npm run docs:generate-api               - Generate API documentation
-  npm run docs:all                        - Run all documentation tasks
-      `);
-  }
-}
-
-main(); 

package/scripts/install-cursor-rules.cjs

@@ -1,255 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Installation Script for pace-core Cursor Rules
- * @package @jmruthers/pace-core
- * @module Scripts/install-cursor-rules
- * 
- * Sets up cursor rules:
- * - Copies cursor rules from pace-core to consuming app's .cursor/rules/ directory
- * 
- * This is an opt-in script - it does NOT run automatically via postinstall.
- * 
- * For ESLint setup, use install-eslint-config.cjs separately.
- * 
- * Usage:
- *   node install-cursor-rules.cjs        # Install cursor rules
- *   node install-cursor-rules.cjs --force # Force update even if already configured
- */
-
-const fs = require('fs');
-const path = require('path');
-
-// ANSI color codes for terminal output
-const colors = {
-  reset: '\x1b[0m',
-  green: '\x1b[32m',
-  yellow: '\x1b[33m',
-  blue: '\x1b[34m',
-  cyan: '\x1b[36m',
-  bold: '\x1b[1m',
-  red: '\x1b[31m'
-};
-
-// Check for safety guards
-function checkSafetyGuards() {
-  // Check environment variable
-  if (process.env.PACE_CURSOR_RULES_DISABLED === '1') {
-    console.log(`${colors.yellow}Skipping cursor rules installation: PACE_CURSOR_RULES_DISABLED=1${colors.reset}`);
-    process.exit(0);
-  }
-  
-  // Check for .git folder (safety guard for CI)
-  const cwd = process.cwd();
-  if (!fs.existsSync(path.join(cwd, '.git'))) {
-    console.log(`${colors.yellow}Skipping cursor rules installation: No .git folder found${colors.reset}`);
-    console.log(`${colors.yellow}This is a safety guard. If you want to install anyway, run with --force${colors.reset}`);
-    if (!process.argv.includes('--force')) {
-      process.exit(0);
-    }
-  }
-}
-
-// Get pace-core package path
-function getPaceCorePath() {
-  // Try to find pace-core in node_modules
-  const cwd = process.cwd();
-  const paceCorePath = path.join(cwd, 'node_modules', '@jmruthers', 'pace-core');
-  
-  if (fs.existsSync(paceCorePath)) {
-    return paceCorePath;
-  }
-  
-  // If not found, try relative to script location (for development)
-  const scriptDir = __dirname;
-  const relativePath = path.join(scriptDir, '..');
-  if (fs.existsSync(path.join(relativePath, 'cursor-rules'))) {
-    return relativePath;
-  }
-  
-  console.error(`${colors.red}Error: Could not find @jmruthers/pace-core package${colors.reset}`);
-  console.error(`${colors.red}Make sure pace-core is installed: npm install @jmruthers/pace-core${colors.reset}`);
-  process.exit(1);
-}
-
-// Get cursor rules source directory
-function getCursorRulesSource(paceCorePath) {
-  const rulesPath = path.join(paceCorePath, 'cursor-rules');
-  if (!fs.existsSync(rulesPath)) {
-    console.error(`${colors.red}Error: cursor-rules directory not found in pace-core${colors.reset}`);
-    process.exit(1);
-  }
-  return rulesPath;
-}
-
-// Get target directory (.cursor/rules in app root)
-function getCursorRulesTarget() {
-  const cwd = process.cwd();
-  const targetDir = path.join(cwd, '.cursor', 'rules');
-  return targetDir;
-}
-
-// Read rule file and extract version metadata
-function getRuleVersion(filePath) {
-  try {
-    const content = fs.readFileSync(filePath, 'utf8');
-    const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
-    if (frontmatterMatch) {
-      const frontmatter = frontmatterMatch[1];
-      const versionMatch = frontmatter.match(/paceCoreVersion:\s*["']?([^"'\n]+)["']?/);
-      const rulesVersionMatch = frontmatter.match(/rulesVersion:\s*["']?([^"'\n]+)["']?/);
-      return {
-        paceCoreVersion: versionMatch ? versionMatch[1] : null,
-        rulesVersion: rulesVersionMatch ? rulesVersionMatch[1] : null
-      };
-    }
-  } catch (error) {
-    // Ignore errors
-  }
-  return { paceCoreVersion: null, rulesVersion: null };
-}
-
-// Check if file needs updating
-function needsUpdate(sourcePath, targetPath, force) {
-  if (force) {
-    return true;
-  }
-  
-  if (!fs.existsSync(targetPath)) {
-    return true;
-  }
-  
-  // Compare versions first (fast check)
-  const sourceVersion = getRuleVersion(sourcePath);
-  const targetVersion = getRuleVersion(targetPath);
-  
-  // If versions differ, needs update
-  if (sourceVersion.paceCoreVersion !== targetVersion.paceCoreVersion ||
-      sourceVersion.rulesVersion !== targetVersion.rulesVersion) {
-    return true;
-  }
-  
-  // If versions match but content differs, also needs update
-  // (handles cases where version metadata wasn't updated)
-  try {
-    const sourceContent = fs.readFileSync(sourcePath, 'utf8');
-    const targetContent = fs.readFileSync(targetPath, 'utf8');
-    if (sourceContent !== targetContent) {
-      return true;
-    }
-  } catch (error) {
-    // If we can't read files, assume update needed
-    return true;
-  }
-  
-  return false;
-}
-
-// Install cursor rules
-function installCursorRules(force = false) {
-  checkSafetyGuards();
-  
-  const paceCorePath = getPaceCorePath();
-  const sourceDir = getCursorRulesSource(paceCorePath);
-  const targetDir = getCursorRulesTarget();
-  
-  // Create target directory if it doesn't exist
-  if (!fs.existsSync(targetDir)) {
-    fs.mkdirSync(targetDir, { recursive: true });
-    console.log(`${colors.green}Created .cursor/rules/ directory${colors.reset}`);
-  }
-  
-  // Read all .mdc files from source
-  const files = fs.readdirSync(sourceDir)
-    .filter(file => file.endsWith('.mdc'))
-    .sort(); // Sort for consistent output
-  
-  if (files.length === 0) {
-    console.log(`${colors.yellow}No cursor rules found in pace-core${colors.reset}`);
-    return;
-  }
-  
-  console.log(`${colors.cyan}Installing cursor rules from pace-core...${colors.reset}\n`);
-  
-  let installed = 0;
-  let skipped = 0;
-  let updated = 0;
-  
-  files.forEach(file => {
-    const sourcePath = path.join(sourceDir, file);
-    const targetPath = path.join(targetDir, file);
-    
-    // Check if this is a pace-core rule (00-49) or app rule (50+)
-    // pace-core rules: 00-49 (currently 00-12, but leaving room for expansion)
-    // app rules: 50+ (custom rules for consuming apps)
-    const ruleNumber = parseInt(file.match(/^(\d+)-/)?.[1] || '99');
-    const isPaceCoreRule = ruleNumber >= 0 && ruleNumber <= 49;
-    
-    if (fs.existsSync(targetPath)) {
-      if (isPaceCoreRule) {
-        // pace-core rules should be automatically updated when they change
-        if (needsUpdate(sourcePath, targetPath, force)) {
-          // Automatically update pace-core rules when versions differ or content changed
-          fs.copyFileSync(sourcePath, targetPath);
-          console.log(`${colors.green}✓${colors.reset} Updated ${file}${force ? ' (forced)' : ''}`);
-          updated++;
-        } else {
-          console.log(`${colors.blue}○${colors.reset} ${file} is up to date`);
-          skipped++;
-        }
-      } else {
-        // App rules (50+) are never overwritten
-        console.log(`${colors.blue}○${colors.reset} ${file} is a custom rule, skipping`);
-        skipped++;
-      }
-    } else {
-      // File doesn't exist, install it
-      fs.copyFileSync(sourcePath, targetPath);
-      console.log(`${colors.green}✓${colors.reset} Installed ${file}`);
-      installed++;
-    }
-  });
-  
-  console.log(`\n${colors.bold}Installation Summary:${colors.reset}`);
-  console.log(`  ${colors.green}Installed:${colors.reset} ${installed}`);
-  console.log(`  ${colors.yellow}Updated:${colors.reset} ${updated}`);
-  console.log(`  ${colors.blue}Skipped:${colors.reset} ${skipped}`);
-  console.log(`\n${colors.cyan}Cursor rules are now available in .cursor/rules/${colors.reset}`);
-  console.log(`${colors.cyan}Restart Cursor to load the new rules.${colors.reset}`);
-}
-
-
-// Main execution
-function main() {
-  const force = process.argv.includes('--force');
-  
-  if (force) {
-    console.log(`${colors.yellow}Warning: --force flag is set. This will overwrite existing configurations.${colors.reset}\n`);
-  }
-  
-  try {
-    installCursorRules(force);
-    
-    console.log(`\n${colors.cyan}Next steps:${colors.reset}`);
-    console.log(`  • Restart Cursor to load the new rules`);
-    console.log(`  • For ESLint setup, run: ${colors.bold}node node_modules/@jmruthers/pace-core/scripts/install-eslint-config.cjs${colors.reset}`);
-    
-  } catch (error) {
-    console.error(`${colors.red}Error during setup:${colors.reset}`);
-    console.error(error.message);
-    if (error.stack) {
-      console.error(error.stack);
-    }
-    process.exit(1);
-  }
-}
-
-// Run if called directly
-if (require.main === module) {
-  main();
-}
-
-module.exports = { 
-  installCursorRules, 
-  getCursorRulesTarget
-};