@devilsdev/rag-pipeline-utils/scripts/validate-changelog-version.js

A modular toolkit for building RAG (Retrieval-Augmented Generation) pipelines in Node.js

/**
 * Version: 1.1.0
 * Description: Ensures CHANGELOG.md contains the current version and auto-corrects format if needed.
 * Author: Ali Kahwaji
 */

import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';
import { execSync } from 'child_process';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

const pkg = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../package.json')));
const version = pkg.version;
const changelogPath = path.resolve(__dirname, '../CHANGELOG.md');

let changelog = fs.readFileSync(changelogPath, 'utf-8');

// Step 1: Normalize invalid headings like "# [2.0.0](...)"
const normalized = changelog.replace(/^# \[([0-9]+\.[0-9]+\.[0-9]+)\]\([^)]+\)/gm, (match, v) => {
  const today = new Date().toISOString().split('T')[0];
  return `## [${v}] - ${today}`;
});

// Step 2: Update file if normalization occurred
if (normalized !== changelog) {
  fs.writeFileSync(changelogPath, normalized);
  console.log(`🛠️  CHANGELOG.md heading normalized for version ${version}`);
  changelog = normalized;

  // Auto-stage if in git project (Husky compatibility)
  try {
    execSync(`git add ${changelogPath}`);
    console.log('CHANGELOG.md staged after correction');
  } catch {
    // Non-fatal
  }
}

// Step 3: Validate presence of correct heading
const headingPattern = new RegExp(`^## \\[${version}\\]`, 'm');
if (!headingPattern.test(changelog)) {
  throw new Error(`❌ CHANGELOG.md does not contain a properly formatted entry for version ${version}`);
}

console.log(`✅ CHANGELOG.md contains a valid entry for version ${version}`);