ts-databuilders/schema.json at main · nemmtor/ts-databuilders · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": [],
  "properties": {
    "$schema": {
      "type": "string"
    },
    "tsconfig": {
      "type": "string",
      "description": "Path to tsconfig file. Useful in repos with multiple tsconfig files."
    },
    "builderJsDocTagName": {
      "type": "string",
      "description": "JSDoc tag used to mark types for data building generation."
    },
    "inlineDefaultJsDocTagName": {
      "type": "string",
      "description": "JSDoc tag used to set default value of given field."
    },
    "withNestedBuilders": {
      "type": "boolean",
      "description": "When set to true ts-databuilders will use nested builders approach."
    },
    "outputDir": {
      "type": "string",
      "description": "Output directory for generated builders."
    },
    "include": {
      "type": "string",
      "description": "Glob pattern for files included while searching for jsdoc tag."
    },
    "fileSuffix": {
      "type": "string",
      "description": "File suffix for created builder files."
    },
    "fileCase": {
      "type": "string",
      "enum": [
        "kebab",
        "camel",
        "pascal"
      ],
      "description": "Naming convention for generated builder file"
    },
    "builderSuffix": {
      "type": "string",
      "description": "Suffix for generated classes."
    },
    "defaults": {
      "type": "object",
      "required": [],
      "properties": {
        "string": {
          "type": "string",
          "description": "Default string value to be used in data builder constructor."
        },
        "number": {
          "type": "number",
          "description": "Default number value to be used in data builder constructor."
        },
        "boolean": {
          "type": "boolean",
          "description": "Default boolean value to be used in data builder constructor."
        }
      },
      "additionalProperties": false,
      "description": "Default values to be used in data builder constructor."
    }
  },
  "additionalProperties": false
}