jest-test-lineage-reporter 2.1.0 → 2.1.2

package/README.md

@@ -20,29 +20,58 @@ A comprehensive test analytics platform that provides line-by-line test coverage
 
 ## 🚀 CLI Usage (New!)
 
-Jest Test Lineage Reporter now includes a powerful CLI tool!
+Jest Test Lineage Reporter now includes a powerful CLI tool with automatic configuration!
 
 ### Quick Start with CLI
 
 ```bash
-# Run tests with lineage tracking
-jest-lineage test
+# 1. Install the package
+npm install --save-dev jest-test-lineage-reporter jest babel-jest @babel/core @babel/preset-env
 
-# Run mutation testing on existing data
-jest-lineage mutate --threshold 85
+# 2. Initialize configuration (creates jest.config.js and babel.config.js)
+npx jest-lineage init
 
-# Generate HTML report
-jest-lineage report --open
+# 3. Run tests with lineage tracking
+npx jest-lineage test
 
-# Query which tests cover a specific line
-jest-lineage query src/calculator.ts 42
+# 4. Generate HTML report
+npx jest-lineage report --open
 
-# Full analysis workflow (test + mutate + report)
-jest-lineage analyze --open
+# 5. Run mutation testing
+npx jest-lineage mutate --threshold 85
+
+# 6. Query which tests cover a specific line
+npx jest-lineage query src/calculator.ts 42
+
+# 7. Full analysis workflow (test + mutate + report)
+npx jest-lineage analyze --open
 ```
 
 ### CLI Commands
 
