nodes.schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "urn:uuid:feee8b93-7192-4034-b404-a7fd1b9b5a12",
	"title": "Schema for declaring CircuiTikZ node- and path-style components",
	"type": "object",
	"definitions": {
		"symbolBase": {
			"type": "object",
			"properties": {
				"displayName": {
					"title": "The name to show in the UI",
					"type": "string",
					"minLength": 1
				},
				"groupName": {
					"title": "The name of the group, e.g. Transistors",
					"type": "string",
					"minLength": 1
				},
				"options": {
					"title": "A list of options to set in CircuiTikZ",
					"type": "array",
					"items": {
						"oneOf": [
							{ "type": "string", "minLength": 1 },
							{ "type": "array", "minLength": 2, "maxLength": 2, "items": { "type": "string" } }
						]
					},
					"uniqueItems": true
				},
				"pins": {
					"title": "A list of CircuiTikZ pin (anchor) names",
					"type": "array",
					"items": {
						"type": "string",
						"minLength": 1
					},
					"uniqueItems": true
				}
			}
		}
	},
	"properties": {
		"nodes": {
			"title": "Definitions of node-style components",
			"type": "array",
			"items": {
				"type": "object",
				"allOf": [{ "$ref": "#/definitions/symbolBase" }],
				"properties": {
					"name": {
						"title": "The CircuiTikZ node name, e.g. nigfete for a n channel MOSFET",
						"type": "string",
						"minLength": 1
					}
				},
				"required": ["name"]
			}
		},

		"path": {
			"title": "Definitions of path-style components",
			"type": "array",
			"items": {
				"type": "object",
				"allOf": [{ "$ref": "#/definitions/symbolBase" }],
				"properties": {
					"drawName": {
						"title": "The unique (!) CircuiTikZ name used in to[...], e.g. american resistor (not R) for an resistor",
						"type": "string",
						"minLength": 1
					},
					"aliases": {
						"title": "Additional names which can be used in to[...]",
						"type": "array",
						"items": {
							"type": "string",
							"minLength": 1
						}
					},
					"shapeName": {
						"title": "The shape name used internally by CircuiTikZ; can be used to create a node",
						"type": "string",
						"minLength": 1
					},
					"stroke": {
						"title": "Draw a line through the component",
						"type": "boolean",
						"default": false
					}
				},
				"required": ["drawName"]
			}
		}
	},

	"required": ["nodes", "path"]
}