@jmruthers/pace-core 0.6.5 → 0.6.7

package/audit-tool/utils/file-utils.cjs

@@ -0,0 +1,230 @@
+/**
+ * File System Utilities for Audit Tool
+ * @package @jmruthers/pace-core
+ * @module Audit/utils/file-utils
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Recursively find all source files matching extensions
+ * @param {string} dir - Directory to search
+ * @param {string[]} extensions - File extensions to match (e.g., ['.ts', '.tsx', '.js', '.jsx'])
+ * @param {string[]} fileList - Accumulator for found files
+ * @returns {string[]} - Array of file paths
+ */
+function findSourceFiles(dir, extensions = ['.ts', '.tsx', '.js', '.jsx'], fileList = []) {
+  if (!fs.existsSync(dir)) {
+    return fileList;
+  }
+  
+  const files = fs.readdirSync(dir);
+  
+  files.forEach(file => {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+    
+    if (stat.isDirectory()) {
+      // Skip common build/dependency directories
+      if (!['node_modules', 'dist', 'build', '.git', '.next', '.vite', 'coverage', '.turbo', '.cursor'].includes(file)) {
+        findSourceFiles(filePath, extensions, fileList);
+      }
+    } else {
+      const ext = path.extname(file);
+      if (extensions.includes(ext)) {
+        fileList.push(filePath);
+      }
+    }
+  });
+  
+  return fileList;
+}
+
+/**
+ * Recursively find all SQL files in a directory
+ * @param {string} dir - Directory to search
+ * @param {string[]} fileList - Accumulator for found files
+ * @returns {string[]} - Array of SQL file paths
+ */
+function findSQLFiles(dir, fileList = []) {
+  if (!fs.existsSync(dir)) {
+    return fileList;
+  }
+  
+  const files = fs.readdirSync(dir);
+  
+  files.forEach(file => {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+    
+    if (stat.isDirectory()) {
+      // Skip common build/dependency directories
+      if (!['node_modules', 'dist', 'build', '.git', '.next', '.vite', 'coverage', '.turbo'].includes(file)) {
+        findSQLFiles(filePath, fileList);
+      }
+    } else if (/\.sql$/.test(file)) {
+      fileList.push(filePath);
+    }
+  });
+  
+  return fileList;
+}
+
+/**
+ * Find configuration files by name
+ * @param {string} dir - Directory to search
+ * @param {string[]} configNames - Array of config file names to find
+ * @returns {Object} - Object mapping config names to paths (or null if not found)
+ */
+function findConfigFiles(dir, configNames) {
+  const results = {};
+  
+  for (const configName of configNames) {
+    const possiblePaths = [
+      path.join(dir, configName),
+      path.join(dir, `.${configName}`),
+    ];
+    
+    // Also check common variations
+    if (configName.includes('.')) {
+      const [base, ext] = configName.split('.');
+      possiblePaths.push(
+        path.join(dir, `${base}.js`),
+        path.join(dir, `${base}.ts`),
+        path.join(dir, `${base}.cjs`),
+        path.join(dir, `${base}.mjs`),
+        path.join(dir, `.${base}.js`),
+        path.join(dir, `.${base}.ts`),
+        path.join(dir, `.${base}.cjs`),
+        path.join(dir, `.${base}.mjs`)
+      );
+    }
+    
+    let found = null;
+    for (const configPath of possiblePaths) {
+      if (fs.existsSync(configPath)) {
+        found = configPath;
+        break;
+      }
+    }
+    
+    results[configName] = found;
+  }
+  
+  return results;
+}
+
+/**
+ * Safely read a file with error handling
+ * @param {string} filePath - Path to file
+ * @returns {string|null} - File content or null if error
+ */
+function readFileSafe(filePath) {
+  try {
+    if (!fs.existsSync(filePath)) {
+      return null;
+    }
+    return fs.readFileSync(filePath, 'utf8');
+  } catch (error) {
+    return null;
+  }
+}
+
+/**
+ * Get relative path from base path
+ * @param {string} filePath - Absolute file path
+ * @param {string} basePath - Base path to make relative to
+ * @returns {string} - Relative path
+ */
+function getRelativePath(filePath, basePath) {
+  try {
+    return path.relative(basePath, filePath);
+  } catch (error) {
+    return filePath;
+  }
+}
+
+/**
+ * Find pace-core package.json
+ * @param {string} consumingAppPath - Path to consuming app
+ * @returns {string|null} - Path to pace-core package.json or null
+ */
+function findPaceCorePackageJson(consumingAppPath) {
+  const possiblePaths = [
+    path.resolve(__dirname, '../../package.json'), // From packages/core/audit-tool/utils
+    path.resolve(__dirname, '../../../package.json'), // Alternative location (from root)
+    path.join(consumingAppPath, 'node_modules', '@jmruthers', 'pace-core', 'package.json'),
+  ];
+  
+  for (const packagePath of possiblePaths) {
+    if (fs.existsSync(packagePath)) {
+      return packagePath;
+    }
+  }
+  
+  return null;
+}
+
+/**
+ * Load core-usage-manifest.json
+ * @param {string} consumingAppPath - Path to consuming app
+ * @returns {Object|null} - Manifest object or null
+ */
+function loadManifest(consumingAppPath) {
+  const possiblePaths = [
+    path.resolve(__dirname, '../../../core-usage-manifest.json'),
+    path.resolve(__dirname, '../../../../core-usage-manifest.json'),
+    path.join(consumingAppPath, 'node_modules', '@jmruthers', 'pace-core', 'core-usage-manifest.json'),
+  ];
+  
+  for (const manifestPath of possiblePaths) {
+    if (fs.existsSync(manifestPath)) {
+      try {
+        return JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
+      } catch (e) {
+        // Continue to next path
+      }
+    }
+  }
+  
+  return null;
+}
+
+/**
+ * Check if a directory exists
+ * @param {string} dirPath - Directory path
+ * @returns {boolean} - True if directory exists
+ */
+function directoryExists(dirPath) {
+  try {
+    return fs.existsSync(dirPath) && fs.statSync(dirPath).isDirectory();
+  } catch (error) {
+    return false;
+  }
+}
+
+/**
+ * Check if a file exists
+ * @param {string} filePath - File path
+ * @returns {boolean} - True if file exists
+ */
+function fileExists(filePath) {
+  try {
+    return fs.existsSync(filePath) && fs.statSync(filePath).isFile();
+  } catch (error) {
+    return false;
+  }
+}
+
+module.exports = {
+  findSourceFiles,
+  findSQLFiles,
+  findConfigFiles,
+  readFileSafe,
+  getRelativePath,
+  findPaceCorePackageJson,
+  loadManifest,
+  directoryExists,
+  fileExists,
+};

