codescythe/codescythe.schema.json at main · perplexityai/codescythe · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/perplexityai/codescythe/main/codescythe.schema.json",
  "title": "Codescythe configuration",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "description": "Optional JSON Schema URI used by editors.",
      "type": "string"
    },
    "entry": {
      "description": "Entry files or glob patterns. Exports in entry files are ignored unless includeEntryExports is true.",
      "$ref": "#/$defs/stringOrStringArray"
    },
    "project": {
      "description": "Project source files or glob patterns to analyze for unused files and exports.",
      "$ref": "#/$defs/stringOrStringArray"
    },
    "testFilePatterns": {
      "description": "Test files or glob patterns. Matching files are treated as leaf files: their imports do not count as production usage except for exports annotated with leading JSDoc @internal, and fixes remove tests that reference removed project files or exports.",
      "$ref": "#/$defs/stringOrStringArray",
      "default": ["**/*.test.*"]
    },
    "ignore": {
      "description": "Glob patterns to exclude from analysis.",
      "$ref": "#/$defs/stringOrStringArray"
    },
    "aliases": {
      "description": "Import specifier aliases. These override package.json imports and may use wildcard keys such as #generated/*.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/stringOrStringArray"
      }
    },
    "unresolvedImports": {
      "description": "Controls how unresolved imports are handled.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "type": "string",
          "enum": ["report", "ignore", "error"],
          "default": "report"
        },
        "ignore": {
          "description": "Unresolved import specifier glob patterns to ignore.",
          "$ref": "#/$defs/stringOrStringArray"
        }
      },
      "default": {
        "mode": "report"
      }
    },
    "includeEntryExports": {
      "type": "boolean",
      "default": false
    },
    "ignoreExportsUsedInFile": {
      "description": "Do not report exported symbols that are referenced in their declaring file.",
      "type": "boolean",
      "default": false
    }
  },
  "$defs": {
    "stringOrStringArray": {
      "oneOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        }
      ]
    }
  }
}