chore(utils) add ts file naming convention checker #1423

Author: erossignon

.github/workflows/ci.yaml

@@ -98,6 +98,17 @@ jobs:
                   node-version: 20
             - name: verify packages version consistency accross sub-modules
               run: npm run check:versions
+    naming_consistency:
+        name: Check typescript file naming consistency
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v1
+            - name: install node v24
+              uses: actions/setup-node@v1
+              with:
+                  node-version: 24
+            - name: verify that source file follow the kebab-case naming convention
+              run: npm run check:naming
 
     prettier:
         name: Check coding style

package-lock.json

@@ -31,6 +31,7 @@
         "prepare": "husky install",
         "publish": "npm publish --workspaces",
         "check:versions": "node utils/check_package_version_consistency.js",
+        "check:naming": "npx tsx utils/check-kebab-case-naming-convention.ts",
         "build:docker": "docker build -t wot-servient .",
         "build:podman": "podman build -t wot-servient .",
         "clean:dist": "npm exec  --workspaces -- npx rimraf tsconfig.tsbuildinfo dist",
@@ -70,6 +71,7 @@
         "eslint-plugin-unused-imports": "^3.0.0",
         "eslint-plugin-workspaces": "^0.9.0",
         "husky": "^7.0.4",
+        "ignore": "^7.0.5",
         "mocha": "^11.7.2",
         "prettier": "3.3.3",
         "pretty-quick": "^4.0.0",

package.json

@@ -0,0 +1,49 @@
+import fs from "fs";
+import path from "path";
+import ignore from "ignore";
+
+function isKebabCase(filename: string): boolean {
+    const basename = path.basename(filename, path.extname(filename));
+    return /^[a-z0-9]+(-[a-z0-9]+)*(\.[a-z0-9]+)?$/.test(basename);
+}
+
+function checkTsFiles(dir: string, ig: ignore.Ignore, invalidFiles: string[] = []): string[] {
+    const files = fs.readdirSync(dir);
+
+    for (const file of files) {
+        const fullPath = path.join(dir, file);
+        const relativePath = path.relative(process.cwd(), fullPath);
+        const stat = fs.statSync(fullPath);
+
+        if (ig.ignores(relativePath)) {
+            continue; // Skip ignored files/folders
+        }
+
+        if (stat.isDirectory()) {
+            checkTsFiles(fullPath, ig, invalidFiles);
+        } else if (file.endsWith(".ts")) {
+            if (!isKebabCase(file)) {
+                invalidFiles.push(relativePath);
+            }
+        }
+    }
+
+    return invalidFiles;
+}
+
+function main() {
+    const projectRoot = process.cwd();
+    const ig = ignore().add(fs.readFileSync(path.join(projectRoot, ".gitignore")).toString());
+    const invalidFiles = checkTsFiles(projectRoot, ig);
+
+    if (invalidFiles.length > 0) {
+        console.error("The following files do not follow kebab-case naming:");
+        invalidFiles.forEach((file) => console.error(`- ${file}`));
+        process.exit(1);
+    } else {
+        console.log("All .ts files follow kebab-case naming!");
+        process.exit(0);
+    }
+}
+
+main();