brix 0.4.2

Brix is a CLI tool written in Rust for scaffolding and code generation.
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

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "JSON Schema for Brix, a CLI tool for scaffolding your codebase",
  "description": "Brix is a CLI tool written in Rust for scaffolding and code generation.",
  "additionalProperties": false,
  "required": ["commands"],
  "properties": {
    "context": {
      "type": "object",
      "description": "Additional context information to be used within the file"
    },
    "commands": {
      "type": "array",
      "description": "The list of commands that will be executed in order by Brix",
      "items": {
        "type": "object",
        "properties": {
          "copy": {
            "$ref": "#/$defs/copy"
          },
          "exec": {
            "$ref": "#/$defs/exec"
          },
          "mkdir": {
            "$ref": "#/$defs/mkdir"
          },
          "search_replace": {
            "$ref": "#/$defs/search_replace"
          },
          "template": {
            "$ref": "#/$defs/template"
          }
        }
      }
    }
  },
  "$defs": {
    "copy": {
      "description": "The copy command copies a file from the source file to the destination file",
      "type": "object",
      "required": ["source", "destination"],
      "properties": {
        "source": {
          "type": "string",
          "description": "The path to the source file to copy"
        },
        "destination": {
          "type": "string",
          "description": "The path to the destination file to copy to"
        },
        "overwrite": {
          "type": "boolean",
          "description": "Whether or not to overwrite the destination file if it already exists"
        }
      }
    },
    "exec": {
      "description": "The exec command executes commands in a shell",
      "type": "object",
      "required": ["commands"],
      "properties": {
        "commands": {
          "type": "array",
          "description": "The list of commands to execute in order",
          "items": {
            "type": "string"
          }
        },
        "stdout": {
          "type": "boolean",
          "description": "Whether or not to print the stdout of the command"
        }
      }
    },
    "mkdir": {
      "description": "The mkdir command recursively creates a directory",
      "type": "object",
      "required": ["destination"],
      "properties": {
        "destination": {
          "type": "string",
          "description": "The path of the directory to create"
        }
      }
    },
    "search_replace": {
      "description": "The search_replace command uses searches for an expression within a file and replaces it with new content",
      "type": "object",
      "required": ["destination", "search", "replace"],
      "properties": {
        "destination": {
          "type": "string",
          "description": "The path of the file to search and replace"
        },
        "search": {
          "type": "string",
          "description": "The expression to search for (supports Perl-like regular expressions with https://crates.io/crates/fancy_regex/)"
        },
        "replace": {
          "type": "string",
          "description": "The expression to replace the search with"
        }
      }
    },
    "template": {
      "description": "The template command uses a template to generate a file",
      "type": "object",
      "required": ["source", "destination"],
      "properties": {
        "source": {
          "type": "string",
          "description": "The path to the template file"
        },
        "destination": {
          "type": "string",
          "description": "The destination file to output"
        },
        "overwrite": {
          "type": "boolean",
          "description": "Whether or not to overwrite the destination file if it already exists"
        },
        "context": {
          "type": "object",
          "description": "The context to use when rendering the template"
        }
      }
    }
  }
}