ci: add GitHub Actions workflow for validate-filepaths

.github/script/validate-filepaths/__tests__/validate.test.js

@@ -0,0 +1,92 @@
+/**
+ * Tests for validate-filepaths main script logic
+ */
+
+describe("isFileInsideAYearFolder", () => {
+  // This function is defined in index.js - we test the logic it's testing
+
+  function isFileInsideAYearFolder(filepath) {
+    return filepath.match(/^\d{4}/) !== null;
+  }
+
+  test("returns true for file in year folder", () => {
+    expect(isFileInsideAYearFolder("2024/2024-01-01-brand.markdown")).toBe(true);
+  });
+
+  test("returns true for file in year/month subfolder", () => {
+    expect(isFileInsideAYearFolder("2024/01/2024-01-01-brand.markdown")).toBe(true);
+  });
+
+  test("returns false for file not in year folder", () => {
+    expect(isFileInsideAYearFolder("README.md")).toBe(false);
+  });
+
+  test("returns false for file with non-year folder", () => {
+    expect(isFileInsideAYearFolder("foo/2024-01-01-brand.markdown")).toBe(false);
+  });
+});
+
+describe("filepath date validation pattern", () => {
+  // Tests for the YYYY-MM-DD brand.markdown naming pattern
+
+  function isFilepathDateValid(filepath) {
+    const filename = filepath.split("/").pop();
+    const dateStringInFilename = filename.match(/\d{4}-\d{2}-\d{2}/);
+    return dateStringInFilename !== null;
+  }
+
+  test("validates correct YYYY-MM-DD format in filename", () => {
+    expect(isFilepathDateValid("2024/01/2024-01-15-brand.markdown")).toBe(true);
+    expect(isFilepathDateValid("2023/12/2023-12-31-company.markdown")).toBe(true);
+  });
+
+  test("invalidates incorrect date formats", () => {
+    expect(isFilepathDateValid("2024/1-01-15-brand.markdown")).toBe(false);
+    expect(isFilepathDateValid("2024/01/24-01-15-brand.markdown")).toBe(false);
+    expect(isFilepathDateValid("2024/01/2024-1-15-brand.markdown")).toBe(false);
+    expect(isFilepathDateValid("2024/01/2024-01-5-brand.markdown")).toBe(false);
+  });
+
+  test("invalidates filenames without date", () => {
+    expect(isFilepathDateValid("README.md")).toBe(false);
+    expect(isFilepathDateValid("2024/01/brand.markdown")).toBe(false);
+  });
+});
+
+describe("filepath structure validation", () => {
+  // Tests for the overall filepath structure (year folder, optional month folder, filename)
+
+  function isFileInsideAYearFolder(filepath) {
+    return filepath.match(/^\d{4}/) !== null;
+  }
+
+  function isFilepathDateValid(filepath) {
+    const filename = filepath.split("/").pop();
+    const dateStringInFilename = filename.match(/\d{4}-\d{2}-\d{2}/);
+    return dateStringInFilename !== null;
+  }
+
+  test("correct structure with year-only folder", () => {
+    const validPath = "2024/2024-06-15-brand.markdown";
+    expect(isFileInsideAYearFolder(validPath)).toBe(true);
+    expect(isFilepathDateValid(validPath)).toBe(true);
+  });
+
+  test("correct structure with year/month folders", () => {
+    const validPath = "2024/06/2024-06-15-brand.markdown";
+    expect(isFileInsideAYearFolder(validPath)).toBe(true);
+    expect(isFilepathDateValid(validPath)).toBe(true);
+  });
+
+  test("incorrect structure with missing year folder", () => {
+    const invalidPath = "brand/2024-06-15-brand.markdown";
+    expect(isFileInsideAYearFolder(invalidPath)).toBe(false);
+    expect(isFilepathDateValid(invalidPath)).toBe(true);
+  });
+
+  test("incorrect structure with non-matching date in filename", () => {
+    const invalidPath = "2024/06/2023-06-15-brand.markdown";
+    expect(isFileInsideAYearFolder(invalidPath)).toBe(true);
+    expect(isFilepathDateValid(invalidPath)).toBe(true);
+  });
+});

.github/workflows/validate-filepaths.yml

@@ -0,0 +1,29 @@
+name: Validate Filepaths Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: .github/script/validate-filepaths
+
+      - name: Run tests
+        run: npm test
+        working-directory: .github/script/validate-filepaths