@codluv/versionguard 0.6.0 → 0.7.0

package/dist/changelog.d.ts

@@ -19,6 +19,18 @@ export interface ChangelogValidationResult {
      */
     hasEntryForVersion: boolean;
 }
+/**
+ * Options for changelog structure enforcement.
+ *
+ * @public
+ * @since 0.7.0
+ */
+export interface ChangelogStructureOptions {
+    /** Validate section headers against an allowed list. */
+    enforceStructure?: boolean;
+    /** Allowed section names. Defaults to Keep a Changelog standard sections. */
+    sections?: string[];
+}
 /**
  * Validates a changelog file for release readiness.
  *
@@ -28,19 +40,26 @@ export interface ChangelogValidationResult {
  * The validator checks for a top-level changelog heading, an `[Unreleased]`
  * section, and optionally a dated entry for the requested version.
  *
+ * When `structure.enforceStructure` is `true`, section headers (`### Name`)
+ * are validated against the allowed list and empty sections produce warnings.
+ *
  * @param changelogPath - Path to the changelog file.
  * @param version - Version that must be present in the changelog.
  * @param strict - Whether to require compare links and dated release headings.
  * @param requireEntry - Whether the requested version must already have an entry.
+ * @param structure - Optional structure enforcement options.
  * @returns The result of validating the changelog file.
  * @example
  * ```ts
  * import { validateChangelog } from 'versionguard';
  *
- * const result = validateChangelog('CHANGELOG.md', '1.2.0', true, true);
+ * const result = validateChangelog('CHANGELOG.md', '1.2.0', true, true, {
+ *   enforceStructure: true,
+ *   sections: ['Added', 'Changed', 'Fixed'],
+ * });
  * ```
  */
-export declare function validateChangelog(changelogPath: string, version: string, strict?: boolean, requireEntry?: boolean): ChangelogValidationResult;
+export declare function validateChangelog(changelogPath: string, version: string, strict?: boolean, requireEntry?: boolean, structure?: ChangelogStructureOptions): ChangelogValidationResult;
 /**
  * Gets the most recent released version from a changelog.
  *

package/dist/changelog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../src/changelog.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAID;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,OAAc,EACtB,YAAY,GAAE,OAAc,GAC3B,yBAAyB,CAgD3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQrE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,MAA8C,GACnD,IAAI,CAmBN;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAMjE;AASD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,MAA8C,GACnD,OAAO,CAoET"}
+{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../src/changelog.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAcD;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,wDAAwD;IACxD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,OAAc,EACtB,YAAY,GAAE,OAAc,EAC5B,SAAS,CAAC,EAAE,yBAAyB,GACpC,yBAAyB,CAuD3B;AAiCD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQrE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,MAA8C,GACnD,IAAI,CAmBN;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAMjE;AASD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,MAA8C,GACnD,OAAO,CAoET"}

package/dist/chunks/{index-DeZAx4Le.js → index-DWiw8Nps.js}

@@ -323,7 +323,15 @@ const calver = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProper
   validate: validate$2
 }, Symbol.toStringTag, { value: "Module" }));
 const CHANGELOG_DATE_REGEX = /^\d{4}-\d{2}-\d{2}$/;
-function validateChangelog(changelogPath, version, strict = true, requireEntry = true) {
+const KEEP_A_CHANGELOG_SECTIONS = [
+  "Added",
+  "Changed",
+  "Deprecated",
+  "Removed",
+  "Fixed",
+  "Security"
+];
+function validateChangelog(changelogPath, version, strict = true, requireEntry = true, structure) {
   if (!fs.existsSync(changelogPath)) {
     return {
       valid: !requireEntry,
@@ -360,12 +368,36 @@ function validateChangelog(changelogPath, version, strict = true, requireEntry =
       }
     }
   }
+  if (structure?.enforceStructure) {
+    const allowed = structure.sections ?? KEEP_A_CHANGELOG_SECTIONS;
+    const sectionErrors = validateSections(content, allowed);
+    errors.push(...sectionErrors);
+  }
   return {
     valid: errors.length === 0,
     errors,
     hasEntryForVersion
   };
 }
+function validateSections(content, allowed) {
+  const errors = [];
+  const lines = content.split("\n");
+  for (let i = 0; i < lines.length; i++) {
+    const sectionMatch = lines[i].match(/^### (.+)/);
+    if (!sectionMatch) continue;
+    const sectionName = sectionMatch[1].trim();
+    if (!allowed.includes(sectionName)) {
+      errors.push(
+        `Invalid changelog section "### ${sectionName}" (line ${i + 1}). Allowed: ${allowed.join(", ")}`
+      );
+    }
+    const nextContentLine = lines.slice(i + 1).find((l) => l.trim().length > 0);
+    if (!nextContentLine || nextContentLine.startsWith("#")) {
+      errors.push(`Empty changelog section "### ${sectionName}" (line ${i + 1})`);
+    }
+  }
+  return errors;
+}
 function addVersionEntry(changelogPath, version, date = (/* @__PURE__ */ new Date()).toISOString().slice(0, 10)) {
   if (!fs.existsSync(changelogPath)) {
     throw new Error(`Changelog not found: ${changelogPath}`);
@@ -1775,7 +1807,9 @@ const DEFAULT_CONFIG = {
     enabled: true,
     file: "CHANGELOG.md",
     strict: true,
-    requireEntry: true
+    requireEntry: true,
+    enforceStructure: false,
+    sections: ["Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"]
   },
   git: {
     hooks: {
@@ -2690,7 +2724,11 @@ function getTagPreflightError(config, cwd, expectedVersion, allowAutoFix = false
     path.join(cwd, config.changelog.file),
     version,
     config.changelog.strict,
-    config.changelog.requireEntry
+    config.changelog.requireEntry,
+    {
+      enforceStructure: config.changelog.enforceStructure,
+      sections: config.changelog.sections
+    }
   );
   if (!changelogResult.valid) {
     return changelogResult.errors[0] ?? "Changelog validation failed";
@@ -2798,7 +2836,11 @@ function validate(config, cwd = process.cwd()) {
       changelogPath,
       version,
       config.changelog.strict,
-      config.changelog.requireEntry
+      config.changelog.requireEntry,
+      {
+        enforceStructure: config.changelog.enforceStructure,
+        sections: config.changelog.sections
+      }
     );
     if (!changelogResult.valid) {
       changelogValid = false;
@@ -2937,4 +2979,4 @@ export {
   canBump as y,
   checkEnforceHooksPolicy as z
 };
-//# sourceMappingURL=index-DeZAx4Le.js.map
+//# sourceMappingURL=index-DWiw8Nps.js.map