feat: add isTestFile utility and update file-component-naming rule to skip test files

Author: andrewmolyuk

src/rules/file-component-naming.js

@@ -1,5 +1,5 @@
 import path from 'path'
-import { parseRuleOptions, toPascalCase, isComponent, isFileIgnored, isOutsideSrc } from '../utils'
+import { parseRuleOptions, toPascalCase, isComponent, isFileIgnored, isOutsideSrc, isTestFile } from '../utils'
 
 const defaultOptions = {
   src: 'src', // Base source directory
@@ -34,6 +34,7 @@ export default {
     const filename = context.getFilename()
     const { src, ignore } = parseRuleOptions(context, defaultOptions)
 
+    if (isTestFile(filename)) return {}
     if (!isComponent(filename)) return {}
     if (isFileIgnored(filename, ignore)) return {}
     if (isOutsideSrc(filename, src)) return {}

src/utils.js

@@ -29,7 +29,7 @@ export function toPascalCase(name) {
 // Utility to check if a file is a Vue component based on its path
 export function isComponent(filename) {
   if (!filename) return false
-  const lower = filename.toLowerCase()
+  const lower = String(filename).toLowerCase()
   return lower.endsWith('.vue') || lower.includes('.component.') || lower.includes('.comp.')
 }
 
@@ -46,3 +46,10 @@ export function isOutsideSrc(filename, src) {
   const parts = rel.split(path.sep)
   return !parts.includes(src)
 }
+
+// Utility to check if a file is likely a test file based on its path
+export function isTestFile(filename) {
+  if (!filename) return false
+  const lower = String(filename).toLowerCase()
+  return lower.includes('/test/') || lower.includes('/tests/') || lower.includes('.spec.') || lower.includes('.test.')
+}

tests/rules/file-component-naming.test.js

@@ -82,4 +82,10 @@ describe('vue-modular/file-component-naming (compact)', () => {
     const ctxAbs = { getFilename: () => absFilename, options: [{ ignore: [absFilename] }] }
     expect(rule.create(ctxAbs)).toEqual({})
   })
+
+  it('skips test files via direct create() invocation', () => {
+    const testFile = path.join(process.cwd(), 'src', 'components', 'MyComponent.spec.vue')
+    const ctxTest = { getFilename: () => testFile, options: [{}] }
+    expect(rule.create(ctxTest)).toEqual({})
+  })
 })

tests/utils.test.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import { describe, it, expect } from 'vitest'
-import { parseRuleOptions, toPascalCase, isComponent, isFileIgnored, isOutsideSrc } from '../src/utils.js'
+import { parseRuleOptions, toPascalCase, isComponent, isFileIgnored, isOutsideSrc, isTestFile } from '../src/utils.js'
 
 describe('src/utils', () => {
   describe('parseRuleOptions', () => {
@@ -53,11 +53,24 @@ describe('src/utils', () => {
   describe('isOutsideSrc', () => {
     it('returns false when inside src and true when outside', () => {
       const inSrc = path.join(process.cwd(), 'src', 'components', 'Foo.vue')
-      const out = path.join(process.cwd(), 'other', 'components', 'Foo.vue')
+      const outSrc = path.join(process.cwd(), 'other', 'components', 'Foo.vue')
       expect(isOutsideSrc(inSrc, 'src')).toBe(false)
-      expect(isOutsideSrc(out, 'src')).toBe(true)
+      expect(isOutsideSrc(outSrc, 'src')).toBe(true)
       expect(isOutsideSrc(inSrc, '')).toBe(false)
       expect(isOutsideSrc(inSrc, undefined)).toBe(false)
     })
   })
+
+  describe('isTestFile', () => {
+    it('detects test files by folder or filename', () => {
+      expect(isTestFile(path.join(process.cwd(), 'src', 'tests', 'Foo.spec.js'))).toBe(true)
+      expect(isTestFile(path.join(process.cwd(), 'src', 'test', 'Foo.js'))).toBe(true)
+      expect(isTestFile(path.join(process.cwd(), 'src', 'components', 'Foo.test.ts'))).toBe(true)
+      expect(isTestFile(path.join(process.cwd(), 'src', 'components', 'Foo.spec.vue'))).toBe(true)
+      expect(isTestFile(path.join(process.cwd(), 'src', 'components', 'NotATest.vue'))).toBe(false)
+      expect(isTestFile('')).toBe(false)
+      expect(isTestFile(null)).toBe(false)
+      expect(isTestFile(undefined)).toBe(false)
+    })
+  })
 })