package/audit-tool/utils/report-utils.cjs

@@ -0,0 +1,241 @@
+/**
+ * Report Generation Utilities for Audit Tool
+ * @package @jmruthers/pace-core
+ * @module Audit/utils/report-utils
+ */
+
+const path = require('path');
+
+/**
+ * Format a single issue for markdown report
+ * @param {Object} issue - Issue object
+ * @param {string} standard - Standard name (e.g., '01-pace-core-compliance')
+ * @returns {string} - Formatted markdown
+ */
+function formatIssue(issue, standard) {
+  const severity = issue.severity || 'error';
+  const severityIcon = severity === 'error' ? '❌' : severity === 'warning' ? '⚠️' : 'ℹ️';
+  
+  let formatted = `\n#### ${severityIcon} ${issue.type || 'Issue'}\n\n`;
+  
+  if (issue.file) {
+    formatted += `**File:** \`${issue.file}\`\n\n`;
+  }
+  
+  if (issue.line) {
+    formatted += `**Line:** ${issue.line}\n\n`;
+  }
+  
+  if (issue.message) {
+    formatted += `**Message:** ${issue.message}\n\n`;
+  }
+  
+  if (issue.code) {
+    formatted += `**Code:**\n\`\`\`\n${issue.code}\n\`\`\`\n\n`;
+  }
+  
+  if (issue.fix) {
+    formatted += `**Fix:** ${issue.fix}\n\n`;
+  }
+  
+  if (issue.details) {
+    formatted += `**Details:** ${issue.details}\n\n`;
+  }
+  
+  return formatted;
+}
+
+/**
+ * Format a standard section in the report
+ * @param {string} standard - Standard number and name (e.g., '01-pace-core-compliance')
+ * @param {string} standardName - Human-readable standard name
+ * @param {Array} issues - Array of issues
+ * @param {string} standardDocPath - Path to standards documentation
+ * @returns {string} - Formatted markdown section
+ */
+function formatStandardSection(standard, standardName, issues, standardDocPath) {
+  if (issues.length === 0) {
+    return `\n### ✅ Standard ${standard}: ${standardName}\n\nNo issues found.\n`;
+  }
+  
+  let section = `\n### ❌ Standard ${standard}: ${standardName}\n\n`;
+  section += `**Reference:** [${standardName}](https://github.com/jmruthers/pace-core/blob/main/packages/core/docs/standards/${standardDocPath})\n\n`;
+  section += `**Issues Found:** ${issues.length}\n\n`;
+  
+  // Group issues by type
+  const issuesByType = {};
+  issues.forEach(issue => {
+    const type = issue.type || 'other';
+    if (!issuesByType[type]) {
+      issuesByType[type] = [];
+    }
+    issuesByType[type].push(issue);
+  });
+  
+  // Format each type group
+  Object.entries(issuesByType).forEach(([type, typeIssues]) => {
+    section += `\n#### ${type} (${typeIssues.length} issue${typeIssues.length > 1 ? 's' : ''})\n`;
+    typeIssues.forEach(issue => {
+      section += formatIssue(issue, standard);
+    });
+  });
+  
+  return section;
+}
+
+/**
+ * Generate markdown report from audit results
+ * @param {Object} results - Audit results object
+ * @param {string} consumingAppPath - Path to consuming app
+ * @returns {string} - Complete markdown report
+ */
+function generateMarkdownReport(results, consumingAppPath) {
+  const now = new Date();
+  const timestamp = now.toISOString();
+  
+  let report = `# pace-core Audit Report\n\n`;
+  report += `**Generated:** ${timestamp}\n`;
+  report += `**App Path:** ${consumingAppPath}\n\n`;
+  report += `---\n\n`;
+  report += `## Summary\n\n`;
+  
+  // Calculate totals
+  const standardNames = {
+    '01-pace-core-compliance': 'pace-core Compliance',
+    '02-project-structure': 'Project Structure',
+    '03-architecture': 'Architecture',
+    '04-code-quality': 'Code Quality',
+    '05-styling': 'Styling',
+    '06-security-rbac': 'Security & RBAC',
+    '07-api-tech-stack': 'API & Tech Stack',
+    '08-testing-documentation': 'Testing & Documentation',
+    '09-operations': 'Operations',
+  };
+  
+  const standardDocPaths = {
+    '01-pace-core-compliance': '1-pace-core-compliance-standards.md',
+    '02-project-structure': '2-project-structure-standards.md',
+    '03-architecture': '3-architecture-standards.md',
+    '04-code-quality': '4-code-quality-standards.md',
+    '05-styling': '5-styling-standards.md',
+    '06-security-rbac': '6-security-rbac-standards.md',
+    '07-api-tech-stack': '7-api-tech-stack-standards.md',
+    '08-testing-documentation': '8-testing-documentation-standards.md',
+    '09-operations': '9-operations-standards.md',
+  };
+  
+  let totalIssues = 0;
+  const standardCounts = {};
+  
+  // Count issues per standard
+  Object.keys(standardNames).forEach(standard => {
+    const standardResult = results[standard];
+    if (standardResult && standardResult.issues) {
+      const count = Array.isArray(standardResult.issues) 
+        ? standardResult.issues.length 
+        : Object.values(standardResult.issues).flat().length;
+      standardCounts[standard] = count;
+      totalIssues += count;
+    } else {
+      standardCounts[standard] = 0;
+    }
+  });
+  
+  report += `**Total Issues:** ${totalIssues}\n\n`;
+  report += `| Standard | Issues |\n`;
+  report += `|----------|--------|\n`;
+  
+  Object.entries(standardCounts).forEach(([standard, count]) => {
+    const icon = count === 0 ? '✅' : '❌';
+    report += `| ${icon} ${standardNames[standard]} | ${count} |\n`;
+  });
+  
+  report += `\n---\n\n`;
+  report += `## Detailed Results\n\n`;
+  
+  // Generate sections for each standard
+  Object.keys(standardNames).forEach(standard => {
+    const standardResult = results[standard];
+    if (standardResult) {
+      const issues = Array.isArray(standardResult.issues) 
+        ? standardResult.issues 
+        : Object.values(standardResult.issues || {}).flat();
+      
+      report += formatStandardSection(
+        standard,
+        standardNames[standard],
+        issues,
+        standardDocPaths[standard]
+      );
+    }
+  });
+  
+  report += `\n---\n\n`;
+  report += `## Next Steps\n\n`;
+  
+  if (totalIssues === 0) {
+    report += `✅ All audits passed! Your app is compliant with pace-core standards.\n\n`;
+  } else {
+    report += `Please review the issues above and address them according to the referenced standards.\n\n`;
+    report += `For more information, see the [pace-core Standards Documentation](https://github.com/jmruthers/pace-core/blob/main/packages/core/docs/standards/README.md).\n\n`;
+  }
+  
+  return report;
+}
+
+/**
+ * Generate summary statistics
+ * @param {Object} results - Audit results object
+ * @returns {Object} - Summary object with counts
+ */
+function generateSummary(results) {
+  const standardNames = {
+    '01-pace-core-compliance': 'pace-core Compliance',
+    '02-project-structure': 'Project Structure',
+    '03-architecture': 'Architecture',
+    '04-code-quality': 'Code Quality',
+    '05-styling': 'Styling',
+    '06-security-rbac': 'Security & RBAC',
+    '07-api-tech-stack': 'API & Tech Stack',
+    '08-testing-documentation': 'Testing & Documentation',
+    '09-operations': 'Operations',
+  };
+  
+  const summary = {
+    total: 0,
+    byStandard: {},
+    bySeverity: { error: 0, warning: 0, info: 0 },
+  };
+  
+  Object.keys(standardNames).forEach(standard => {
+    const standardResult = results[standard];
+    if (standardResult && standardResult.issues) {
+      const issues = Array.isArray(standardResult.issues) 
+        ? standardResult.issues 
+        : Object.values(standardResult.issues || {}).flat();
+      
+      const count = issues.length;
+      summary.byStandard[standard] = count;
+      summary.total += count;
+      
+      // Count by severity
+      issues.forEach(issue => {
+        const severity = issue.severity || 'error';
+        if (summary.bySeverity[severity] !== undefined) {
+          summary.bySeverity[severity]++;
+        }
+      });
+    } else {
+      summary.byStandard[standard] = 0;
+    }
+  });
+  
+  return summary;
+}
+
+module.exports = {
+  formatIssue,
+  formatStandardSection,
+  generateMarkdownReport,
+  generateSummary,
+};