+#### `jest-lineage init` ⭐ NEW
+Initialize project configuration automatically.
+
+```bash
+# Create jest.config.js and babel.config.js with all required settings
+npx jest-lineage init
+
+# Force overwrite existing config files
+npx jest-lineage init --force
+
+# Configure for TypeScript project
+npx jest-lineage init --typescript
+```
+
+**What it does:**
+- ✅ Checks for required dependencies
+- ✅ Creates `jest.config.js` with lineage reporter configured
+- ✅ Creates `babel.config.js` with instrumentation plugin
+- ✅ Detects TypeScript and configures accordingly
+- ✅ Shows clear next steps
+
+
+
 #### `jest-lineage test [jest-args...]`
 Run Jest tests with lineage tracking enabled.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-test-lineage-reporter",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "main": "src/TestCoverageReporter.js",
   "bin": {
     "jest-lineage": "./bin/jest-lineage.js"

package/src/cli/commands/init.js

@@ -0,0 +1,254 @@
+/**
+ * Init Command
+ * Initialize jest-test-lineage-reporter in a project
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { success, error, info, warning } = require('../utils/output-formatter');
+
+async function initCommand(options) {
+  try {
+    const cwd = process.cwd();
+    const jestConfigPath = path.join(cwd, 'jest.config.js');
+    const babelConfigPath = path.join(cwd, 'babel.config.js');
+    const packageJsonPath = path.join(cwd, 'package.json');
+
+    console.log('\n🚀 Initializing jest-test-lineage-reporter...\n');
+
+    // Check if package.json exists
+    if (!fs.existsSync(packageJsonPath)) {
+      error('No package.json found. Please run "npm init" first.');
+      process.exit(1);
+    }
+
+    // Detect if jest-test-lineage-reporter is installed locally or globally
+    const isLocalInstall = isInstalledLocally(cwd);
+
+    if (!isLocalInstall) {
+      warning('jest-test-lineage-reporter is installed globally.');
+      warning('For best results, install it locally in your project:\n');
+      console.log('   npm install --save-dev jest-test-lineage-reporter\n');
+
+      if (!options.force) {
+        error('Global installation detected. Use --force to continue with absolute paths.');
+        process.exit(1);
+      }
+    }
+
+    // Read package.json to check dependencies
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    const allDeps = {
+      ...(packageJson.dependencies || {}),
+      ...(packageJson.devDependencies || {}),
+    };
+
+    // Check for required dependencies
+    const requiredDeps = ['jest', 'babel-jest', '@babel/core', '@babel/preset-env'];
+    const missingDeps = requiredDeps.filter(dep => !allDeps[dep]);
+
+    if (missingDeps.length > 0) {
+      warning('Missing required dependencies:');
+      missingDeps.forEach(dep => console.log(`  - ${dep}`));
+      console.log('\n💡 Install them with:');
+      console.log(`   npm install --save-dev ${missingDeps.join(' ')}\n`);
+
+      if (!options.force) {
+        error('Please install missing dependencies first, or use --force to continue anyway.');
+        process.exit(1);
+      }
+    }
+
+    // Create or update Jest config
+    let jestConfigCreated = false;
+    if (fs.existsSync(jestConfigPath)) {
+      if (!options.force) {
+        warning(`jest.config.js already exists. Use --force to overwrite.`);
+        info('Please manually add the following to your jest.config.js:');
+        const setupPath = isLocalInstall
+          ? 'jest-test-lineage-reporter/src/testSetup.js'
+          : getGlobalPackagePath('testSetup.js');
+        console.log(`
+  setupFilesAfterEnv: ['${setupPath}'],
+
+  reporters: [
+    'default',
+    ['jest-test-lineage-reporter', {
+      outputFile: '.jest-lineage-data.json',
+      enableMutationTesting: false,
+    }]
+  ],
+
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.{js,ts}', '!src/**/*.test.{js,ts}'],
+
+  transform: {
+    '^.+\\\\.(js|jsx|ts|tsx)$': 'babel-jest',
+  },
+`);
+      } else {
+        createJestConfig(jestConfigPath, options, isLocalInstall);
+        jestConfigCreated = true;
+      }
+    } else {
+      createJestConfig(jestConfigPath, options, isLocalInstall);
+      jestConfigCreated = true;
+    }
+
+    // Create or update Babel config
+    let babelConfigCreated = false;
+    if (fs.existsSync(babelConfigPath)) {
+      if (!options.force) {
+        warning(`babel.config.js already exists. Use --force to overwrite.`);
+        info('Please manually add the lineage tracker plugin to your babel.config.js:');
+        const pluginPath = isLocalInstall
+          ? 'jest-test-lineage-reporter/src/babel-plugin-lineage-tracker.js'
+          : getGlobalPackagePath('babel-plugin-lineage-tracker.js');
+        console.log(`
+  plugins: [
+    '${pluginPath}',
+  ],
+`);
+      } else {
+        createBabelConfig(babelConfigPath, options, isLocalInstall);
+        babelConfigCreated = true;
+      }
+    } else {
+      createBabelConfig(babelConfigPath, options, isLocalInstall);
+      babelConfigCreated = true;
+    }
+
+    // Summary
+    console.log('\n' + '═'.repeat(50));
+    if (jestConfigCreated && babelConfigCreated) {
+      success('Configuration complete! ✨\n');
+      console.log('✅ Created jest.config.js');
+      console.log('✅ Created babel.config.js\n');
+    } else if (!jestConfigCreated && !babelConfigCreated) {
+      info('Configuration files already exist.');
+      info('Use --force to overwrite, or manually update the files.\n');
+    } else {
+      info('Partial configuration completed.');
+      if (jestConfigCreated) console.log('✅ Created jest.config.js');
+      if (babelConfigCreated) console.log('✅ Created babel.config.js');
+      console.log('');
+    }
+
+    // Show next steps
+    console.log('📋 Next steps:\n');
+    if (missingDeps.length > 0) {
+      console.log('1. Install missing dependencies:');
+      console.log(`   npm install --save-dev ${missingDeps.join(' ')}\n`);
+    }
+    console.log(`${missingDeps.length > 0 ? '2' : '1'}. Run your tests with lineage tracking:`);
+    console.log('   npx jest-lineage test\n');
+    console.log(`${missingDeps.length > 0 ? '3' : '2'}. Query coverage data:`);
+    console.log('   npx jest-lineage query src/yourfile.js\n');
+    console.log(`${missingDeps.length > 0 ? '4' : '3'}. Generate HTML report:`);
+    console.log('   npx jest-lineage report --open\n');
+    console.log('═'.repeat(50) + '\n');
+
+  } catch (err) {
+    error(`Failed to initialize: ${err.message}`);
+    if (options.verbose) {
+      console.error(err.stack);
+    }
+    process.exit(1);
+  }
+}
+
+function createJestConfig(filePath, options, isLocalInstall) {
+  const isTypeScript = options.typescript || hasTypeScriptFiles();
+  const setupPath = isLocalInstall
+    ? 'jest-test-lineage-reporter/src/testSetup.js'
+    : getGlobalPackagePath('testSetup.js');
+
+  const config = `module.exports = {
+  testEnvironment: 'node',
+
+  // Required: Setup file for lineage tracking
+  setupFilesAfterEnv: ['${setupPath}'],
+
+  // Add the lineage reporter
+  reporters: [
+    'default',
+    [
+      'jest-test-lineage-reporter',
+      {
+        outputFile: '.jest-lineage-data.json',
+        enableMutationTesting: false,
+      }
+    ]
+  ],
+
+  // Enable coverage
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.{js${isTypeScript ? ',ts' : ''}}',
+    '!src/**/*.test.{js${isTypeScript ? ',ts' : ''}}',
+    '!src/**/*.d.ts',
+  ],
+
+  // Use babel-jest for transformation
+  transform: {
+    '^.+\\\\.(js|jsx${isTypeScript ? '|ts|tsx' : ''})$': 'babel-jest',
+  },
+
+  // File extensions
+  moduleFileExtensions: ['js', 'jsx'${isTypeScript ? ", 'ts', 'tsx'" : ''}, 'json'],
+};
+`;
+
+  fs.writeFileSync(filePath, config, 'utf8');
+}
+
+function createBabelConfig(filePath, options, isLocalInstall) {
+  const isTypeScript = options.typescript || hasTypeScriptFiles();
+  const pluginPath = isLocalInstall
+    ? 'jest-test-lineage-reporter/src/babel-plugin-lineage-tracker.js'
+    : getGlobalPackagePath('babel-plugin-lineage-tracker.js');
+
+  const config = `module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],${isTypeScript ? `
+    '@babel/preset-typescript',` : ''}
+  ],
+  plugins: [
+    // Required: Lineage tracker plugin for instrumentation
+    '${pluginPath}',
+  ],
+};
+`;
+
+  fs.writeFileSync(filePath, config, 'utf8');
+}
+
+function hasTypeScriptFiles() {
+  const cwd = process.cwd();
+  const srcDir = path.join(cwd, 'src');
+
+  if (!fs.existsSync(srcDir)) return false;
+
+  try {
+    const files = fs.readdirSync(srcDir);
+    return files.some(file => file.endsWith('.ts') || file.endsWith('.tsx'));
+  } catch {
+    return false;
+  }
+}
+
+function isInstalledLocally(cwd) {
+  const localPath = path.join(cwd, 'node_modules', 'jest-test-lineage-reporter');
+  return fs.existsSync(localPath);
+}
+
+function getGlobalPackagePath(filename) {
+  // Get the directory where this script is running from
+  const scriptDir = path.dirname(path.dirname(path.dirname(__dirname)));
+  const srcPath = path.join(scriptDir, 'src', filename);
+
+  // Return absolute path
+  return srcPath;
+}
+
+module.exports = initCommand;

package/src/cli/index.js

@@ -4,6 +4,7 @@
  */
 
 const { Command } = require('commander');
+const initCommand = require('./commands/init');
 const testCommand = require('./commands/test');
 const mutateCommand = require('./commands/mutate');
 const reportCommand = require('./commands/report');
@@ -19,6 +20,15 @@ async function run(argv) {
     .description('Comprehensive test analytics with lineage tracking and mutation testing')
     .version(pkg.version, '-v, --version', 'Display version number');
 
+  // Init command - Initialize project configuration
+  program
+    .command('init')
+    .description('Initialize jest-test-lineage-reporter configuration')
+    .option('--force', 'Overwrite existing configuration files')
+    .option('--typescript', 'Configure for TypeScript project')
+    .option('--verbose', 'Show detailed error messages')
+    .action(initCommand);
+
   // Test command - Run Jest with lineage tracking
   program
     .command('test [jest-args...]')