Skip to content

Create changetool script for validating change-notes #4113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mario-campos merged 9 commits into from
Aug 27, 2026
Merged

Create changetool script for validating change-notes #4113

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
426c104
Create `changetool` script for validating change-notes
mario-campos Aug 25, 2026
580da89
Handle file errors as `false`
mario-campos Aug 27, 2026
5aea817
Replace `Array.prototype.every()` with `for` loop
mario-campos Aug 27, 2026
50ec5a5
Use `Object.hasOwn` instead of `in` operator
mario-campos Aug 27, 2026
0447ab2
Enhance changenote validation to support nested bullet lists
mario-campos Aug 27, 2026
be555cf
Extend scripts/changetool as a NPM workspace
mario-campos Aug 27, 2026
e2cd31e
Refactor tsconfig.json to extend base configuration and simplify options
mario-campos Aug 27, 2026
cacb7b3
Delete unused script/changetool NPM scripts
mario-campos Aug 27, 2026
f049ecb
Delete unused Node.js flag `--experimental-test-module-mocks`
mario-campos Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Enhance changenote validation to support nested bullet lists
  • Loading branch information
@mario-campos
mario-campos committed Aug 27, 2026
commit 0447ab23b52faa4f275ba31d98adf852b76cd324
1 change: 1 addition & 0 deletions scripts/changetool/cli/validate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ await describe("isValidChangenoteContent", async () => {
"+ Fixed a bug\n+ Added feature",
"- Fixed a bug\n* Added feature",
"- Fixed a bug\n+ Added feature",
"- Fixed a bug\n * Added feature\n + Updated docs",
"\n\n\n* Fixed a bug",
"\n\n\n+ Fixed a bug",
"---\n* Fixed a bug\n* Added feature",
Expand Down
30 changes: 20 additions & 10 deletions scripts/changetool/cli/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as fs from "node:fs";
import * as path from "node:path";

import { matter } from "lite-matter";
import type { List, ListItem } from "mdast";
import { fromMarkdown } from "mdast-util-from-markdown";

// Regex for filename: YYYY-MM-DD-id.md
Expand Down Expand Up @@ -30,19 +31,28 @@ export const VALID_CHANGE_NOTE_CATEGORIES = {
*/
export function isValidChangenoteContent(content: string): boolean {
const ast = fromMarkdown(content);
const lines = content.split("\n");

if (
ast.children.length !== 1 ||
ast.children[0].type !== "list" ||
ast.children[0].ordered === true
) {
return false;
function listHasHyphenBullets(node: List | ListItem): boolean {
if (node.type === "list") {
return node.children.every(listHasHyphenBullets);
}

const line = lines[node.position!.start.line - 1].trim();
return (
line.startsWith("-") &&
node.children.every(
(child) => child.type !== "list" || listHasHyphenBullets(child),
)
);
}

const lines = content.split("\n");
return ast.children[0].children.every((listItem) => {
return lines[listItem.position!.start.line - 1].startsWith("-");
});
return (
ast.children.length === 1 &&
ast.children[0].type === "list" &&
ast.children[0].ordered === false &&
listHasHyphenBullets(ast.children[0])
);
}

/**
Expand Down