()
const CACHE_TTL = 5 * 60 * 1000
/**
- * Get or load the archgate configuration for a file
+ * Get or load the layerguard configuration for a file
*
* @param filePath - The file being linted
* @returns The cached configuration or null if not found/invalid
@@ -85,7 +85,7 @@ export function getConfig(filePath: string): CachedConfig | null {
/**
* Find the project root for a file
*
- * Looks for package.json or archgate config file
+ * Looks for package.json or layerguard config file
*/
function findProjectRoot(filePath: string): string | null {
let dir = dirname(filePath)
@@ -105,7 +105,7 @@ function findProjectRoot(filePath: string): string | null {
while (!isRoot(dir)) {
// console.log('Checking directory:', dir)
- // Check for archgate config
+ // Check for layerguard config
try {
const result = loadConfigSync(dir)
// console.log('loadConfigSync result for', dir, ':', result)
@@ -113,8 +113,7 @@ function findProjectRoot(filePath: string): string | null {
// console.log('Found config at:', dir)
return dir
}
- } catch (error) {
- // console.log('loadConfigSync error for', dir, ':', error)
+ } catch {
// No config in this directory
}
diff --git a/src/eslint/index.ts b/src/eslint/index.ts
index 9c95998..69968c5 100644
--- a/src/eslint/index.ts
+++ b/src/eslint/index.ts
@@ -1,22 +1,22 @@
/**
- * Archgate ESLint Plugin
+ * Layerguard ESLint Plugin
*
* Provides ESLint rules for enforcing architectural boundaries defined
- * in archgate configuration.
+ * in layerguard configuration.
*
* Usage in eslint.config.js:
*
* ```js
- * import archgate from 'archgate/eslint'
+ * import layerguard from 'layerguard/eslint'
*
* export default [
* {
* plugins: {
- * archgate,
+ * layerguard,
* },
* rules: {
- * 'archgate/layer-boundaries': 'error',
- * 'archgate/unlayered-imports': 'warn',
+ * 'layerguard/layer-boundaries': 'error',
+ * 'layerguard/unlayered-imports': 'warn',
* },
* },
* ]
@@ -28,11 +28,11 @@ import layerBoundaries from './rules/layer-boundaries.js'
import unlayeredImports from './rules/unlayered-imports.js'
/**
- * Archgate ESLint plugin
+ * Layerguard ESLint plugin
*/
const plugin: ESLint.Plugin = {
meta: {
- name: 'archgate',
+ name: 'layerguard',
version: '0.1.0',
},
@@ -49,15 +49,15 @@ const plugin: ESLint.Plugin = {
*
* Usage:
* ```js
- * import archgate from 'archgate/eslint'
- * export default [archgate.configs.recommended]
+ * import layerguard from 'layerguard/eslint'
+ * export default [layerguard.configs.recommended]
* ```
*/
get recommended(): Linter.Config {
return {
- plugins: { archgate: plugin },
+ plugins: { layerguard: plugin },
rules: {
- 'archgate/layer-boundaries': 'error',
+ 'layerguard/layer-boundaries': 'error',
},
}
},
@@ -69,16 +69,16 @@ const plugin: ESLint.Plugin = {
*
* Usage:
* ```js
- * import archgate from 'archgate/eslint'
- * export default [archgate.configs.strict]
+ * import layerguard from 'layerguard/eslint'
+ * export default [layerguard.configs.strict]
* ```
*/
get strict(): Linter.Config {
return {
- plugins: { archgate: plugin },
+ plugins: { layerguard: plugin },
rules: {
- 'archgate/layer-boundaries': 'error',
- 'archgate/unlayered-imports': 'error',
+ 'layerguard/layer-boundaries': 'error',
+ 'layerguard/unlayered-imports': 'error',
},
}
},
@@ -90,4 +90,4 @@ export default plugin
// Named exports for convenience
export { layerBoundaries, unlayeredImports }
export { clearConfigCache, getCacheStats } from './config-cache.js'
-export type { CachedConfig, ArchgateRuleOptions } from './types.js'
+export type { CachedConfig, LayerguardRuleOptions } from './types.js'
diff --git a/src/eslint/rules/layer-boundaries.ts b/src/eslint/rules/layer-boundaries.ts
index 120ba8d..2e5b60d 100644
--- a/src/eslint/rules/layer-boundaries.ts
+++ b/src/eslint/rules/layer-boundaries.ts
@@ -1,7 +1,7 @@
/**
- * ESLint rule: archgate/layer-boundaries
+ * ESLint rule: layerguard/layer-boundaries
*
- * Flags imports that violate flow rules defined in archgate config.
+ * Flags imports that violate flow rules defined in layerguard config.
*/
import type { Rule } from 'eslint'
@@ -18,13 +18,13 @@ const rule: Rule.RuleModule = {
meta: {
type: 'problem',
docs: {
- description: 'Enforce architectural layer boundaries defined in archgate config',
+ description: 'Enforce architectural layer boundaries defined in layerguard config',
recommended: true,
},
messages: {
violation:
'Import from "{{importPath}}" violates layer boundaries: {{fromLayer}} cannot import from {{toLayer}}',
- noConfig: 'No archgate configuration found',
+ noConfig: 'No layerguard configuration found',
},
schema: [
{
@@ -32,7 +32,7 @@ const rule: Rule.RuleModule = {
properties: {
configPath: {
type: 'string',
- description: 'Path to archgate config file',
+ description: 'Path to layerguard config file',
},
},
additionalProperties: false,
diff --git a/src/eslint/rules/unlayered-imports.ts b/src/eslint/rules/unlayered-imports.ts
index 0bef8cd..30dc7fc 100644
--- a/src/eslint/rules/unlayered-imports.ts
+++ b/src/eslint/rules/unlayered-imports.ts
@@ -1,8 +1,8 @@
/**
- * ESLint rule: archgate/unlayered-imports
+ * ESLint rule: layerguard/unlayered-imports
*
* Flags imports from layered files to unlayered files when the
- * unlayeredImports rule is set to 'error' or 'warn' in archgate config.
+ * unlayeredImports rule is set to 'error' or 'warn' in layerguard config.
*/
import type { Rule } from 'eslint'
@@ -31,7 +31,7 @@ const rule: Rule.RuleModule = {
properties: {
configPath: {
type: 'string',
- description: 'Path to archgate config file',
+ description: 'Path to layerguard config file',
},
},
additionalProperties: false,
diff --git a/src/eslint/types.ts b/src/eslint/types.ts
index 29db933..518065d 100644
--- a/src/eslint/types.ts
+++ b/src/eslint/types.ts
@@ -3,16 +3,16 @@
*/
import type { Rule } from 'eslint'
-import type { ArchgateConfig } from '../config/types.js'
+import type { LayerguardConfig } from '../config/types.js'
/**
- * Cached archgate configuration for ESLint
+ * Cached layerguard configuration for ESLint
*/
export interface CachedConfig {
/**
- * The loaded archgate configuration
+ * The loaded layerguard configuration
*/
- config: ArchgateConfig
+ config: LayerguardConfig
/**
* Path to the config file
@@ -31,21 +31,21 @@ export interface CachedConfig {
}
/**
- * ESLint rule context with archgate extensions
+ * ESLint rule context with layerguard extensions
*/
-export interface ArchgateRuleContext extends Rule.RuleContext {
+export interface LayerguardRuleContext extends Rule.RuleContext {
/**
- * Get the archgate configuration
+ * Get the layerguard configuration
*/
- getArchgateConfig?: () => CachedConfig | null
+ getLayerguardConfig?: () => CachedConfig | null
}
/**
- * Rule options for archgate ESLint rules
+ * Rule options for layerguard ESLint rules
*/
-export interface ArchgateRuleOptions {
+export interface LayerguardRuleOptions {
/**
- * Path to archgate config file (optional, auto-detected if not specified)
+ * Path to layerguard config file (optional, auto-detected if not specified)
*/
configPath?: string
}
diff --git a/src/index.ts b/src/index.ts
index dd187a3..2901967 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,5 +1,5 @@
/**
- * Archgate - Framework-agnostic architectural layer enforcement
+ * Layerguard - Framework-agnostic architectural layer enforcement
*
* Public API for programmatic use
*/
@@ -7,7 +7,7 @@
// Config types and helpers
export {
defineConfig,
- type ArchgateConfig,
+ type LayerguardConfig,
type LayerConfig,
type SublayerConfig,
type RulesConfig,
diff --git a/src/output/diagram.ts b/src/output/diagram.ts
index 990ae53..25fceb9 100644
--- a/src/output/diagram.ts
+++ b/src/output/diagram.ts
@@ -4,7 +4,7 @@
* Creates text-based diagrams of the architecture
*/
-import type { ArchgateConfig } from '../config/types.js'
+import type { LayerguardConfig } from '../config/types.js'
import { parseFlowRules } from '../config/parser.js'
/**
@@ -63,13 +63,13 @@ const boxChars = {
/**
* Generate an architecture diagram from config
*/
-export function generateDiagram(config: ArchgateConfig, options: DiagramOptions = {}): string {
+export function generateDiagram(config: LayerguardConfig, options: DiagramOptions = {}): string {
const { unicode = true, showSublayers = true, showFlow = true } = options
const chars = unicode ? boxChars.unicode : boxChars.ascii
const lines: string[] = []
// Title
- lines.push('Archgate Architecture')
+ lines.push('Layerguard Architecture')
lines.push('')
// Parse flow rules to understand relationships
@@ -109,7 +109,7 @@ export function generateDiagram(config: ArchgateConfig, options: DiagramOptions
* Build a simple layer order based on flow rules
*/
function buildLayerOrder(
- config: ArchgateConfig,
+ config: LayerguardConfig,
parsedRules: Array<{ from: string; to: string; direction: string }>
): string[] {
const layers = Object.keys(config.layers)
@@ -204,7 +204,7 @@ function padRight(str: string, width: number): string {
/**
* Generate a simple flow summary
*/
-export function generateFlowSummary(config: ArchgateConfig): string {
+export function generateFlowSummary(config: LayerguardConfig): string {
const lines: string[] = []
lines.push('Layer dependencies:')
diff --git a/src/output/github.ts b/src/output/github.ts
index d854b40..53c1d8d 100644
--- a/src/output/github.ts
+++ b/src/output/github.ts
@@ -110,7 +110,7 @@ export function generatePrCommentBody(report: ViolationReport, options: {
const { showDetails = true, commitSha, workflowName } = options
const status = report.passed ? '✅ Passed' : '❌ Failed'
- let md = `## Archgate Architecture Check ${status}\n\n`
+ let md = `## Layerguard Architecture Check ${status}\n\n`
// Summary table
md += `| Metric | Count |\n`
@@ -165,19 +165,19 @@ export function generatePrCommentBody(report: ViolationReport, options: {
if (workflowName) {
md += `Workflow: ${workflowName}\n`
}
- md += `\n*Generated by [Archgate](https://github.com/caprado/archgate)*`
+ md += `\n*Generated by [Layerguard](https://github.com/caprado/layerguard)*`
return md
}
/**
- * Find existing Archgate comment on a PR
+ * Find existing Layerguard comment on a PR
*/
function findExistingComment(prNumber: number, repo?: string): string | undefined {
try {
const repoArg = repo ? `--repo ${repo}` : ''
const result = execSync(
- `gh pr view ${prNumber} ${repoArg} --json comments --jq '.comments[] | select(.body | contains("Archgate Architecture Check")) | .id' | head -1`,
+ `gh pr view ${prNumber} ${repoArg} --json comments --jq '.comments[] | select(.body | contains("Layerguard Architecture Check")) | .id' | head -1`,
{ encoding: 'utf-8', stdio: ['pipe', 'pipe', 'ignore'] }
)
const commentId = result.trim()
diff --git a/src/output/html.ts b/src/output/html.ts
index 5a90fd1..a0324bd 100644
--- a/src/output/html.ts
+++ b/src/output/html.ts
@@ -6,7 +6,7 @@
*/
import type { ViolationReport, Violation } from '../enforcer/violations.js'
-import type { ArchgateConfig } from '../config/types.js'
+import type { LayerguardConfig } from '../config/types.js'
/**
* Historical data point for trend analysis
@@ -68,9 +68,9 @@ export interface HtmlReportOptions {
history?: HistoricalDataPoint[]
/**
- * Archgate configuration (for layer info)
+ * Layerguard configuration (for layer info)
*/
- config?: ArchgateConfig
+ config?: LayerguardConfig
/**
* File and import counts
@@ -86,7 +86,7 @@ export interface HtmlReportOptions {
*/
export function generateHtmlReport(report: ViolationReport, options: HtmlReportOptions = {}): string {
const {
- title = 'Archgate Report',
+ title = 'Layerguard Report',
projectName = 'Project',
history = [],
stats,
@@ -527,7 +527,7 @@ export function generateHtmlReport(report: ViolationReport, options: HtmlReportO
` : ''}
- 
- 
- 
+ 
+ 
+ 
+ 