chore: add filename checker to enforce use kebab-case (#55)

.github/workflows/lint-and-fmt.yml

@@ -33,3 +33,7 @@ jobs:
       - name: Format check
         run: |
           pnpm fmt:check
+
+      - name: Check filename
+        run: |
+          pnpm lint:filename

package.json

@@ -12,7 +12,8 @@
     "serve": "vitepress serve src",
     "fmt": "lint-md src/**/*.md --fix && prettier --write .",
     "fmt:check": "lint-md src/**/*.md && prettier --check .",
-    "img:compress": "tsx scripts/compress-image.mts"
+    "img:compress": "tsx scripts/compress-image.mts",
+    "lint:filename": "tsx scripts/check-filename.mts"
   },
   "dependencies": {
     "@tailwindcss/typography": "^0.5.11",

scripts/check-filename.mts

@@ -0,0 +1,38 @@
+import { resolve } from 'node:path'
+import { readdirSync } from 'node:fs'
+
+const POST_DIR = resolve('src/posts')
+const IN_GITHUB_ACTIONS = process.env.GITHUB_ACTIONS === 'true'
+
+function isKebabCase(filename: string): boolean {
+  return /^[a-z0-9-]+$/.test(filename)
+}
+
+function suggestKebabCase(filename: string): string {
+  return filename.toLowerCase().replace('_', '-').toLowerCase()
+}
+
+function getAllPostFilenames(): string[] {
+  return readdirSync(POST_DIR).map((filename) => filename.replace(/\.md$/, ''))
+}
+
+function main() {
+  const postFilenames = getAllPostFilenames()
+  let hasError = false
+  for (const filename of postFilenames) {
+    const filepath = resolve(POST_DIR, `${filename}.md`)
+    if (!isKebabCase(filename)) {
+      const errorMesssage = `Filename "${filename}" is not in kebab-case, suggest: "${suggestKebabCase(filename)}"`
+      if (IN_GITHUB_ACTIONS) {
+        console.log(`::error file=${filepath}::${errorMesssage}`)
+      }
+      console.error(errorMesssage)
+      hasError = true
+    }
+  }
+  if (hasError) {
+    process.exit(1)
+  }
+}
+
+main()