Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
92 changes: 92 additions & 0 deletions .github/script/validate-filepaths/__tests__/validate.test.js
Original file line number Diff line number Diff line change
@@ -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;
}
Comment on lines +8 to +10
Comment on lines +8 to +10

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);
});
Comment on lines +87 to +91
});
31 changes: 31 additions & 0 deletions .github/workflows/validate-filepaths.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Validate Filepaths Tests

on:
push:
branches:
- main
- master
pull_request:
branches:
Comment thread
Arvuno marked this conversation as resolved.
- main
- 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
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.