easement 0.1.1

Architecture quality gate for polyglot codebases
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

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/mokevnin/easement/main/easement.schema.json",
  "title": "easement.yml",
  "description": "Configuration of the easement architecture quality gate.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "extends": {
      "description": "Config files merged underneath this one, relative to this file. Patterns stay relative to the root of the config being loaded.",
      "oneOf": [
        { "type": "string" },
        { "type": "array", "items": { "type": "string" } }
      ]
    },
    "version": { "const": 1, "description": "Config format version." },
    "components": {
      "description": "Named parts of the system and the paths they cover.",
      "type": "object",
      "minProperties": 1,
      "additionalProperties": { "$ref": "#/definitions/component" }
    },
    "common": {
      "description": "Components every other component may depend on.",
      "type": "array",
      "items": { "type": "string" }
    },
    "rules": {
      "description": "Per component: what it may depend on and use.",
      "type": "object",
      "additionalProperties": { "$ref": "#/definitions/rule" }
    },
    "layers": {
      "description": "Components from the top layer to the bottom one: a layer may depend on any layer below it, never on one above.",
      "type": "array",
      "items": { "type": "string" },
      "uniqueItems": true
    },
    "no_cycles": {
      "description": "Fail on dependency cycles between components: true for all, or a list of components.",
      "oneOf": [
        { "type": "boolean" },
        { "type": "array", "items": { "type": "string" } }
      ]
    },
    "strict": {
      "description": "Fail on checked files that belong to no component.",
      "type": "boolean"
    },
    "exclude": {
      "description": "Globs of paths to skip.",
      "type": "array",
      "items": { "type": "string" }
    },
    "baseline": {
      "description": "Path of the baseline file, default easement.baseline.yml.",
      "type": "string"
    },
    "python": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "roots": {
          "description": "Directories that act as sys.path entries, default [\".\", \"src\"].",
          "type": "array",
          "items": { "type": "string" }
        }
      }
    }
  },
  "definitions": {
    "patterns": {
      "oneOf": [
        { "type": "string" },
        { "type": "array", "items": { "type": "string" }, "minItems": 1 }
      ]
    },
    "component": {
      "type": "object",
      "additionalProperties": false,
      "required": ["in"],
      "properties": {
        "in": {
          "description": "A glob or a list of globs naming a module: a directory or a file.",
          "$ref": "#/definitions/patterns"
        },
        "public": {
          "description": "When set, other components may import only these paths.",
          "$ref": "#/definitions/patterns"
        },
        "because": {
          "description": "Why the public API exists; shown with privacy violations.",
          "type": "string"
        }
      }
    },
    "rule": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "may_depend_on": {
          "description": "Components this one may depend on.",
          "type": "array",
          "items": { "type": "string" }
        },
        "must_not_depend_on": {
          "description": "Components that are never allowed, even if common or layers would allow them.",
          "type": "array",
          "items": { "type": "string" }
        },
        "may_use_external": {
          "description": "External modules this component may use; unset means no restriction. A pattern covers submodules: lodash covers lodash/fp.",
          "type": "array",
          "items": { "type": "string" }
        },
        "forbid_external": {
          "description": "External modules this component must not use.",
          "type": "array",
          "items": { "type": "string" }
        },
        "max_fan_out": {
          "description": "Most components this one may depend on.",
          "type": "integer",
          "minimum": 0
        },
        "max_instability": {
          "description": "Highest instability, out / (in + out), from 0 (stable) to 1.",
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "because": {
          "description": "Why the rule exists; shown with its violations.",
          "type": "string"
        }
      }
    }
  }
}