package/core-usage-manifest.json

@@ -163,6 +163,7 @@
     "securityMonitor",
     "sanitizeUserInput",
     "sanitizeFormData",
+    "sanitizeHtml",
     "validateUserInput",
     "usernameSchema",
     "emailSchema",
@@ -194,6 +195,86 @@
     "formatDateTimeForTable",
     "formatDateTimeForMap"
   ],
+  "icons": [
+    "ChevronDown",
+    "ChevronUp",
+    "ChevronLeft",
+    "ChevronRight",
+    "ChevronsUp",
+    "ChevronsDown",
+    "ChevronsLeft",
+    "ChevronsRight",
+    "ChevronsUpDown",
+    "ArrowUp",
+    "ArrowDown",
+    "ArrowLeft",
+    "ArrowRight",
+    "ArrowUpDown",
+    "Edit",
+    "Trash",
+    "Trash2",
+    "Plus",
+    "Minus",
+    "X",
+    "Check",
+    "Copy",
+    "Save",
+    "Upload",
+    "Download",
+    "Search",
+    "Filter",
+    "Settings",
+    "Settings2",
+    "MoreHorizontal",
+    "MoreVertical",
+    "AlertCircle",
+    "AlertTriangle",
+    "CheckCircle",
+    "Info",
+    "ShieldX",
+    "Eye",
+    "EyeOff",
+    "Lock",
+    "Unlock",
+    "Clock",
+    "Calendar",
+    "Database",
+    "File",
+    "FileText",
+    "ExternalLink",
+    "User",
+    "Users",
+    "Group",
+    "Building2",
+    "RefreshCw",
+    "RotateCcw",
+    "RotateCw",
+    "LogOut",
+    "KeyRound",
+    "Menu",
+    "Home",
+    "Server",
+    "Zap",
+    "Globe",
+    "HardDrive",
+    "Image",
+    "Link",
+    "Mail",
+    "MapPin",
+    "Phone",
+    "PieChart",
+    "Play",
+    "Share",
+    "Star",
+    "Tag",
+    "Target",
+    "TrendingUp",
+    "Volume2",
+    "Wifi",
+    "Circle",
+    "ChevronRightIcon",
+    "ChevronDownIcon"
+  ],
   "restrictedImports": [
     {
       "module": "@radix-ui/react-avatar",
@@ -297,6 +378,18 @@
       },
       "importExample": "import { formatInTimeZone, toZonedTime, fromZonedTime, getUserTimeZone } from '@jmruthers/pace-core/utils/timezone';",
       "usageExample": "const formatted = formatInTimeZone(date, 'America/New_York', 'MMM dd, yyyy HH:mm');"
+    },
+    {
+      "module": "lucide-react",
+      "reason": "Import icons from '@jmruthers/pace-core/icons' instead of 'lucide-react' directly. pace-core provides a curated set of icons that are version-controlled and consistent across the PACE suite.",
+      "replacements": {
+        "ChevronDown": "ChevronDown (from '@jmruthers/pace-core/icons')",
+        "Edit": "Edit (from '@jmruthers/pace-core/icons')",
+        "Trash": "Trash (from '@jmruthers/pace-core/icons')",
+        "*": "All icons should be imported from '@jmruthers/pace-core/icons'"
+      },
+      "importExample": "import { ChevronDown, Edit, Trash, Plus, Search } from '@jmruthers/pace-core/icons';",
+      "usageExample": "<Button><ChevronDown className=\"w-4 h-4\" /> Click me</Button>"
     }
   ],
   "notes": [