codeguard/examples/design_rules.yml at main · devr-tools/codeguard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# Standalone Codeguard design policy template.
#
# Put this file at .codeguard/design_rules.yml for automatic discovery, or point
# checks.design_rules_file at it from the main Codeguard config. This document is
# the contents of DesignRulesConfig itself; it is not wrapped in `checks` or
# `design_rules`.
#
# Paths are relative to each target. Adapt these example paths to your repository
# before enabling strict assignment.

# Start false while adopting a policy. Set true after every production module is
# covered by a configured layer and domain.
require_boundary_assignment: false

layers:
  - name: domain
    paths:
      - internal/domain/**
    may_depend_on:
      - contracts
    denied_external:
      - database/sql
      - net/http
      - github.com/aws/**

  - name: contracts
    paths:
      - internal/contracts/**

  - name: application
    paths:
      - internal/application/**
    may_depend_on:
      - domain
      - contracts

  - name: adapters
    paths:
      - internal/adapters/**
    may_depend_on:
      - application
      - domain
      - contracts
    deny_depend_on:
      - delivery

  - name: delivery
    paths:
      - internal/http/**
      - internal/workers/**
    may_depend_on:
      - application
      - contracts

  - name: bootstrap
    paths:
      - cmd/**
      - internal/bootstrap/**
    may_depend_on:
      - application
      - adapters
      - delivery
      - contracts

domains:
  - name: orders
    paths:
      - internal/orders/**
    public_paths:
      - internal/orders/contracts/**
      - internal/orders/events/**
    data_paths:
      - internal/orders/repository/**
      - internal/orders/models/**
    may_depend_on:
      - identity

  - name: identity
    paths:
      - internal/identity/**
    public_paths:
      - internal/identity/contracts/**
    data_paths:
      - internal/identity/repository/**
      - internal/identity/models/**
    # Empty may_depend_on denies cross-domain imports for this domain.

# Only these adapters may import the listed database or network capabilities.
# Import patterns can match local module paths or external package specifiers.
capabilities:
  - name: database
    imports:
      - database/sql
      - github.com/jackc/pgx/**
      - sqlalchemy
      - sqlalchemy/**
      - "@prisma/client"
    allowed_paths:
      - internal/adapters/database/**
      - internal/*/repository/**

  - name: outbound-network
    imports:
      - net/http
      - requests
      - axios
    allowed_paths:
      - internal/adapters/http/**

# Consumers outside each component must import through an approved entrypoint.
public_surfaces:
  - name: orders
    paths:
      - internal/orders/**
    entrypoints:
      - internal/orders/contracts/**
      - internal/orders/events/**

  - name: identity
    paths:
      - internal/identity/**
    entrypoints:
      - internal/identity/contracts/**

production_test:
  enabled: true
  production_paths:
    - cmd/**
    - internal/**
    - src/**
  test_paths:
    - tests/**
    - test/**
    - "**/*_test.go"
    - "**/*.test.ts"
    - "**/*.spec.ts"
    - "**/testdata/**"
    - "**/fixtures/**"
    - "**/mocks/**"

reachability:
  enabled: true
  entrypoints:
    - cmd/**/main.go
    - src/index.ts
    - src/main.py
  ignore_paths:
    - "**/*_test.go"
    - tests/**
    - "**/generated/**"

stability:
  enabled: true
  minimum_fan_in: 3
  max_instability_delta: 0.35
  ignore_paths:
    - "**/generated/**"
    - "**/*_test.go"

# Existing design heuristics and dependency-graph checks can live in this file
# too. Inline checks.design_rules values in the main config override the matching
# top-level fields here, including false, zero, and empty-list values.
detect_import_cycles: true
detect_god_modules: true
god_module_threshold: 24
detect_high_impact_changes: true
high_impact_change_threshold: 20
max_decls_per_file: 12
max_methods_per_type: 8
max_interface_methods: 5
forbidden_package_names:
  - util
  - utils
  - common
  - helpers
  - misc