refactor: rename test-utils to utils and update import paths

andrewmolyuk · andrewmolyuk · commit 5ebcd6f021a0 · 2025-09-04T10:56:43.000+03:00
diff --git a/.codacy.yml b/.codacy.yml
@@ -2,8 +2,8 @@ engines:
   duplication:
     enabled: true
     exclude_paths:
-      - 'test/**'
+      - 'tests/**'
   metric:
     enabled: true
     exclude_paths:
-      - 'test/**'
+      - 'tests/**'
diff --git a/eslint.config.js b/eslint.config.js
@@ -24,7 +24,7 @@ export default [
     },
   },
   {
-    files: ['test/**/*.js'],
+    files: ['tests/**/*.js'],
     // tests run under vitest/jest-like globals
     languageOptions: {
       globals: {
diff --git a/tests/enforce-app-structure.spec.js b/tests/enforce-app-structure.spec.js
@@ -1,7 +1,7 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest'
 import fs from 'fs'
 import appStructureRule from '../src/rules/enforce-app-structure.js'
-import { setupTest, runRule, createMockFileSystem } from './test-utils.js'
+import { setupTest, runRule, createMockFileSystem } from './utils'
 
 describe('enforce-app-structure rule', () => {
   beforeEach(setupTest)
diff --git a/tests/enforce-feature-exports.spec.js b/tests/enforce-feature-exports.spec.js
@@ -1,7 +1,7 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest'
 import fs from 'fs'
 import featureStructureRule from '../src/rules/enforce-feature-exports.js'
-import { setupTest, runRule, createMockFileSystem } from './test-utils.js'
+import { setupTest, runRule, createMockFileSystem } from './utils'
 
 describe('enforce-feature-exports rule', () => {
   beforeEach(setupTest)
diff --git a/tests/enforce-import-boundaries.spec.js b/tests/enforce-import-boundaries.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, beforeEach } from 'vitest'
 import plugin from '../src/index.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('vue-modular/enforce-import-boundaries rule', () => {
   let ruleTester
diff --git a/tests/enforce-module-exports.spec.js b/tests/enforce-module-exports.spec.js
@@ -1,7 +1,7 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest'
 import fs from 'fs'
 import moduleStructureRule from '../src/rules/enforce-module-exports.js'
-import { setupTest, runRule, createMockFileSystem } from './test-utils.js'
+import { setupTest, runRule, createMockFileSystem } from './utils'
 
 describe('enforce-module-exports rule', () => {
   beforeEach(setupTest)
diff --git a/tests/enforce-src-structure.spec.js b/tests/enforce-src-structure.spec.js
@@ -1,7 +1,7 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest'
 import fs from 'fs'
 import srcStructureRule, { resetSession } from '../src/rules/enforce-src-structure.js'
-import { setupTestWithReset, createContext, runRule } from './test-utils.js'
+import { setupTestWithReset, createContext, runRule } from './utils'
 
 describe('enforce-src-structure rule', () => {
   beforeEach(setupTestWithReset(resetSession))
diff --git a/tests/no-business-logic-in-ui-kit.spec.js b/tests/no-business-logic-in-ui-kit.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, expect, beforeEach } from 'vitest'
 import plugin from '../src/index.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('vue-modular/no-business-logic-in-ui-kit rule', () => {
   let ruleTester
diff --git a/tests/no-cross-feature-imports.spec.js b/tests/no-cross-feature-imports.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, expect, beforeEach } from 'vitest'
 import plugin from '../src/index.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('vue-modular/no-cross-feature-imports rule', () => {
   let ruleTester
diff --git a/tests/no-cross-module-imports.spec.js b/tests/no-cross-module-imports.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, beforeEach } from 'vitest'
 import plugin from '../src/index.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('vue-modular/no-cross-module-imports rule', () => {
   let ruleTester
diff --git a/tests/no-deep-nesting.spec.js b/tests/no-deep-nesting.spec.js
@@ -1,5 +1,5 @@
 import { describe, it, beforeEach } from 'vitest'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 import noDeepNestingRule from '../src/rules/no-deep-nesting.js'
 
 describe('no-deep-nesting rule', () => {
diff --git a/tests/no-orphaned-files.spec.js b/tests/no-orphaned-files.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, beforeEach } from 'vitest'
 import noOrphanedFilesRule from '../src/rules/no-orphaned-files.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('no-orphaned-files rule', () => {
   let ruleTester
diff --git a/tests/test-files-handling.spec.js b/tests/test-files-handling.spec.js
@@ -1,6 +1,6 @@
 import { describe, it, beforeEach, expect } from 'vitest'
 import plugin from '../src/index.js'
-import { setupRuleTester } from './test-utils.js'
+import { setupRuleTester } from './utils'
 
 describe('Test files handling', () => {
   let ruleTester
diff --git a/tests/test-utils.js b/tests/test-utils.js
diff --git a/tests/utils/context.js b/tests/utils/context.js
@@ -0,0 +1,36 @@
+import { vi } from 'vitest'
+
+/**
+ * Creates a mock ESLint context for testing rules
+ * @param {string} filename - The filename to mock (default: '/project/src/App.vue')
+ * @param {Array} options - Rule options (default: [{}])
+ * @returns {Object} Mock ESLint context
+ */
+export const createContext = (filename = '/project/src/App.vue', options = [{}]) => ({
+  options,
+  getFilename: () => filename,
+  report: vi.fn(),
+  settings: {},
+})
+
+/**
+ * Helper to run an ESLint rule with a given context
+ * @param {Object} rule - The ESLint rule object
+ * @param {Object} context - The ESLint context (default: creates new context)
+ * @returns {Object} The context after running the rule
+ */
+export const runRule = (rule, context = createContext()) => {
+  const ruleInstance = rule.create(context)
+  if (ruleInstance.Program) ruleInstance.Program()
+  return context
+}
+
+/**
+ * Helper to create a rule instance without running it
+ * @param {Object} rule - The ESLint rule object
+ * @param {Object} context - The ESLint context (default: creates new context)
+ * @returns {Object} The rule instance
+ */
+export const createRuleInstance = (rule, context = createContext()) => {
+  return rule.create(context)
+}
diff --git a/tests/utils/index.js b/tests/utils/index.js
@@ -0,0 +1,4 @@
+export * from './mocks.js'
+export * from './ruleTester.js'
+export * from './context.js'
+export * from './patterns.js'
diff --git a/tests/utils/mocks.js b/tests/utils/mocks.js
@@ -0,0 +1,36 @@
+import { vi } from 'vitest'
+
+/**
+ * Restores all mocks and clears global state
+ */
+export const resetMocks = () => {
+  vi.restoreAllMocks()
+  if (global.__eslintVueModularState) {
+    delete global.__eslintVueModularState
+  }
+}
+
+/**
+ * Standard test setup function
+ * Alias for resetMocks for compatibility
+ */
+export const setupTest = resetMocks
+
+/**
+ * Cleans up global state used by vue-modular plugin
+ * Should be called in beforeEach or afterEach hooks
+ */
+export const cleanupGlobalState = () => {
+  if (global.__eslintVueModularState) {
+    delete global.__eslintVueModularState
+  }
+}
+
+/**
+ * Setup with custom reset function
+ * @param {Function} resetFn - Custom reset function to call
+ */
+export const setupTestWithReset = (resetFn) => () => {
+  vi.restoreAllMocks()
+  resetFn()
+}
diff --git a/tests/utils/patterns.js b/tests/utils/patterns.js
@@ -0,0 +1,41 @@
+import { minimatch } from 'minimatch'
+
+/**
+ * Creates test cases for file patterns
+ * @param {string|string[]} patterns - Glob patterns for filenames
+ * @param {Object} testCase - Base test case template
+ * @returns {Array} Generated test cases
+ */
+export const createPatternTestCases = (patterns, testCase) => {
+  const patternArray = Array.isArray(patterns) ? patterns : [patterns]
+  return patternArray.map((pattern) => ({
+    ...testCase,
+    filename: pattern,
+  }))
+}
+
+/**
+ * Validates filename against multiple patterns
+ * @param {string} filename - File to check
+ * @param {string[]} patterns - Patterns to match against
+ * @returns {boolean} True if matches any pattern
+ */
+export const matchesAnyPattern = (filename, patterns) => {
+  return patterns.some((pattern) => minimatch(filename, pattern))
+}
+
+/**
+ * Creates a mock file system implementation using pattern matching
+ * @param {Object} structure - Object mapping glob patterns to file arrays
+ * @returns {Function} Mock implementation function
+ */
+export const createMockFileSystem = (structure) => {
+  return (path) => {
+    for (const [pattern, files] of Object.entries(structure)) {
+      if (minimatch(path, pattern)) {
+        return files
+      }
+    }
+    return []
+  }
+}
diff --git a/tests/utils/ruleTester.js b/tests/utils/ruleTester.js
@@ -0,0 +1,23 @@
+import { RuleTester } from 'eslint'
+import plugin from '../../src/index.js'
+
+/**
+ * Creates a configured RuleTester instance for vue-modular plugin tests
+ * @returns {RuleTester} Configured RuleTester instance
+ */
+export const createRuleTester = () => {
+  return new RuleTester({
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+    },
+    plugins: {
+      'vue-modular': plugin,
+    },
+  })
+}
+
+export const setupRuleTester = () => {
+  // Keep backward compatibility
+  return createRuleTester()
+}

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export default [`
`24`	`24`	`},`
`25`	`25`	`},`
`26`	`26`	`{`
`27`		`- files: ['test/*/.js'],`
	`27`	`+ files: ['tests/*/.js'],`
`28`	`28`	`// tests run under vitest/jest-like globals`
`29`	`29`	`languageOptions: {`
`30`	`30`	`globals: {`