GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix: scan directory change-notes using right function · github/codeql-action@425de06

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • pr-checks
    • changelog
      • validate.mts
      • validate.test.mts
    • changenotes.mts
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎pr-checks/changelog/validate.mts‎

Copy file name to clipboardExpand all lines: pr-checks/changelog/validate.mts
+8-25Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export function hasValidChangenoteCategory(
8484
* @param filename The name of the change-note file to validate.
8585
* @returns True if the file is a valid change-note, false otherwise.
8686
*/
87-
function isValidChangenoteFile(filename: string): boolean {
87+
export function isValidChangenoteFile(filename: string): boolean {
8888
let isValid: boolean = true;
8989

9090
let fileData: string | undefined;
@@ -121,29 +121,12 @@ function isValidChangenoteFile(filename: string): boolean {
121121
}
122122

123123
/**
124-
* Validates that the given path is a valid change-note file or directory of change-note files.
125-
* @param filepath The path to the change-note file or directory to validate.
126-
* @returns True if the path is valid, false otherwise.
124+
* Validates the change-note files of the given list of file paths, ignoring ".gitkeep".
125+
* @param filepaths A list of filepaths to validate
126+
* @returns True if all the paths are valid, false otherwise.
127127
*/
128-
export function isValidChangenoteFileOrDir(filepath: string): boolean {
129-
try {
130-
const stats = fs.statSync(filepath);
131-
if (stats.isFile()) {
132-
return isValidChangenoteFile(filepath);
133-
}
134-
if (stats.isDirectory()) {
135-
return fs
136-
.readdirSync(filepath)
137-
.filter((f) => f !== ".gitkeep")
138-
.reduce(
139-
(r, f) => r && isValidChangenoteContent(path.join(filepath, f)),
140-
true,
141-
);
142-
}
143-
console.error(`${filepath}: not a file or directory`);
144-
return false;
145-
} catch (error) {
146-
console.error(`${filepath}: failed to read file or directory`, error);
147-
return false;
148-
}
128+
export function isValidAllChangenoteFiles(filepaths: string[]): boolean {
129+
return filepaths
130+
.filter((f) => f !== ".gitkeep")
131+
.reduce((r, filePath) => r && isValidChangenoteFile(filePath), true);
149132
}
Collapse file

‎pr-checks/changelog/validate.test.mts‎

Copy file name to clipboardExpand all lines: pr-checks/changelog/validate.test.mts
+29-60Lines changed: 29 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ import { withTmpDir, withTmpFile } from "../../src/util";
77

88
import {
99
hasValidChangenoteCategory,
10+
isValidAllChangenoteFiles,
1011
isValidChangenoteContent,
11-
isValidChangenoteFileOrDir,
12+
isValidChangenoteFile,
1213
isValidChangenoteFilename,
1314
VALID_CHANGE_NOTE_CATEGORIES,
1415
} from "./validate.mjs";
@@ -141,90 +142,58 @@ await describe("hasValidChangenoteCategory", async () => {
141142
});
142143
});
143144

144-
await describe("isValidChangenoteFileOrDir", async () => {
145+
await describe("isValidChangenoteFile", async () => {
145146
await it("accepts a valid change-note file", async () => {
146147
await withTmpFile(
147148
"2026-01-01-fix-bug.md",
148149
"---\ncategory: fix\n---\n- Fixed a bug\n",
149150
(filePath) => {
150-
assert.equal(isValidChangenoteFileOrDir(filePath), true);
151+
assert.equal(isValidChangenoteFile(filePath), true);
151152
},
152153
);
153154
});
154155

156+
await it("rejects a non-existent path", async () => {
157+
assert.equal(isValidChangenoteFile("non-existent-file.md"), false);
158+
});
159+
160+
await it("rejects invalid filename", async () => {
161+
assert.equal(isValidChangenoteFile("fix-bug.md"), false);
162+
});
163+
});
164+
165+
await describe("isValidAllChangenoteFiles", async () => {
155166
await it("accepts a directory of valid change-note files", async () => {
156167
await withTmpDir(async (tmpDir) => {
168+
const fileName1 = path.join(tmpDir, "2026-01-01-fix-bug.md");
169+
const fileName2 = path.join(tmpDir, "2026-01-02-add-feature.md");
170+
fs.writeFileSync(fileName1, "---\ncategory: fix\n---\n- Fixed a bug\n");
157171
fs.writeFileSync(
158-
path.join(tmpDir, "2026-01-01-fix-bug.md"),
159-
"---\ncategory: fix\n---\n- Fixed a bug\n",
160-
);
161-
fs.writeFileSync(
162-
path.join(tmpDir, "2026-01-02-add-feature.md"),
172+
fileName2,
163173
"---\ncategory: feature\n---\n- Added a feature\n",
164174
);
165-
assert.equal(isValidChangenoteFileOrDir(tmpDir), true);
166-
});
167-
});
168-
169-
await it("accepts an empty directory", async () => {
170-
await withTmpDir(async (tmpDir) => {
171-
assert.equal(isValidChangenoteFileOrDir(tmpDir), true);
175+
assert.equal(isValidAllChangenoteFiles([fileName1, fileName2]), true);
172176
});
173177
});
174178

175-
await it("accepts a directory of .gitkeep only", async () => {
176-
await withTmpFile(".gitkeep", "", async (filePath) => {
177-
const dirPath = path.dirname(filePath);
178-
assert.equal(isValidChangenoteFileOrDir(dirPath), true);
179-
});
179+
await it("accepts an empty list", async () => {
180+
assert.equal(isValidAllChangenoteFiles([]), true);
180181
});
181182

182-
await it("rejects a non-existent path", async () => {
183-
assert.equal(isValidChangenoteFileOrDir("non-existent-file.md"), false);
184-
assert.equal(isValidChangenoteFileOrDir("this-dir-does-not-exist"), false);
183+
await it("accepts a list of .gitkeep only", async () => {
184+
assert.equal(isValidAllChangenoteFiles([".gitkeep"]), true);
185185
});
186186

187-
await it("rejects invalid filename", async () => {
188-
await withTmpFile(
189-
"fix-bug.md",
190-
"---\ncategory: fix\n---\n- Fixed a bug\n",
191-
(filePath) => {
192-
assert.equal(isValidChangenoteFileOrDir(filePath), false);
193-
},
194-
);
195-
});
196-
197-
await it("rejects missing frontmatter", async () => {
198-
await withTmpFile(
199-
"2026-01-01-fix-bug.md",
200-
"- Fixed a bug\n",
201-
(filePath) => {
202-
assert.equal(isValidChangenoteFileOrDir(filePath), false);
203-
},
204-
);
205-
});
206-
207-
await it("rejects invalid Markdown", async () => {
208-
await withTmpFile(
209-
"2026-01-01-fix-bug.md",
210-
"---\ncategory: fix\n---\n* Fixed a bug\n",
211-
(filePath) => {
212-
assert.equal(isValidChangenoteFileOrDir(filePath), false);
213-
},
214-
);
215-
});
216-
217-
await it("rejects directory with one invalid change-note file", async () => {
187+
await it("rejects directory with an invalid change-note file", async () => {
218188
await withTmpDir(async (tmpDir) => {
189+
const fileName1 = path.join(tmpDir, "2026-01-01-fix-bug.md");
190+
const fileName2 = path.join(tmpDir, "2026-01-02-wrong-category.md");
191+
fs.writeFileSync(fileName1, "---\ncategory: fix\n---\n- Fixed a bug\n");
219192
fs.writeFileSync(
220-
path.join(tmpDir, "2026-01-01-fix-bug.md"),
221-
"---\ncategory: fix\n---\n- Fixed a bug\n",
222-
);
223-
fs.writeFileSync(
224-
path.join(tmpDir, "2026-01-02-wrong-category.md"),
193+
fileName2,
225194
"---\ncategory: foobar\n---\n- Added a feature\n",
226195
);
227-
assert.equal(isValidChangenoteFileOrDir(tmpDir), false);
196+
assert.equal(isValidAllChangenoteFiles([fileName1, fileName2]), false);
228197
});
229198
});
230199
});
Collapse file

‎pr-checks/changenotes.mts‎

Copy file name to clipboardExpand all lines: pr-checks/changenotes.mts
+15-2Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
#!/usr/bin/env npx tsx
22

3+
import * as fs from "node:fs";
34
import { pathToFileURL } from "node:url";
45
import { parseArgs } from "node:util";
56

6-
import { isValidChangenoteFileOrDir } from "./changelog/validate.mjs";
7+
import { isValidAllChangenoteFiles } from "./changelog/validate.mjs";
78
import { CHANGENOTES_DIR } from "./config";
89

910
const entryPoint = process.argv[1];
@@ -27,7 +28,7 @@ function main(): number {
2728
case "help":
2829
return usage();
2930
case "validate":
30-
return isValidChangenoteFileOrDir(CHANGENOTES_DIR) ? 0 : 1;
31+
return validate();
3132
default:
3233
console.error(`Unknown command: ${command}`);
3334
return 1;
@@ -38,3 +39,15 @@ function usage(): number {
3839
console.log(`Usage: changenotes.mts validate`);
3940
return 0;
4041
}
42+
43+
function validate(): number {
44+
try {
45+
return isValidAllChangenoteFiles(fs.readdirSync(CHANGENOTES_DIR)) ? 0 : 1;
46+
} catch (error) {
47+
console.error(
48+
`${CHANGENOTES_DIR}: failed to read file or directory`,
49+
error,
50+
);
51+
return 1;
52+
}
53+
}

0 commit comments

Comments
0 (0)
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.