mirror of
https://github.com/samiyev/puaros.git
synced 2025-12-28 07:16:53 +05:00
feat(guardian): add guardian package - code quality analyzer
Add @puaros/guardian package v0.1.0 - code quality guardian for vibe coders and enterprise teams. Features: - Hardcode detection (magic numbers, magic strings) - Circular dependency detection - Naming convention enforcement (Clean Architecture) - Architecture violation detection - CLI tool with comprehensive reporting - 159 tests with 80%+ coverage - Smart suggestions for fixes - Built for AI-assisted development Built with Clean Architecture and DDD principles. Works with Claude, GPT, Copilot, Cursor, and any AI coding assistant.
This commit is contained in:
imfozilbek
@@ -0,0 +1,471 @@
|
||||
import { describe, it, expect, beforeEach } from "vitest"
|
||||
import { HardcodeDetector } from "../../../src/infrastructure/analyzers/HardcodeDetector"
|
||||
import { HARDCODE_TYPES } from "../../../src/shared/constants"
|
||||
|
||||
describe("HardcodeDetector", () => {
|
||||
let detector: HardcodeDetector
|
||||
|
||||
beforeEach(() => {
|
||||
detector = new HardcodeDetector()
|
||||
})
|
||||
|
||||
describe("detectMagicNumbers", () => {
|
||||
describe("setTimeout and setInterval", () => {
|
||||
it("should detect timeout values in setTimeout", () => {
|
||||
const code = `setTimeout(() => {}, 5000)`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 5000)).toBe(true)
|
||||
expect(result[0].type).toBe(HARDCODE_TYPES.MAGIC_NUMBER)
|
||||
expect(result[0].line).toBe(1)
|
||||
})
|
||||
|
||||
it("should detect interval values in setInterval", () => {
|
||||
const code = `setInterval(() => {}, 3000)`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 3000)).toBe(true)
|
||||
})
|
||||
|
||||
it("should detect multiple timeout values", () => {
|
||||
const code = `
|
||||
setTimeout(() => {}, 5000)
|
||||
setTimeout(() => {}, 10000)
|
||||
setInterval(() => {}, 3000)
|
||||
`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThanOrEqual(3)
|
||||
const values = result.map((r) => r.value)
|
||||
expect(values).toContain(5000)
|
||||
expect(values).toContain(10000)
|
||||
expect(values).toContain(3000)
|
||||
})
|
||||
})
|
||||
|
||||
describe("retry and attempts", () => {
|
||||
it("should detect maxRetries values", () => {
|
||||
const code = `const maxRetries = 3`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe(3)
|
||||
})
|
||||
|
||||
it("should detect retries values", () => {
|
||||
const code = `const retries = 5`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe(5)
|
||||
})
|
||||
|
||||
it("should detect attempts values", () => {
|
||||
const code = `const attempts = 7`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe(7)
|
||||
})
|
||||
})
|
||||
|
||||
describe("ports", () => {
|
||||
it("should detect lowercase port", () => {
|
||||
const code = `const port = 8080`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 8080)).toBe(true)
|
||||
})
|
||||
|
||||
it("should detect uppercase PORT", () => {
|
||||
const code = `const PORT = 3000`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 3000)).toBe(true)
|
||||
})
|
||||
})
|
||||
|
||||
describe("limits", () => {
|
||||
it("should detect limit values", () => {
|
||||
const code = `const limit = 50`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe(50)
|
||||
})
|
||||
|
||||
it("should detect max values", () => {
|
||||
const code = `const max = 150`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 150)).toBe(true)
|
||||
})
|
||||
|
||||
it("should detect min values", () => {
|
||||
const code = `const min = 15`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe(15)
|
||||
})
|
||||
})
|
||||
|
||||
describe("delay and timeout", () => {
|
||||
it("should detect delay values", () => {
|
||||
const code = `const delay = 2000`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 2000)).toBe(true)
|
||||
})
|
||||
|
||||
it("should detect timeout values", () => {
|
||||
const code = `const timeout = 5000`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value === 5000)).toBe(true)
|
||||
})
|
||||
})
|
||||
|
||||
describe("allowed numbers", () => {
|
||||
it("should NOT detect -1", () => {
|
||||
const code = `const notFound = -1`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect 0", () => {
|
||||
const code = `const index = 0`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect 1", () => {
|
||||
const code = `const increment = 1`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect 2", () => {
|
||||
const code = `const pair = 2`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect 10, 100, 1000", () => {
|
||||
const code = `
|
||||
const ten = 10
|
||||
const hundred = 100
|
||||
const thousand = 1000
|
||||
`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("exported constants", () => {
|
||||
it("should NOT detect numbers in single-line export const with as const", () => {
|
||||
const code = `export const CONFIG = { timeout: 5000 } as const`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect numbers in multi-line export const with as const", () => {
|
||||
const code = `
|
||||
export const CONFIG = {
|
||||
timeout: 5000,
|
||||
port: 8080,
|
||||
retries: 3,
|
||||
} as const
|
||||
`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect numbers in nested export const", () => {
|
||||
const code = `
|
||||
export const SETTINGS = {
|
||||
api: {
|
||||
timeout: 10000,
|
||||
port: 3000,
|
||||
},
|
||||
db: {
|
||||
port: 5432,
|
||||
},
|
||||
} as const
|
||||
`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should detect numbers in export const WITHOUT as const", () => {
|
||||
const code = `export const CONFIG = { timeout: 5000 }`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("comments and strings", () => {
|
||||
it("should NOT detect numbers in comments", () => {
|
||||
const code = `// timeout is 5000ms`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect numbers in multi-line comments", () => {
|
||||
const code = `
|
||||
/*
|
||||
* timeout: 5000
|
||||
* port: 8080
|
||||
*/
|
||||
`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("generic 3+ digit numbers", () => {
|
||||
it("should detect suspicious 3-digit numbers with config context", () => {
|
||||
const code = `const timeout = 500`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it("should NOT detect 3-digit numbers without context", () => {
|
||||
const code = `const x = 123`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("detectMagicStrings", () => {
|
||||
describe("URLs and API endpoints", () => {
|
||||
it("should detect http URLs", () => {
|
||||
const code = `const url = "http://localhost:8080"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe("http://localhost:8080")
|
||||
expect(result[0].type).toBe(HARDCODE_TYPES.MAGIC_STRING)
|
||||
})
|
||||
|
||||
it("should detect https URLs", () => {
|
||||
const code = `const url = "https://api.example.com"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe("https://api.example.com")
|
||||
})
|
||||
|
||||
it("should detect mongodb connection strings", () => {
|
||||
const code = `const dbUrl = "mongodb://localhost:27017/mydb"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe("mongodb://localhost:27017/mydb")
|
||||
})
|
||||
})
|
||||
|
||||
describe("allowed strings", () => {
|
||||
it("should NOT detect single character strings", () => {
|
||||
const code = `const char = "a"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect empty strings", () => {
|
||||
const code = `const empty = ""`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect short strings (3 chars or less)", () => {
|
||||
const code = `const short = "abc"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("console logs", () => {
|
||||
it("should NOT detect strings in console.log", () => {
|
||||
const code = `console.log("Debug message")`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect strings in console.error", () => {
|
||||
const code = `console.error("Error occurred")`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("test descriptions", () => {
|
||||
it("should NOT detect strings in test()", () => {
|
||||
const code = `test("should work correctly", () => {})`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect strings in describe()", () => {
|
||||
const code = `describe("test suite", () => {})`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("imports", () => {
|
||||
it("should NOT detect strings in import statements", () => {
|
||||
const code = `import { foo } from "some-package"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect strings in require statements", () => {
|
||||
const code = `const foo = require("package-name")`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeLessThanOrEqual(1)
|
||||
})
|
||||
})
|
||||
|
||||
describe("template literals", () => {
|
||||
it("should NOT detect template literals with interpolation", () => {
|
||||
const code = "const url = `http://localhost:${port}`"
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect backtick strings", () => {
|
||||
const code = "`some string`"
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("exported constants", () => {
|
||||
it("should NOT detect strings in single-line export const", () => {
|
||||
const code = `export const API_URL = "http://localhost" as const`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect strings in multi-line export const", () => {
|
||||
const code = `
|
||||
export const CONFIG = {
|
||||
baseUrl: "http://localhost:3000",
|
||||
apiKey: "secret-key",
|
||||
} as const
|
||||
`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("edge cases", () => {
|
||||
it("should detect long meaningful strings", () => {
|
||||
const code = `const message = "Something went wrong"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].value).toBe("Something went wrong")
|
||||
})
|
||||
|
||||
it("should handle multiple strings on same line", () => {
|
||||
const code = `const a = "https://api.example.com"; const b = "another-url"`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.value.includes("api.example.com"))).toBe(true)
|
||||
})
|
||||
|
||||
it("should handle different quote types", () => {
|
||||
const code = `
|
||||
const single = 'http://localhost'
|
||||
const double = "http://localhost"
|
||||
`
|
||||
const result = detector.detectMagicStrings(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("detectAll", () => {
|
||||
it("should detect both magic numbers and strings", () => {
|
||||
const code = `
|
||||
const timeout = 5000
|
||||
const url = "http://localhost:8080"
|
||||
`
|
||||
const result = detector.detectAll(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.isMagicNumber())).toBe(true)
|
||||
expect(result.some((r) => r.isMagicString())).toBe(true)
|
||||
})
|
||||
|
||||
it("should return empty array for clean code", () => {
|
||||
const code = `
|
||||
const index = 0
|
||||
const increment = 1
|
||||
console.log("debug")
|
||||
`
|
||||
const result = detector.detectAll(code, "test.ts")
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("context and line numbers", () => {
|
||||
it("should provide correct line numbers", () => {
|
||||
const code = `const a = 1
|
||||
const timeout = 5000
|
||||
const b = 2`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result.some((r) => r.line === 2)).toBe(true)
|
||||
})
|
||||
|
||||
it("should provide context string", () => {
|
||||
const code = `const timeout = 5000`
|
||||
const result = detector.detectMagicNumbers(code, "test.ts")
|
||||
|
||||
expect(result.length).toBeGreaterThan(0)
|
||||
expect(result[0].context).toContain("timeout")
|
||||
expect(result[0].context).toContain("5000")
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,734 @@
|
||||
import { describe, it, expect, beforeEach } from "vitest"
|
||||
import { NamingConventionDetector } from "../../../src/infrastructure/analyzers/NamingConventionDetector"
|
||||
import { LAYERS, NAMING_VIOLATION_TYPES } from "../../../src/shared/constants"
|
||||
|
||||
describe("NamingConventionDetector", () => {
|
||||
let detector: NamingConventionDetector
|
||||
|
||||
beforeEach(() => {
|
||||
detector = new NamingConventionDetector()
|
||||
})
|
||||
|
||||
describe("Excluded Files", () => {
|
||||
it("should NOT detect violations for index.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"index.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/index.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for BaseUseCase.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"BaseUseCase.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/use-cases/BaseUseCase.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for BaseMapper.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"BaseMapper.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/mappers/BaseMapper.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for IBaseRepository.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"IBaseRepository.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/repositories/IBaseRepository.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for BaseEntity.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"BaseEntity.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/BaseEntity.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for ValueObject.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"ValueObject.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/value-objects/ValueObject.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for BaseRepository.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"BaseRepository.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/repositories/BaseRepository.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for BaseError.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"BaseError.ts",
|
||||
LAYERS.SHARED,
|
||||
"src/shared/errors/BaseError.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for Suggestions.ts", () => {
|
||||
const result = detector.detectViolations(
|
||||
"Suggestions.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/constants/Suggestions.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Domain Layer", () => {
|
||||
describe("Entities (PascalCase nouns)", () => {
|
||||
it("should NOT detect violations for valid entity names", () => {
|
||||
const validNames = [
|
||||
"User.ts",
|
||||
"Order.ts",
|
||||
"Product.ts",
|
||||
"Email.ts",
|
||||
"ProjectPath.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.DOMAIN,
|
||||
`src/domain/entities/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase entity names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"user.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/user.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_CASE)
|
||||
expect(result[0].layer).toBe(LAYERS.DOMAIN)
|
||||
})
|
||||
|
||||
it("should detect violations for camelCase entity names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userProfile.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/userProfile.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_CASE)
|
||||
})
|
||||
|
||||
it("should detect violations for kebab-case entity names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"user-profile.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/user-profile.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_CASE)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Services (*Service.ts)", () => {
|
||||
it("should NOT detect violations for valid service names", () => {
|
||||
const validNames = ["UserService.ts", "EmailService.ts", "PaymentService.ts"]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.DOMAIN,
|
||||
`src/domain/services/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase service names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userService.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/services/userService.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_CASE)
|
||||
})
|
||||
|
||||
it("should detect violations for service names without suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/services/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Repository Interfaces (I*Repository.ts)", () => {
|
||||
it("should NOT detect violations for valid repository interface names", () => {
|
||||
const validNames = [
|
||||
"IUserRepository.ts",
|
||||
"IOrderRepository.ts",
|
||||
"IProductRepository.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.DOMAIN,
|
||||
`src/domain/repositories/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for repository interfaces without I prefix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"UserRepository.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/repositories/UserRepository.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase I prefix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"iUserRepository.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/repositories/iUserRepository.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_CASE)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Forbidden Patterns", () => {
|
||||
it("should detect Dto in domain layer", () => {
|
||||
const result = detector.detectViolations(
|
||||
"UserDto.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/UserDto.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.FORBIDDEN_PATTERN)
|
||||
expect(result[0].getMessage()).toContain("should not contain DTOs")
|
||||
})
|
||||
|
||||
it("should detect Request in domain layer", () => {
|
||||
const result = detector.detectViolations(
|
||||
"CreateUserRequest.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/CreateUserRequest.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.FORBIDDEN_PATTERN)
|
||||
})
|
||||
|
||||
it("should detect Response in domain layer", () => {
|
||||
const result = detector.detectViolations(
|
||||
"UserResponse.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/UserResponse.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.FORBIDDEN_PATTERN)
|
||||
})
|
||||
|
||||
it("should detect Controller in domain layer", () => {
|
||||
const result = detector.detectViolations(
|
||||
"UserController.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/UserController.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.FORBIDDEN_PATTERN)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Value Objects", () => {
|
||||
it("should NOT detect violations for valid value object names", () => {
|
||||
const validNames = ["Email.ts", "Money.ts", "Address.ts", "PhoneNumber.ts"]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.DOMAIN,
|
||||
`src/domain/value-objects/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("Application Layer", () => {
|
||||
describe("Use Cases (Verb+Noun)", () => {
|
||||
it("should NOT detect violations for valid use case names", () => {
|
||||
const validNames = [
|
||||
"CreateUser.ts",
|
||||
"UpdateProfile.ts",
|
||||
"DeleteOrder.ts",
|
||||
"GetUser.ts",
|
||||
"FindProducts.ts",
|
||||
"AnalyzeProject.ts",
|
||||
"ValidateEmail.ts",
|
||||
"GenerateReport.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.APPLICATION,
|
||||
`src/application/use-cases/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for use cases starting with lowercase", () => {
|
||||
const result = detector.detectViolations(
|
||||
"createUser.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/use-cases/createUser.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_VERB_NOUN)
|
||||
})
|
||||
|
||||
it("should detect violations for use cases without verb", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/use-cases/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_VERB_NOUN)
|
||||
expect(result[0].getMessage()).toContain("should start with a verb")
|
||||
})
|
||||
|
||||
it("should detect violations for kebab-case use cases", () => {
|
||||
const result = detector.detectViolations(
|
||||
"create-user.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/use-cases/create-user.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_VERB_NOUN)
|
||||
})
|
||||
|
||||
it("should recognize all standard verbs", () => {
|
||||
const verbs = [
|
||||
"Analyze",
|
||||
"Create",
|
||||
"Update",
|
||||
"Delete",
|
||||
"Get",
|
||||
"Find",
|
||||
"List",
|
||||
"Search",
|
||||
"Validate",
|
||||
"Calculate",
|
||||
"Generate",
|
||||
"Send",
|
||||
"Fetch",
|
||||
"Process",
|
||||
"Execute",
|
||||
"Handle",
|
||||
"Register",
|
||||
"Authenticate",
|
||||
"Authorize",
|
||||
"Import",
|
||||
"Export",
|
||||
]
|
||||
|
||||
verbs.forEach((verb) => {
|
||||
const fileName = `${verb}Something.ts`
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.APPLICATION,
|
||||
`src/application/use-cases/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("DTOs (*Dto, *Request, *Response)", () => {
|
||||
it("should NOT detect violations for valid DTO names", () => {
|
||||
const validNames = [
|
||||
"UserDto.ts",
|
||||
"CreateUserRequest.ts",
|
||||
"UserResponseDto.ts",
|
||||
"UpdateProfileRequest.ts",
|
||||
"OrderResponse.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.APPLICATION,
|
||||
`src/application/dtos/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase DTO names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userDto.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/dtos/userDto.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_SUFFIX)
|
||||
})
|
||||
|
||||
it("should detect violations for DTOs without proper suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/dtos/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should NOT detect violations for camelCase before suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"CreateUserRequestDto.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/dtos/CreateUserRequestDto.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Mappers (*Mapper)", () => {
|
||||
it("should NOT detect violations for valid mapper names", () => {
|
||||
const validNames = ["UserMapper.ts", "OrderMapper.ts", "ProductMapper.ts"]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.APPLICATION,
|
||||
`src/application/mappers/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase mapper names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userMapper.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/mappers/userMapper.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_SUFFIX)
|
||||
})
|
||||
|
||||
it("should detect violations for mappers without suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/mappers/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("Infrastructure Layer", () => {
|
||||
describe("Controllers (*Controller)", () => {
|
||||
it("should NOT detect violations for valid controller names", () => {
|
||||
const validNames = [
|
||||
"UserController.ts",
|
||||
"OrderController.ts",
|
||||
"ProductController.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
`src/infrastructure/controllers/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase controller names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userController.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/controllers/userController.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_SUFFIX)
|
||||
})
|
||||
|
||||
it("should detect violations for controllers without suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/controllers/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Repository Implementations (*Repository)", () => {
|
||||
it("should NOT detect violations for valid repository implementation names", () => {
|
||||
const validNames = [
|
||||
"UserRepository.ts",
|
||||
"PrismaUserRepository.ts",
|
||||
"MongoUserRepository.ts",
|
||||
"InMemoryUserRepository.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
`src/infrastructure/repositories/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should NOT detect violations for I*Repository (interface) in infrastructure", () => {
|
||||
const result = detector.detectViolations(
|
||||
"IUserRepository.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/repositories/IUserRepository.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase repository names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userRepository.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/repositories/userRepository.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_SUFFIX)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Services (*Service, *Adapter)", () => {
|
||||
it("should NOT detect violations for valid service names", () => {
|
||||
const validNames = [
|
||||
"EmailService.ts",
|
||||
"S3StorageAdapter.ts",
|
||||
"PaymentService.ts",
|
||||
"LoggerAdapter.ts",
|
||||
]
|
||||
|
||||
validNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
`src/infrastructure/services/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
it("should detect violations for lowercase service names", () => {
|
||||
const result = detector.detectViolations(
|
||||
"emailService.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/services/emailService.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_SUFFIX)
|
||||
})
|
||||
|
||||
it("should detect violations for services without suffix", () => {
|
||||
const result = detector.detectViolations(
|
||||
"Email.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/services/Email.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("Shared Layer", () => {
|
||||
it("should NOT detect violations for any file in shared layer", () => {
|
||||
const fileNames = [
|
||||
"helpers.ts",
|
||||
"utils.ts",
|
||||
"constants.ts",
|
||||
"types.ts",
|
||||
"Guards.ts",
|
||||
"Result.ts",
|
||||
"anything.ts",
|
||||
]
|
||||
|
||||
fileNames.forEach((fileName) => {
|
||||
const result = detector.detectViolations(
|
||||
fileName,
|
||||
LAYERS.SHARED,
|
||||
`src/shared/${fileName}`,
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe("Edge Cases", () => {
|
||||
it("should return empty array when no layer is provided", () => {
|
||||
const result = detector.detectViolations("SomeFile.ts", undefined, "src/SomeFile.ts")
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should return empty array for unknown layer", () => {
|
||||
const result = detector.detectViolations(
|
||||
"SomeFile.ts",
|
||||
"unknown-layer",
|
||||
"src/unknown/SomeFile.ts",
|
||||
)
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should handle files with numbers in name", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User2Factor.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/User2Factor.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should provide helpful suggestions", () => {
|
||||
const result = detector.detectViolations(
|
||||
"userDto.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/dtos/userDto.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].suggestion).toBeDefined()
|
||||
expect(result[0].suggestion).toContain("*Dto")
|
||||
})
|
||||
|
||||
it("should include file path in violation", () => {
|
||||
const filePath = "src/domain/UserDto.ts"
|
||||
const result = detector.detectViolations("UserDto.ts", LAYERS.DOMAIN, filePath)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].filePath).toBe(filePath)
|
||||
})
|
||||
})
|
||||
|
||||
describe("Complex Scenarios", () => {
|
||||
it("should handle application layer file that looks like entity", () => {
|
||||
const result = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.APPLICATION,
|
||||
"src/application/use-cases/User.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
expect(result[0].violationType).toBe(NAMING_VIOLATION_TYPES.WRONG_VERB_NOUN)
|
||||
})
|
||||
|
||||
it("should handle domain layer service vs entity distinction", () => {
|
||||
const entityResult = detector.detectViolations(
|
||||
"User.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/entities/User.ts",
|
||||
)
|
||||
expect(entityResult).toHaveLength(0)
|
||||
|
||||
const serviceResult = detector.detectViolations(
|
||||
"UserService.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/services/UserService.ts",
|
||||
)
|
||||
expect(serviceResult).toHaveLength(0)
|
||||
})
|
||||
|
||||
it("should distinguish between domain and infrastructure repositories", () => {
|
||||
const interfaceResult = detector.detectViolations(
|
||||
"IUserRepository.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/repositories/IUserRepository.ts",
|
||||
)
|
||||
expect(interfaceResult).toHaveLength(0)
|
||||
|
||||
const implResult = detector.detectViolations(
|
||||
"UserRepository.ts",
|
||||
LAYERS.INFRASTRUCTURE,
|
||||
"src/infrastructure/repositories/UserRepository.ts",
|
||||
)
|
||||
expect(implResult).toHaveLength(0)
|
||||
|
||||
const wrongResult = detector.detectViolations(
|
||||
"UserRepository.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/repositories/UserRepository.ts",
|
||||
)
|
||||
expect(wrongResult).toHaveLength(0)
|
||||
})
|
||||
})
|
||||
|
||||
describe("getMessage()", () => {
|
||||
it("should return descriptive error messages", () => {
|
||||
const result = detector.detectViolations(
|
||||
"UserDto.ts",
|
||||
LAYERS.DOMAIN,
|
||||
"src/domain/UserDto.ts",
|
||||
)
|
||||
|
||||
expect(result).toHaveLength(1)
|
||||
const message = result[0].getMessage()
|
||||
expect(message).toBeTruthy()
|
||||
expect(typeof message).toBe("string")
|
||||
expect(message.length).toBeGreaterThan(0)
|
||||
})
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user