chore(merge): improve folder-kebab-case rule to skip non-directory entries and enhance test cases (#28)

Author: andrewmolyuk

src/rules/folder-kebab-case.ts

@@ -20,15 +20,17 @@ export const folderKebabCase = createRule<VueModularRuleModule>({
 
         if (!fs.existsSync(root)) return
         try {
-          const entries = fs.readdirSync(root, { recursive: true })
+          const entries: fs.Dirent[] = fs.readdirSync(root, { recursive: true }) as unknown as fs.Dirent[]
 
           entries.forEach((dir) => {
+            if (dir.isDirectory() === false) return
             const fullPath = path.join(root, String(dir))
             if (isIgnored(fullPath, options.ignores)) return
             const base = path.basename(fullPath)
             const kebab = toKebabCase(base)
             if (kebab !== base) {
-              context.report({ node, messageId: 'folderNotKebab', data: { folder: String(dir), kebab } })
+              context.report({ node, messageId: 'folderNotKebab', data: { folder: String(dir), expected: kebab } })
+              return
             }
           })
         } catch {

tests/rules/folder-kebab-case.test.ts

@@ -7,6 +7,8 @@ import fs from 'fs'
 describe('folder-kebab-case', () => {
   beforeEach(() => setupTest())
 
+  const makeDirent = (n: string, isDir = true) => ({ name: Buffer.from(n), isDirectory: () => isDir, toString: () => n })
+
   it('does nothing when project root does not exist', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(false)
     const context = runRule(folderKebabCase, 'filename.ts')
@@ -15,25 +17,40 @@ describe('folder-kebab-case', () => {
 
   it('reports non-kebab folder entries', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(true)
-    vi.spyOn(fs, 'readdirSync').mockReturnValue(['FooBar', 'baz-qux'] as unknown as fs.Dirent<Buffer<ArrayBufferLike>>[])
+    vi.spyOn(fs, 'readdirSync').mockReturnValue([makeDirent('FooBar'), makeDirent('baz-qux')] as unknown as fs.Dirent<Buffer>[])
     const context = runRule(folderKebabCase, 'filename.ts')
     expect(context.report).toHaveBeenCalledTimes(1)
   })
 
   it('does not report when entry is already kebab-case', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(true)
-    vi.spyOn(fs, 'readdirSync').mockReturnValue(['foo-bar', 'baz-qux'] as unknown as fs.Dirent<Buffer<ArrayBufferLike>>[])
+    vi.spyOn(fs, 'readdirSync').mockReturnValue([makeDirent('foo-bar'), makeDirent('baz-qux')] as unknown as fs.Dirent<Buffer>[])
     const context = runRule(folderKebabCase, 'filename.ts')
     expect(context.report).not.toHaveBeenCalled()
   })
 
   it('respects ignores (skips ignored folders)', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(true)
-    vi.spyOn(fs, 'readdirSync').mockReturnValue(['FooBar', 'baz-qux', 'IgnoreMe'] as unknown as fs.Dirent<Buffer<ArrayBufferLike>>[])
+    vi.spyOn(fs, 'readdirSync').mockReturnValue([
+      makeDirent('FooBar'),
+      makeDirent('baz-qux'),
+      makeDirent('IgnoreMe'),
+    ] as unknown as fs.Dirent<Buffer>[])
     const context = runRule(folderKebabCase, 'filename.ts', [{ ignores: ['**/IgnoreMe'] }])
     expect(context.report).toHaveBeenCalledTimes(1)
   })
 
+  it('skips non-directory entries (files)', () => {
+    vi.spyOn(fs, 'existsSync').mockReturnValue(true)
+    vi.spyOn(fs, 'readdirSync').mockReturnValue([
+      makeDirent('FooBar', false), // a file-like entry
+      makeDirent('NotKebab', true),
+    ] as unknown as fs.Dirent<Buffer>[])
+    const context = runRule(folderKebabCase, 'filename.ts')
+    // only the real directory 'NotKebab' should be reported
+    expect(context.report).toHaveBeenCalledTimes(1)
+  })
+
   it('handles fs errors gracefully (does not throw)', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(true)
     vi.spyOn(fs, 'readdirSync').mockImplementation(() => {
@@ -45,7 +62,7 @@ describe('folder-kebab-case', () => {
 
   it('does nothing when runOnce returns false', () => {
     vi.spyOn(fs, 'existsSync').mockReturnValue(true)
-    vi.spyOn(fs, 'readdirSync').mockReturnValue(['FooBar', 'baz-qux'] as unknown as fs.Dirent<Buffer<ArrayBufferLike>>[])
+    vi.spyOn(fs, 'readdirSync').mockReturnValue([makeDirent('FooBar'), makeDirent('baz-qux')] as unknown as fs.Dirent<Buffer>[])
     const context1 = runRule(folderKebabCase, 'filename1.ts')
     const context2 = runRule(folderKebabCase, 'filename2.ts')
     expect(context1.report).toHaveBeenCalledTimes(1)