repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
elyra-ai/canvas | 2c28a173d86c7984a6fc8b6fe71d4805a048dd80 | 2018-10-24T22:35:46 | canvas_modules/common-canvas/src/object-model/schemas/v1/pipeline-flow-v1-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_overview_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/node_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"output": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding",
"type": "string"
},
"input": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"pipeline_id_ref": {
"description": "id of the pipeline this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime": {
"description": "Runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime",
"nodes"
],
"type": "object"
},
"port_binding_def": {
"additionalProperties": false,
"description": "Definition (input/output) of a binding port on a node (bound or unbound). If no binding is present the port is bound at runtime via a configuration object or wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"link": {
"$ref": "#/definitions/link_def"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://www.ibm.com/ibm/wml/datarecord-metadata/v1.0/datarecord-metadata-v1-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"1.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 0d81427d889e91a6eba8dad5f8dae0856d640734 | 2020-10-05T10:48:01 | canvas_modules/common-canvas/src/object-model/schemas/v1/pipeline-flow-v1-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/pipeline_overview_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/node_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"output": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding",
"type": "string"
},
"input": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"pipeline_id_ref": {
"description": "id of the pipeline this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime": {
"description": "Runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime",
"nodes"
],
"type": "object"
},
"port_binding_def": {
"additionalProperties": false,
"description": "Definition (input/output) of a binding port on a node (bound or unbound). If no binding is present the port is bound at runtime via a configuration object or wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"link": {
"$ref": "#/definitions/link_def"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v1-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v1-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v1-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"1.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 9c0f2704cf55bd09ff95ec3b9b02e20df4c842db | 2018-03-20T05:00:49 | canvas_modules/common-canvas/src/object-model/schemas/v1/pipeline-flow-v1-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/node_info_def"
}
]
}
},
"type": "object"
},
"binding_in_node_def": {
"additionalProperties": false,
"description": "Defines an entry or exit point (source or sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"input": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_out_node_def": {
"additionalProperties": false,
"description": "Defines an entry or exit point (source or sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding",
"type": "string"
},
"output": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"pipeline_id_ref": {
"description": "id of the pipeline this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_in_node_def"
},
{
"$ref": "#/definitions/binding_out_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime": {
"description": "Runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime",
"nodes"
],
"type": "object"
},
"port_binding_def": {
"additionalProperties": false,
"description": "Definition (input/output) of a binding port on a node (bound or unbound). If no binding is present the port is bound at runtime via a configuration object or wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"link": {
"$ref": "#/definitions/link_def"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://www.ibm.com/ibm/wml/datarecord-metadata/v1.0/datarecord-metadata-v1-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"1.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 3783dff56935ee40b02811264268a080bd920df7 | 2018-08-07T18:28:28 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"link_name": {
"description": "optional link name (used in parameter sets when there are multiple input sources)",
"type": "string"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"open_with_tool": {
"description": "Name of the tool which can be used to view or edit the sub-flow for this supernode. The default is 'canvas'",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
enso-org/enso | 55d43a3d8a5f02bf3d649bfb393813c2e96b32e9 | 2024-05-20T08:45:55 | app/ide-desktop/lib/dashboard/src/data/datalinkSchema.json | 7,298 | 2024-05-29T03:45:45.603579Z | {
"$defs": {
"AwsAccessKeyAuth": {
"properties": {
"accessKeyId": {
"$ref": "#/$defs/SecureValue",
"title": "Access Key ID"
},
"secretAccessKey": {
"$ref": "#/$defs/SecureValue",
"title": "Secret Access Key"
},
"subType": {
"const": "access_key",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "aws_auth",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType",
"accessKeyId",
"secretAccessKey"
],
"title": "AWS (Access Key)",
"type": "object"
},
"AwsAuth": {
"anyOf": [
{
"$ref": "#/$defs/AwsDefaultAuth"
},
{
"$ref": "#/$defs/AwsProfileAuth"
},
{
"$ref": "#/$defs/AwsAccessKeyAuth"
}
],
"title": "AWS Authentication"
},
"AwsDefaultAuth": {
"properties": {
"subType": {
"const": "default",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "aws_auth",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType"
],
"title": "AWS (Default)",
"type": "object"
},
"AwsProfileAuth": {
"properties": {
"profile": {
"description": "Must not be blank.",
"minLength": 1,
"title": "Profile",
"type": "string"
},
"subType": {
"const": "profile",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "aws_auth",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType",
"profile"
],
"title": "AWS (Profile)",
"type": "object"
},
"BooleanOrInfer": {
"anyOf": [
{
"const": "infer",
"title": "Infer",
"type": "string"
},
{
"const": true,
"title": "True",
"type": "boolean"
},
{
"const": false,
"title": "False",
"type": "boolean"
}
]
},
"DataLink": {
"$comment": "The fields `type` and `libraryName` are required for all data link types, but we currently don't add a top-level `required` setting to the schema, because it was confusing the code that is generating the modal.",
"anyOf": [
{
"$ref": "#/$defs/S3DataLink"
},
{
"$ref": "#/$defs/EnsoFileDataLink"
},
{
"$ref": "#/$defs/HttpFetchDataLink"
},
{
"$ref": "#/$defs/PostgresDataLink"
},
{
"$ref": "#/$defs/SnowflakeDataLink"
}
],
"title": "Data Link"
},
"DefaultFormat": {
"properties": {
"subType": {
"const": "default",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "format",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType"
],
"title": "Default",
"type": "object"
},
"DelimitedFormat": {
"properties": {
"delimiter": {
"description": "Must not be blank.",
"maxLength": 1,
"minLength": 1,
"title": "Delimiter",
"type": "string"
},
"encoding": {
"const": "utf8",
"title": "Encoding",
"type": "string"
},
"headers": {
"$ref": "#/$defs/BooleanOrInfer",
"description": "Whether a header row containing column names is present.",
"title": "Headers"
},
"quote_style": {
"anyOf": [
{
"$ref": "#/$defs/DelimitedQuoteStyle"
},
{
"$ref": "#/$defs/DelimitedQuoteStyleNo"
}
],
"title": "Custom Quotes"
},
"subType": {
"const": "delimited",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "format",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType",
"delimiter",
"headers"
],
"title": "Delimited",
"type": "object"
},
"DelimitedQuoteStyle": {
"properties": {
"escape": {
"default": "\"",
"description": "Must be exactly one character. The character that is prepended to the quote character to escape it.",
"examples": [
"\"",
"\\"
],
"maxLength": 1,
"minLength": 1,
"title": "Escape",
"type": "string"
},
"quote": {
"default": "\"",
"description": "Must be exactly one character.",
"examples": [
"\"",
"'"
],
"maxLength": 1,
"minLength": 1,
"title": "Quote",
"type": "string"
},
"subType": {
"const": "with_quotes",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "quote_style",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType",
"quote",
"escape"
],
"title": "Custom quotes",
"type": "object"
},
"DelimitedQuoteStyleNo": {
"properties": {
"subType": {
"const": "no_quotes",
"title": "Subtype",
"type": "string"
},
"type": {
"const": "quote_style",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType"
],
"title": "Ignore quotes",
"type": "object"
},
"EnsoFileDataLink": {
"properties": {
"format": {
"$ref": "#/$defs/Format",
"title": "Format"
},
"libraryName": {
"const": "Standard.Base"
},
"path": {
"description": "Must start with \"enso://<organization-name>/\".",
"format": "enso-file",
"pattern": "^enso://.+/.*$",
"title": "Path",
"type": "string"
},
"type": {
"const": "Enso_File",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"libraryName",
"path"
],
"title": "Enso File",
"type": "object"
},
"EnsoSecret": {
"properties": {
"secretPath": {
"format": "enso-secret",
"title": "Path",
"type": "string"
},
"type": {
"const": "secret",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"secretPath"
],
"title": "Enso Secret",
"type": "object"
},
"ExcelFormat": {
"properties": {
"section": {
"anyOf": [
{
"$ref": "#/$defs/ExcelSectionWorkbook"
},
{
"$ref": "#/$defs/ExcelSectionSheet"
},
{
"$ref": "#/$defs/ExcelSectionRange"
}
],
"title": "Section"
},
"subType": {
"const": "excel",
"title": "Type",
"type": "string"
},
"type": {
"const": "format",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType",
"section"
],
"title": "Excel",
"type": "object"
},
"ExcelSectionRange": {
"properties": {
"address": {
"description": "Must not be blank.",
"examples": [
"Sheet1!A1:B2"
],
"minLength": 1,
"title": "Address",
"type": "string"
},
"headers": {
"$ref": "#/$defs/BooleanOrInfer",
"description": "Whether a header row containing column names is present at the top of the range.",
"title": "Headers"
},
"type": {
"const": "range",
"type": "string"
}
},
"required": [
"type",
"address",
"headers"
],
"title": "Range",
"type": "object"
},
"ExcelSectionSheet": {
"properties": {
"headers": {
"$ref": "#/$defs/BooleanOrInfer",
"description": "Whether a header row containing column names is present at the top of the sheet.",
"title": "Headers"
},
"name": {
"description": "Must not be blank.",
"minLength": 1,
"title": "Sheet name",
"type": "string"
},
"type": {
"const": "sheet",
"type": "string"
}
},
"required": [
"type",
"name",
"headers"
],
"title": "Sheet",
"type": "object"
},
"ExcelSectionWorkbook": {
"properties": {
"defaultSheet": {
"default": "EnsoSheet",
"description": "The default sheet used when writing a table to the workbook that this data link points to.",
"minLength": 1,
"title": "Default sheet (for writing)",
"type": "string"
},
"type": {
"const": "workbook",
"type": "string"
}
},
"required": [
"type"
],
"title": "Workbook",
"type": "object"
},
"Format": {
"anyOf": [
{
"$ref": "#/$defs/DefaultFormat"
},
{
"$ref": "#/$defs/DelimitedFormat"
},
{
"$ref": "#/$defs/JsonFormat"
},
{
"$ref": "#/$defs/ExcelFormat"
}
],
"title": "Format"
},
"HttpFetchDataLink": {
"$comment": "missing <headers with secrets> and <query string with secrets>",
"properties": {
"format": {
"$ref": "#/$defs/Format",
"title": "Format"
},
"libraryName": {
"const": "Standard.Base"
},
"method": {
"const": "GET",
"title": "Method",
"type": "string"
},
"type": {
"const": "HTTP",
"title": "Type",
"type": "string"
},
"uri": {
"description": "Must start with \"http://\" or \"https://\".",
"pattern": "^https?://[\\w.~-]+/?.*$",
"title": "URI",
"type": "string"
}
},
"required": [
"type",
"libraryName",
"uri",
"method"
],
"title": "HTTP Fetch",
"type": "object"
},
"JsonFormat": {
"properties": {
"subType": {
"const": "json",
"title": "Type",
"type": "string"
},
"type": {
"const": "format",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"subType"
],
"title": "JSON",
"type": "object"
},
"PostgresDataLink": {
"properties": {
"credentials": {
"properties": {
"password": {
"$ref": "#/$defs/SecureValue",
"title": "Password"
},
"username": {
"$ref": "#/$defs/SecureValue",
"title": "Username"
}
},
"required": [
"username",
"password"
],
"title": "Credentials",
"type": "object"
},
"database_name": {
"title": "Database Name",
"type": "string"
},
"host": {
"title": "Hostname",
"type": "string"
},
"libraryName": {
"const": "Standard.Database"
},
"port": {
"default": 5432,
"maximum": 65535,
"minimum": 1,
"title": "Port",
"type": "integer"
},
"schema": {
"title": "Schema",
"type": "string"
},
"table": {
"title": "Table to access",
"type": "string"
},
"type": {
"const": "Postgres_Connection",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"libraryName",
"host",
"port",
"database_name"
],
"title": "Postgres Database Connection",
"type": "object"
},
"S3DataLink": {
"properties": {
"auth": {
"$ref": "#/$defs/AwsAuth",
"title": "Authentication"
},
"format": {
"$ref": "#/$defs/Format",
"title": "Format"
},
"libraryName": {
"const": "Standard.AWS"
},
"type": {
"const": "S3",
"title": "Type",
"type": "string"
},
"uri": {
"description": "Must start with \"s3://\".",
"pattern": "^s3://[a-z0-9.-]{3,63}/.{1,1024}$",
"title": "URI",
"type": "string"
}
},
"required": [
"type",
"libraryName",
"uri",
"auth"
],
"title": "S3",
"type": "object"
},
"SecureValue": {
"anyOf": [
{
"title": "Text",
"type": "string"
},
{
"$ref": "#/$defs/EnsoSecret"
}
],
"title": "Secure Value"
},
"SnowflakeDataLink": {
"properties": {
"account": {
"title": "Account",
"type": "string"
},
"credentials": {
"properties": {
"password": {
"$ref": "#/$defs/SecureValue",
"title": "Password"
},
"username": {
"$ref": "#/$defs/SecureValue",
"title": "Username"
}
},
"required": [
"username",
"password"
],
"title": "Credentials",
"type": "object"
},
"database_name": {
"title": "Database Name",
"type": "string"
},
"libraryName": {
"const": "Standard.Snowflake"
},
"schema": {
"title": "Schema",
"type": "string"
},
"table": {
"title": "Table to access",
"type": "string"
},
"type": {
"const": "Snowflake_Connection",
"title": "Type",
"type": "string"
},
"warehouse": {
"title": "Warehouse",
"type": "string"
}
},
"required": [
"type",
"libraryName",
"account",
"database_name",
"credentials"
],
"title": "Snowflake Database Connection",
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
smartcontractkit/chainlink-common | 5d4cf391ff6f89eabfb9a37777afa51678f0d216 | 2024-05-16T01:58:58 | pkg/capabilities/triggers/testdata/fixtures/mercury/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/streams-trigger/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Streams Trigger",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"feedIds": {
"items": {
"pattern": "^0x[0-9a-f]{64}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"maxFrequencyMs": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"feedIds",
"maxFrequencyMs"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"triggerId": {
"type": "string"
}
},
"required": [
"triggerId"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "string"
},
"Payload": true,
"Timestamp": {
"type": "string"
},
"TriggerType": {
"type": "string"
}
},
"required": [
"TriggerType",
"ID",
"Timestamp",
"Payload"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | a3cb3f2f0f11b85a725dcd1d9c4ec3cee18af431 | 2024-04-19T09:25:22 | pkg/capabilities/consensus/ocr3/testdata/fixtures/capability/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/offchain_reporting/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "OCR3 consensus exposed as a capability.",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"aggregation_config": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
},
"aggregation_method": {
"enum": [
"data_feeds_2_0"
],
"type": "string"
},
"encoder": {
"type": "string"
},
"encoder_config": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"aggregation_method",
"aggregation_config",
"encoder",
"encoder_config"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"observations": {
"additionalProperties": false,
"properties": {
"Underlying": {
"items": true,
"type": "array"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"observations"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"Err": true,
"Value": true,
"WorkflowExecutionID": {
"type": "string"
}
},
"required": [
"WorkflowExecutionID",
"Value",
"Err"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | 6a2cfa12f801afbcac1d0528229574cfd9462d93 | 2024-05-21T01:55:06 | pkg/capabilities/triggers/testdata/fixtures/mercury/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/streams-trigger/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Streams Trigger",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"feedIds": {
"items": {
"pattern": "^0x[0-9a-f]{64}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"maxFrequencyMs": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"feedIds",
"maxFrequencyMs"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"triggerId": {
"type": "string"
}
},
"required": [
"triggerId"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "string"
},
"Metadata": true,
"Payload": true,
"Timestamp": {
"type": "string"
},
"TriggerType": {
"type": "string"
}
},
"required": [
"TriggerType",
"ID",
"Timestamp",
"Metadata",
"Payload"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | ed3ad9caf083ea84587bea8fe7508c4b22dd6252 | 2024-04-22T18:18:42 | pkg/capabilities/triggers/testdata/fixtures/mercury/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/mercury-trigger/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An example mercury trigger.",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"feedIds": {
"items": {
"pattern": "^0x[0-9a-f]{64}$",
"type": "string"
},
"minItems": 1,
"type": "array"
},
"maxFrequencyMs": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"feedIds",
"maxFrequencyMs"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"triggerId": {
"type": "string"
}
},
"required": [
"triggerId"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "string"
},
"Payload": true,
"Timestamp": {
"type": "string"
},
"TriggerType": {
"type": "string"
}
},
"required": [
"TriggerType",
"ID",
"Timestamp",
"Payload"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | 735d3e7f53d4c8986ed1e61cd4d4830bf42d669b | 2024-04-19T18:11:11 | pkg/capabilities/triggers/testdata/fixtures/ondemand/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/on-demand-trigger/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An example on-demand trigger.",
"properties": {
"config": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"Err": true,
"Value": true
},
"required": [
"Value",
"Err"
],
"type": "object"
}
},
"required": [
"config",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | 5055f0743bfc7aa5d50ae4877da465b95b199d5d | 2024-04-18T18:14:18 | pkg/capabilities/testdata/fixtures/validator/trigger_schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"bar": {
"type": "integer"
},
"bonk": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
},
"foo": {
"additionalProperties": false,
"properties": {
"Underlying": {
"items": true,
"type": "array"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"foo",
"bar",
"bonk"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"corge": {
"minimum": 1,
"type": "integer"
},
"quux": {
"type": "string"
}
},
"required": [
"quux",
"corge"
],
"type": "object"
}
},
"required": [
"config",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | f4446b816a28504e0cc11b9252bf49c23707cca4 | 2024-05-17T13:49:04 | pkg/workflows/testdata/fixtures/workflows/workflow_schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$defs": {
"mapping": {
"type": "object"
},
"stepDefinitionID": {
"oneOf": [
{
"$id": "string",
"pattern": "^[a-z0-9_\\-:]+@(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
{
"$id": "https://github.com/smartcontractkit/chainlink-common/pkg/workflows/step-definition-table-id",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"version": {
"pattern": "(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
"type": "string"
}
},
"required": [
"name",
"version",
"labels"
],
"type": "object"
}
],
"title": "id"
},
"stepDefinitionYaml": {
"additionalProperties": false,
"properties": {
"config": {
"$ref": "#/$defs/mapping"
},
"id": {
"$ref": "#/$defs/stepDefinitionID"
},
"inputs": {
"$ref": "#/$defs/mapping"
},
"ref": {
"pattern": "^[a-z0-9_-]+$",
"type": "string"
}
},
"required": [
"id",
"config"
],
"type": "object"
},
"workflowSpecYaml": {
"additionalProperties": false,
"properties": {
"actions": {
"items": {
"$ref": "#/$defs/stepDefinitionYaml"
},
"type": "array"
},
"consensus": {
"items": {
"$ref": "#/$defs/stepDefinitionYaml"
},
"type": "array"
},
"targets": {
"items": {
"$ref": "#/$defs/stepDefinitionYaml"
},
"type": "array"
},
"triggers": {
"items": {
"$ref": "#/$defs/stepDefinitionYaml"
},
"type": "array"
}
},
"required": [
"triggers",
"consensus",
"targets"
],
"type": "object"
}
},
"$id": "https://github.com/smartcontractkit/chainlink-common/pkg/workflows/workflow-spec-yaml",
"$ref": "#/$defs/workflowSpecYaml",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | en |
smartcontractkit/chainlink-common | 5055f0743bfc7aa5d50ae4877da465b95b199d5d | 2024-04-18T18:14:18 | pkg/capabilities/testdata/fixtures/validator/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/test/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "test description",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"bar": {
"type": "integer"
},
"bonk": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
},
"foo": {
"additionalProperties": false,
"properties": {
"Underlying": {
"items": true,
"type": "array"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"foo",
"bar",
"bonk"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"baz": {
"pattern": "^world$",
"type": "string"
},
"qux": {
"type": "integer"
}
},
"required": [
"baz",
"qux"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"corge": {
"minimum": 1,
"type": "integer"
},
"quux": {
"type": "string"
}
},
"required": [
"quux",
"corge"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
smartcontractkit/chainlink-common | 5d4cf391ff6f89eabfb9a37777afa51678f0d216 | 2024-05-16T01:58:58 | pkg/capabilities/consensus/ocr3/testdata/fixtures/capability/schema.json | 20 | 2024-05-27T08:51:15.853118Z | {
"$id": "https://github.com/smartcontractkit/chainlink/capabilities/offchain_reporting/root",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "OCR3 consensus exposed as a capability.",
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"aggregation_config": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
},
"aggregation_method": {
"enum": [
"data_feeds"
],
"type": "string"
},
"encoder": {
"type": "string"
},
"encoder_config": {
"additionalProperties": false,
"properties": {
"Underlying": {
"type": "object"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"aggregation_method",
"aggregation_config",
"encoder",
"encoder_config"
],
"type": "object"
},
"inputs": {
"additionalProperties": false,
"properties": {
"observations": {
"additionalProperties": false,
"properties": {
"Underlying": {
"items": true,
"type": "array"
}
},
"required": [
"Underlying"
],
"type": "object"
}
},
"required": [
"observations"
],
"type": "object"
},
"outputs": {
"additionalProperties": false,
"properties": {
"Err": true,
"Value": true,
"WorkflowExecutionID": {
"type": "string"
}
},
"required": [
"WorkflowExecutionID",
"Value",
"Err"
],
"type": "object"
}
},
"required": [
"config",
"inputs",
"outputs"
],
"type": "object"
} | MIT | en |
JackBister/logsuck | 9e8502e2779f39957f313628fadef7d80989ee05 | 2020-07-21T12:43:10 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file.",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 289bf2921e3a5c5fca59487bd17d914f8de82afa | 2023-02-04T18:25:23 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"jsonConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "JSON"
}
},
"description": "Configuration specific to the JSON parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"timeField": {
"description": "Which field in the JSON object representing an event should be considered the timestamp of the event and placed in the _time field. Default 'ts'.",
"type": "string"
}
},
"type": "object"
},
"regexConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "Regex"
}
},
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"timeField": {
"description": "The name of the extracted field which should be considered the timestamp of the event and placed in the _time field. Default '_time'.",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"JSON",
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 82b069bddfc391c3139d3b2ffecff3241c1b8c31 | 2021-02-01T21:26:48 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 99910ef5e91ca48c1ce7762d59f58a7094f7277b | 2020-07-20T16:13:55 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file.",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 9516074afa6e8f3fb3065a065f25c640694358c0 | 2023-01-07T14:51:28 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"configPollInterval": {
"description": "How often the host should poll for configuration updates. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 6c369e1fbc9969bc6665979c0e8b3fc2ca8d0a7f | 2023-02-26T15:50:26 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"jsonConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "JSON"
}
},
"description": "Configuration specific to the JSON parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"timeField": {
"description": "Which field in the JSON object representing an event should be considered the timestamp of the event and placed in the _time field. Default 'ts'.",
"type": "string"
}
},
"type": "object"
},
"regexConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "Regex"
}
},
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"timeField": {
"description": "The name of the extracted field which should be considered the timestamp of the event and placed in the _time field. Default '_time'.",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"JSON",
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. There are also the special timelayouts \"UNIX\", \"UNIX_MILLIS\", and \"UNIX_DECIMAL_NANOS\". \"UNIX\" expects the _time field to contain the number of seconds since the Unix epoch, \"UNIX_MILLIS\" expects it to contain the number of milliseconds since the Unix epoch, and UNIX_DECIMAL_NANOS expects it to contain a string of the form \"<UNIX>.<NANOS>\" where \"<UNIX>\" is the number of seconds since the Unix epoch and \"<NANOS>\" is the number of elapsed nanoseconds in that second. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"autoform": {
"dynamicEnum": "fileTypes"
},
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"autoform": {
"dynamicEnum": "hostTypes"
},
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"autoform": {
"dynamicEnum": "files"
},
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"autoform": {
"dynamicEnum": "tasks"
},
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 28b8e2966b3ea5171db2e1d3980459933e24c703 | 2023-02-05T15:15:28 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"jsonConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "JSON"
}
},
"description": "Configuration specific to the JSON parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"timeField": {
"description": "Which field in the JSON object representing an event should be considered the timestamp of the event and placed in the _time field. Default 'ts'.",
"type": "string"
}
},
"type": "object"
},
"regexConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "Regex"
}
},
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"timeField": {
"description": "The name of the extracted field which should be considered the timestamp of the event and placed in the _time field. Default '_time'.",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"JSON",
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. There are also the special timelayouts \"UNIX\", \"UNIX_MILLIS\", and \"UNIX_DECIMAL_NANOS\". \"UNIX\" expects the _time field to contain the number of seconds since the Unix epoch, \"UNIX_MILLIS\" expects it to contain the number of milliseconds since the Unix epoch, and UNIX_DECIMAL_NANOS expects it to contain a string of the form \"<UNIX>.<NANOS>\" where \"<UNIX>\" is the number of seconds since the Unix epoch and \"<NANOS>\" is the number of elapsed nanoseconds in that second. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 5ec0dc7d7b1cf8f59d535864948893c9145257ba | 2020-08-01T21:26:15 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file.",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 303cceb49afddccac4dbdc8f520734bc564d9de8 | 2023-01-16T19:41:27 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 3c5bd421ecdac9df86f47e69261dccaaed3e5f7c | 2022-12-29T19:35:43 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"configPollInterval": {
"description": "How often the host should poll for configuration updates. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"fileTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forwarder": {
"additionalProperties": false,
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"recipient": {
"additionalProperties": false,
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"additionalProperties": {
"type": "string"
},
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"type": "object"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | e867843f6c7ee63e12f2eed5b646a4e6e4316505 | 2023-01-17T19:49:42 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 2cc6fdef0ee7357db770372c7678248ac993fc7d | 2020-08-07T20:08:55 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file.",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 1618b6f2c3959a4c86e4d6e11186f2b780027b4f | 2021-01-17T15:55:23 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | c84e86a3366f3bf4c6e7a41324152e49f2877c60 | 2023-02-01T19:35:46 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"jsonConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "JSON"
}
},
"description": "Configuration specific to the JSON parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"timeField": {
"description": "Which field in the JSON object representing an event should be considered the timestamp of the event and placed in the _time field. Default 'ts'.",
"type": "string"
}
},
"type": "object"
},
"regexConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "Regex"
}
},
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"JSON",
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 6404cb2ec573ac3df1f923a1b211cd95786e1d65 | 2022-01-23T14:39:43 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 109451e6043774be85c99295b714f8f1aa543b5d | 2022-04-04T18:55:37 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"configPollInterval": {
"description": "How often the host should poll for configuration updates. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"fileTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forwarder": {
"additionalProperties": false,
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"recipient": {
"additionalProperties": false,
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"additionalProperties": {
"type": "string"
},
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"type": "object"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | e5e212404a0c565c1f21a242b5f7a1bdfc70ab08 | 2022-02-12T14:35:47 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"additionalProperties": {
"type": "string"
},
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"type": "object"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 5fa0755340c286e4f7a19d113103221ccda67166 | 2021-02-19T17:00:17 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"forwarder": {
"description": "Configuration for running in recipient mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"hostName": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"recipient": {
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | fabcd76945d03e0124c2ca21081f3763d5c80f40 | 2020-07-18T22:35:52 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Configuration for logsuck",
"properties": {
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression with a single, named capture group. The name of the capture group will be used as the field name and the captured string will be used as the value.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fileName": {
"description": "The name of the file.",
"type": "string"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"sqlite": {
"description": "Configuration for the SQLite database where logsuck will store its data.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
}
},
"type": "object"
},
"web": {
"description": "Configuration for the web GUI used to access logsuck.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'",
"type": "string"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | d5f1e4ec79f9ce4c3e24287c85f186464a7e6cc7 | 2022-03-26T18:06:47 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"configPollInterval": {
"description": "How often the host should poll for configuration updates. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"fileTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"parser": {
"properties": {
"regexConfig": {
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forwarder": {
"additionalProperties": false,
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"type": "object"
},
"recipient": {
"additionalProperties": false,
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
},
"timeLayouts": {
"description": "timeLayouts is a map from source name to a string specifying the layout of timestamps in that file. It is the equivalent to setting timeLayout on an object in the files array when running in single host mode. The special key \"DEFAULT\" will be used for any source that is not specified in the map. Default '2006/01/02 15:04:05'.",
"type": "object"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"additionalProperties": {
"type": "string"
},
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"type": "object"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
JackBister/logsuck | 8281ac516db9e0114d34941ca23f6894b8158ce9 | 2023-07-15T11:32:44 | logsuck-config.schema.json | 168 | 2024-05-28T04:43:41.52277Z | {
"$id": "https://github.com/jackbister/logsuck/logsuck-config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration for logsuck",
"properties": {
"$schema": {
"description": "A string containing the URL to this schema. Most likely \"https://github.com/jackbister/logsuck/logsuck-config.schema.json\", or \"./logsuck-config.schema.json\" if developing logsuck.",
"type": "string"
},
"fileTypes": {
"description": "A fileType combines configuration related to a type of file. For example you may have certain config that is only applicable to access logs, in which case you might name a fileType \"access_log\" and put access log specific config there. The special fileType \"DEFAULT\" is applied to all files. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of this file type. Must be unique.",
"type": "string"
},
"parser": {
"properties": {
"jsonConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "JSON"
}
},
"description": "Configuration specific to the JSON parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"timeField": {
"description": "Which field in the JSON object representing an event should be considered the timestamp of the event and placed in the _time field. Default 'ts'.",
"type": "string"
}
},
"type": "object"
},
"regexConfig": {
"autoform": {
"conditional": {
"key": "type",
"value": "Regex"
}
},
"description": "Configuration specific to the Regex parser",
"properties": {
"eventDelimiter": {
"description": "A regex specifying the delimiter between events. For example, if the file contains one event per row this should be '\\n'. Default '\\n'.",
"type": "string"
},
"fieldExtractors": {
"description": "Regular expressions which will be used to extract field values from events.\nCan be given in two variants:\n1. An expression containing any number of named capture groups. The names of the capture groups will be used as the field names and the captured strings will be used as the values.\n2. An expression with two unnamed capture groups. The first capture group will be used as the field name and the second group as the value.\nIf a field with the name '_time' is extracted and matches the given timelayout, it will be used as the timestamp of the event. Otherwise the time the event was read will be used.\nMultiple extractors can be specified by using the fieldextractor flag multiple times. Defaults \"(\\w+)=(\\w+)\" and \"(?P<_time>\\d\\d\\d\\d/\\d\\d/\\d\\d \\d\\d:\\d\\d:\\d\\d\\.\\d\\d\\d\\d\\d\\d)\")",
"items": {
"type": "string"
},
"type": "array"
},
"timeField": {
"description": "The name of the extracted field which should be considered the timestamp of the event and placed in the _time field. Default '_time'.",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "The name of the parser to use for this file. Default 'Regex'. Regex uses regular expressions to delimit events and extract values from them.",
"enum": [
"JSON",
"Regex"
],
"type": "string"
}
},
"type": "object"
},
"readInterval": {
"description": "The duration between checking the file for updates. A low value will make the events searchable sooner at the cost of using more CPU and doing more disk reads. Default '1s'.",
"type": "string"
},
"timeLayout": {
"description": "The layout of the _time field which will be extracted from this file. If no _time field is extracted or it doesn't match this layout, the time when the event was read will be used as the timestamp for that event. There are also the special timelayouts \"UNIX\", \"UNIX_MILLIS\", and \"UNIX_DECIMAL_NANOS\". \"UNIX\" expects the _time field to contain the number of seconds since the Unix epoch, \"UNIX_MILLIS\" expects it to contain the number of milliseconds since the Unix epoch, and UNIX_DECIMAL_NANOS expects it to contain a string of the form \"<UNIX>.<NANOS>\" where \"<UNIX>\" is the number of seconds since the Unix epoch and \"<NANOS>\" is the number of elapsed nanoseconds in that second. Default '2006/01/02 15:04:05'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"files": {
"items": {
"additionalProperties": false,
"properties": {
"fileName": {
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
},
"fileTypes": {
"items": {
"autoform": {
"dynamicEnum": "fileTypes"
},
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"forceStaticConfig": {
"autoform": {
"readonly": true
},
"description": "If enabled, the JSON configuration file will be used instead of the configuration saved in the database. This means that you cannot alter configuration at runtime and must instead update the JSON file and restart logsuck. Has no effect in forwarder mode. Default false.",
"type": "boolean"
},
"forwarder": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in forwarder mode, where events will be pushed to a recipient instance of logsuck instead of being saved locally.",
"properties": {
"configPollInterval": {
"description": "How often the forwarder should poll for configuration updates from the recipient. Must be a string like '1m', '15s', etc. Default '1m'.",
"type": "string"
},
"enabled": {
"description": "Whether forwarding mode should be enabled or not. Default false.",
"type": "boolean"
},
"maxBufferedEvents": {
"description": "If the forwarder is unable to reach the recipient, events will begin to queue up. maxBufferedEvents is the maximum size of that queue. If maxBufferedEvents is exceeded before the forwarder can reach the recipient again, events will be lost.",
"type": "number"
},
"recipientAddress": {
"description": "The URL where the recipient instance is running. Default 'localhost:8081'.",
"type": "string"
}
},
"type": "object"
},
"host": {
"additionalProperties": false,
"description": "Configuration related to the current host machine.",
"properties": {
"name": {
"autoform": {
"readonly": true
},
"description": "The name of the host running this instance of logsuck. If empty or unset, logsuck will attempt to retrieve the hostname from the operating system.",
"type": "string"
},
"type": {
"autoform": {
"dynamicEnum": "hostTypes",
"readonly": true
},
"description": "The type of this host. Must be a key of the \"hostTypes\" object. This will define what files will be read by this instance of logsuck.",
"type": "string"
}
},
"type": "object"
},
"hostTypes": {
"description": "A hostType contains configuration related to a type of host. For example your web server hosts may have different configuration than your database server hosts. The special hostType \"DEFAULT\" is applied to all hosts. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"items": {
"additionalProperties": false,
"properties": {
"files": {
"description": "The files which should be indexed.",
"items": {
"properties": {
"fileName": {
"autoform": {
"dynamicEnum": "files"
},
"description": "The name of the file. This can also be a glob pattern such as \"log-*.txt\".",
"type": "string"
}
},
"required": [
"fileName"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the host type. Must be unique.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"recipient": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for running in recipient mode, where events will be rececived from other logsuck instances in forwarder mode instead of reading directly from the log files.",
"properties": {
"address": {
"description": "The addreess where the API endpoints that the forwarders will communicate with should be exposed. Default ':8081'.",
"type": "string"
},
"enabled": {
"description": "Whether recipient mode should be enabled or not. Default false.",
"type": "boolean"
}
},
"type": "object"
},
"sqlite": {
"additionalProperties": false,
"autoform": {
"readonly": true
},
"description": "Configuration for the SQLite database where logsuck will store its data. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"fileName": {
"description": "The file name which will be used for the SQLite database. Default 'logsuck.db'.",
"type": "string"
},
"trueBatch": {
"description": "Whether Logsuck should use 'true batch' mode or not. True batch is significantly faster at saving events on average, but is slower at handling duplicates and relies on SQLite behavior which may not be guaranteed. Default true.",
"type": "boolean"
}
},
"type": "object"
},
"tasks": {
"additionalProperties": false,
"description": "Configuration for tasks, which run periodically and perform maintenance tasks like removing old events. If there is no configuration for a task it will never run.",
"properties": {
"tasks": {
"description": "An array of configurations for each task.",
"items": {
"properties": {
"config": {
"description": "A key-value map from string to string of task-specific configuration. Check the documentation for a specific task to see which properties are available.",
"items": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"enabled": {
"description": "Whether the task should run or not.",
"type": "boolean"
},
"interval": {
"description": "How often the task should run.",
"type": "string"
},
"name": {
"autoform": {
"dynamicEnum": "tasks"
},
"description": "The name of the task.",
"type": "string"
}
},
"required": [
"name",
"enabled",
"interval"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"web": {
"additionalProperties": false,
"description": "Configuration for the web GUI used to access logsuck. In a forwarder/recipient setup this only needs to be configured on the recipient host.",
"properties": {
"address": {
"description": "The address where the web server will be exposed. Default ':8080'.",
"type": "string"
},
"debugMode": {
"description": "Enables debug mode in the web server, which may enable features such as extra logging. Default false.",
"type": "boolean"
},
"enabled": {
"autoform": {
"readonly": true
},
"description": "Whether the web server should run. Defaults to true unless the configuration specifies that this logsuck instance should run in forwarder mode.",
"type": "boolean"
},
"usePackagedFiles": {
"description": "If true, all static files will be served using the files that are bundled into the executable. If false, the normal filesystem will be used (which means the directory './internal/web/static/dist' must exist in the working directory). This is mostly useful when developing. Default true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Logsuck Config",
"type": "object"
} | Apache-2.0 | en |
open-southeners/vscode-laravel-pint | 95a8c1dce82e27df51e188ccec9e273d84c08bc2 | 2022-07-05T07:29:57 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list and parameters list must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 7.3 required for `arguments`, PHP >= 8.0 for `parameters`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | 7945a5621582db431ffc3574ccfdea040e634280 | 2022-06-28T08:55:44 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"type": "string"
},
"preset": {
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr-12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | e94f7de380776f668e576760bcc74ed4ea40cfd7 | 2022-10-16T09:59:46 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_concat_operator": {
"description": "There should not be useless concat operations."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | 5bf5040401fb3fb05da6216a751398c1f43c8069 | 2022-06-28T19:03:18 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr-12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list and parameters list must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 7.3 required for `arguments`, PHP >= 8.0 for `parameters`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | d38f883f1efbd1fda2c330fe413b856bdfcba019 | 2022-09-09T23:17:47 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | cb287ae68e3dc96a3c9e8802543f324fca8e5107 | 2022-09-14T09:50:55 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | edd0542181ae16286646cc21368688b6a231e148 | 2022-11-24T10:07:36 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_fn_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for short arrow functions.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc.",
"properties": {
"annotations": {
"default": [],
"description": "List of annotations to remove, e.g. `[\"author\"]`.",
"type": "array"
},
"case_sensitive": {
"default": true,
"description": "Should annotations be case sensitive.",
"type": "boolean"
}
},
"type": "object"
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_concat_operator": {
"description": "There should not be useless concat operations."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"case",
"constant",
"constant_private",
"constant_protected",
"constant_public",
"construct",
"destruct",
"magic",
"method",
"method_abstract",
"method_private",
"method_private_abstract",
"method_private_abstract_static",
"method_private_static",
"method_protected",
"method_protected_abstract",
"method_protected_abstract_static",
"method_protected_static",
"method_public",
"method_public_abstract",
"method_public_abstract_static",
"method_public_static",
"method_static",
"phpunit",
"private",
"property",
"property_private",
"property_private_readonly",
"property_private_static",
"property_protected",
"property_protected_readonly",
"property_protected_static",
"property_public",
"property_public_readonly",
"property_public_static",
"property_static",
"protected",
"public",
"use_trait"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"method",
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arguments",
"arrays",
"match",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | 0a5648bbeade280dddc0212f77094d1a29a55497 | 2022-06-28T17:36:38 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr-12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `booleanval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_boolean_cast": {
"description": "Short cast `boolean` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleaneans": {
"default": false,
"description": "whether to limit operators to only booleanean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `boolean` not `booleanean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(booleanean)` and `(integer)` should be written as `(boolean)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the booleanean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list and parameters list must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 7.3 required for `arguments`, PHP >= 8.0 for `parameters`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | f572c40b3c1b020b20203938e197bcc2cc4911d9 | 2022-07-13T19:07:20 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
open-southeners/vscode-laravel-pint | ee60621fd1da337cc98552451face6729a93f61f | 2022-06-28T09:04:03 | pint-schema.json | 74 | 2024-05-27T06:42:46.05629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr-12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
openshift/managed-scripts | d308cc4b7d97e63a230ab00391017e2b59d8b830 | 2023-09-12T01:46:04 | hack/metadata.schema.json | 10 | 2024-05-28T04:31:04.272504Z | {
"$defs": {
"roleRule": {
"properties": {
"namespace": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/$defs/rules"
},
"type": "array"
}
},
"required": [
"namespace",
"rules"
],
"type": "object"
},
"rules": {
"properties": {
"apiGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"verbs",
"apiGroups",
"resources"
],
"type": "object"
}
},
"$id": "https://github.com/openshift/managed-scripts/metadata.schema.json",
"$schema": "https://json-schema.org/draft-06/schema#",
"additionalProperties": false,
"description": "Metadata for managed scripts",
"properties": {
"allowedGroups": {
"description": "Groups who are allowed to run the script",
"items": {
"type": "string"
},
"type": "array"
},
"author": {
"description": "Github username of the author",
"type": "string"
},
"description": {
"description": "A brief description of the script",
"type": "string"
},
"envs": {
"additionalProperties": false,
"description": "The environment variables declared on the script",
"items": {
"properties": {
"description": {
"description": "A brief description of the environment variable",
"type": "string"
},
"key": {
"description": "Key of the environment variable",
"type": "string"
},
"optional": {
"description": "Whether or not this environment variable is optional",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"file": {
"description": "File name of the script",
"type": "string"
},
"labels": {
"description": "Labels that apply to this script",
"items": {
"properties": {
"description": {
"description": "A brief description of the label",
"type": "string"
},
"key": {
"description": "Key of the label",
"type": "string"
},
"values": {
"description": "Values for the label",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"language": {
"description": "The script language",
"enum": [
"python",
"bash"
],
"type": "string"
},
"name": {
"description": "Parent directory name of the script",
"type": "string"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoleRules": {
"items": {
"$ref": "#/$defs/rules"
},
"type": "array"
},
"roles": {
"items": {
"$ref": "#/$defs/roleRule"
},
"type": "array"
}
},
"type": "object"
},
"shortDescription": {
"description": "A shorter description for tables and lists",
"type": "string"
}
},
"required": [
"file",
"name",
"description",
"author",
"language",
"allowedGroups"
],
"title": "Metadata",
"type": "object"
} | Apache-2.0 | en |
openshift/managed-scripts | e28dd6c604f8b2e58379c812b38d67520993e942 | 2021-08-06T05:33:34 | hack/metadata.schema.json | 10 | 2024-05-28T04:31:04.272504Z | {
"$defs": {
"rules": {
"properties": {
"apiGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://github.com/openshift/managed-scripts/metadata.schema.json",
"$schema": "https://json-schema.org/draft-06/schema#",
"description": "Metadata for managed scripts",
"properties": {
"allowedGroups": {
"description": "Groups who are allowed to run the script",
"items": {
"type": "string"
},
"type": "array"
},
"author": {
"description": "Github username of the author",
"type": "string"
},
"description": {
"description": "A brief description of the script",
"type": "string"
},
"envs": {
"description": "The environment variables declared on the script",
"items": {
"properties": {
"description": {
"description": "A brief description of the environment variable",
"type": "string"
},
"key": {
"description": "Key of the environment variable",
"type": "string"
},
"optional": {
"description": "Whether or not this environment variable is optional",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"file": {
"description": "File name of the script",
"type": "string"
},
"language": {
"description": "The script language",
"enum": [
"python",
"bash"
],
"type": "string"
},
"name": {
"description": "Parent directory name of the script",
"type": "string"
},
"rbac": {
"properties": {
"clusterRoleRules": {
"$ref": "#/$defs/rules"
},
"roles": {
"items": {
"$ref": "#/$defs/rules"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"file",
"name",
"description",
"author",
"language",
"allowedGroups"
],
"title": "Metadata",
"type": "object"
} | Apache-2.0 | en |
openshift/managed-scripts | 7fdb034019c7aa7a7eb7f45cd55636233ee29d49 | 2023-11-13T02:27:47 | hack/metadata.schema.json | 10 | 2024-05-28T04:31:04.272504Z | {
"$defs": {
"roleRule": {
"properties": {
"namespace": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/$defs/rules"
},
"type": "array"
}
},
"required": [
"namespace",
"rules"
],
"type": "object"
},
"rules": {
"properties": {
"apiGroups": {
"items": {
"type": "string"
},
"type": "array"
},
"resourceNames": {
"items": {
"type": "string"
},
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"type": "array"
},
"verbs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"verbs",
"apiGroups",
"resources"
],
"type": "object"
}
},
"$id": "https://github.com/openshift/managed-scripts/metadata.schema.json",
"$schema": "https://json-schema.org/draft-06/schema#",
"additionalProperties": false,
"description": "Metadata for managed scripts",
"properties": {
"allowedGroups": {
"description": "Groups who are allowed to run the script",
"items": {
"type": "string"
},
"type": "array"
},
"author": {
"description": "Github username of the author",
"type": "string"
},
"clusterVersions": {
"additionalProperties": false,
"description": "List of required cluster versions, supporting 'major.minor.patch' format and wildcards",
"items": {
"pattern": "^\\d+\\.\\d+\\.\\d+$|^\\d+\\.\\d+\\.\\*$",
"type": "string"
},
"type": "array"
},
"description": {
"description": "A brief description of the script",
"type": "string"
},
"envs": {
"additionalProperties": false,
"description": "The environment variables declared on the script",
"items": {
"properties": {
"description": {
"description": "A brief description of the environment variable",
"type": "string"
},
"key": {
"description": "Key of the environment variable",
"type": "string"
},
"optional": {
"description": "Whether or not this environment variable is optional",
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
},
"file": {
"description": "File name of the script",
"type": "string"
},
"labels": {
"description": "Labels that apply to this script",
"items": {
"properties": {
"description": {
"description": "A brief description of the label",
"type": "string"
},
"key": {
"description": "Key of the label",
"type": "string"
},
"values": {
"description": "Values for the label",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"language": {
"description": "The script language",
"enum": [
"python",
"bash"
],
"type": "string"
},
"name": {
"description": "Parent directory name of the script",
"type": "string"
},
"rbac": {
"additionalProperties": false,
"properties": {
"clusterRoleRules": {
"items": {
"$ref": "#/$defs/rules"
},
"type": "array"
},
"roles": {
"items": {
"$ref": "#/$defs/roleRule"
},
"type": "array"
}
},
"type": "object"
},
"shortDescription": {
"description": "A shorter description for tables and lists",
"type": "string"
}
},
"required": [
"file",
"name",
"description",
"author",
"language",
"allowedGroups"
],
"title": "Metadata",
"type": "object"
} | Apache-2.0 | en |
yu-iskw/dbt-artifacts-parser | 84f06fef31549ac9dce8eb884565e7fe24161755 | 2024-05-21T09:27:20 | dbt_artifacts_parser/resources/run-results/run-results_v6.json | 57 | 2024-05-27T05:04:56.710565Z | {
"$id": "https://schemas.getdbt.com/dbt/run-results/v6.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"args": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"elapsed_time": {
"type": "number"
},
"metadata": {
"additionalProperties": false,
"properties": {
"dbt_schema_version": {
"type": "string"
},
"dbt_version": {
"default": "1.8.0a1",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"generated_at": {
"type": "string"
},
"invocation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"dbt_schema_version"
],
"title": "BaseArtifactMetadata",
"type": "object"
},
"results": {
"items": {
"additionalProperties": false,
"properties": {
"adapter_response": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"execution_time": {
"type": "number"
},
"failures": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"enum": [
"success",
"error",
"skipped"
]
},
{
"enum": [
"pass",
"error",
"fail",
"warn",
"skipped"
]
},
{
"enum": [
"pass",
"warn",
"error",
"runtime error"
]
}
]
},
"thread_id": {
"type": "string"
},
"timing": {
"items": {
"additionalProperties": false,
"properties": {
"completed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"started_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "TimingInfo",
"type": "object"
},
"type": "array"
},
"unique_id": {
"type": "string"
}
},
"required": [
"status",
"timing",
"thread_id",
"execution_time",
"adapter_response",
"message",
"failures",
"unique_id",
"compiled",
"compiled_code",
"relation_name"
],
"title": "RunResultOutput",
"type": "object"
},
"type": "array"
}
},
"required": [
"metadata",
"results",
"elapsed_time"
],
"title": "RunResultsArtifact",
"type": "object"
} | Apache-2.0 | en |
yu-iskw/dbt-artifacts-parser | 84f06fef31549ac9dce8eb884565e7fe24161755 | 2024-05-21T09:27:20 | dbt_artifacts_parser/resources/manifest/manifest_v12.json | 57 | 2024-05-27T05:04:56.710565Z | {
"$id": "https://schemas.getdbt.com/dbt/manifest/v12.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"child_map": {
"anyOf": [
{
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "A mapping from parent nodes to their dependents"
},
"disabled": {
"anyOf": [
{
"additionalProperties": {
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"delimiter": {
"default": ",",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "seed",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quote_columns": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SeedConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "MacroDependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "seed"
},
"root_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Seed",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "analysis"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Analysis",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enabled": {
"default": true,
"type": "boolean"
},
"error_if": {
"default": "!= 0",
"type": "string"
},
"fail_calc": {
"default": "count(*)",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "test",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "dbt_test__audit"
},
"severity": {
"default": "ERROR",
"pattern": "^([Ww][Aa][Rr][Nn]|[Ee][Rr][Rr][Oo][Rr])$",
"type": "string"
},
"store_failures": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"store_failures_as": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"warn_if": {
"default": "!= 0",
"type": "string"
},
"where": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "test"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "SingularTest",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "operation"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "HookNode",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"access": {
"default": "protected",
"enum": [
"private",
"protected",
"public"
]
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"access": {
"default": "protected",
"enum": [
"private",
"protected",
"public"
]
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "ModelConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ModelLevelConstraint",
"type": "object"
},
"type": "array"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"deprecation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"latest_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"primary_key": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "model"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Model",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "sql_operation"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "SqlOperation",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"attached_node": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"column_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enabled": {
"default": true,
"type": "boolean"
},
"error_if": {
"default": "!= 0",
"type": "string"
},
"fail_calc": {
"default": "count(*)",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "test",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "dbt_test__audit"
},
"severity": {
"default": "ERROR",
"pattern": "^([Ww][Aa][Rr][Nn]|[Ee][Rr][Rr][Oo][Rr])$",
"type": "string"
},
"store_failures": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"store_failures_as": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"warn_if": {
"default": "!= 0",
"type": "string"
},
"where": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"file_key_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "test"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"test_metadata": {
"additionalProperties": false,
"properties": {
"kwargs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"default": "test",
"type": "string"
},
"namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestMetadata",
"type": "object"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "GenericTest",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"check_cols": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "snapshot",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"target_database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"target_schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SnapshotConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "snapshot"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum",
"config"
],
"title": "Snapshot",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
}
},
"title": "SourceConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"default": "",
"type": "string"
},
"external": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"file_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"partitions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"data_type": {
"default": "",
"type": "string"
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"default": "",
"type": "string"
}
},
"title": "ExternalPartition",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"row_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tbl_properties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "ExternalTable",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"freshness": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"error_after": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"period": {
"anyOf": [
{
"enum": [
"minute",
"hour",
"day"
]
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Time",
"type": "object"
},
{
"type": "null"
}
]
},
"filter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"warn_after": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"period": {
"anyOf": [
{
"enum": [
"minute",
"hour",
"day"
]
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Time",
"type": "object"
},
{
"type": "null"
}
]
}
},
"title": "FreshnessThreshold",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"identifier": {
"type": "string"
},
"loaded_at_field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"loader": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"quoting": {
"additionalProperties": false,
"properties": {
"column": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"identifier": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Quoting",
"type": "object"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "source"
},
"schema": {
"type": "string"
},
"source_description": {
"type": "string"
},
"source_meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"source_name": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"source_name",
"source_description",
"loader",
"identifier"
],
"title": "SourceDefinition",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
}
},
"title": "ExposureConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"maturity": {
"anyOf": [
{
"enum": [
"low",
"medium",
"high"
]
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"owner": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Owner",
"type": "object"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"const": "exposure"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"type",
"owner"
],
"title": "Exposure",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "MetricConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"type": "string"
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"const": "metric"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"simple",
"ratio",
"cumulative",
"derived",
"conversion"
]
},
"type_params": {
"additionalProperties": false,
"properties": {
"conversion_type_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"base_measure": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"calculation": {
"default": "conversion_rate",
"enum": [
"conversions",
"conversion_rate"
]
},
"constant_properties": {
"anyOf": [
{
"items": {
"additionalProperties": false,
"properties": {
"base_property": {
"type": "string"
},
"conversion_property": {
"type": "string"
}
},
"required": [
"base_property",
"conversion_property"
],
"title": "ConstantPropertyInput",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"conversion_measure": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"entity": {
"type": "string"
},
"window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"base_measure",
"conversion_measure",
"entity"
],
"title": "ConversionTypeParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"grain_to_date": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"input_measures": {
"items": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"type": "array"
},
"measure": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"metrics": {
"anyOf": [
{
"items": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "MetricTypeParams",
"type": "object"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"description",
"label",
"type",
"type_params"
],
"title": "Metric",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"cache": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"type": "boolean"
}
},
"title": "SavedQueryCache",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"export_as": {
"anyOf": [
{
"enum": [
"table",
"view"
]
},
{
"type": "null"
}
],
"default": null
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SavedQueryConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"exports": {
"items": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"export_as": {
"enum": [
"table",
"view"
]
},
"schema_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"export_as"
],
"title": "ExportConfig",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"config"
],
"title": "Export",
"type": "object"
},
"type": "array"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"query_params": {
"additionalProperties": false,
"properties": {
"group_by": {
"items": {
"type": "string"
},
"type": "array"
},
"metrics": {
"items": {
"type": "string"
},
"type": "array"
},
"where": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"metrics",
"group_by",
"where"
],
"title": "QueryParams",
"type": "object"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"query_params",
"exports"
],
"title": "SavedQuery",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "SemanticModelConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"defaults": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"agg_time_dimension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Defaults",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"dimensions": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"is_partition": {
"default": false,
"type": "boolean"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"type": {
"enum": [
"categorical",
"time"
]
},
"type_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"time_granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
"validity_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"is_end": {
"default": false,
"type": "boolean"
},
"is_start": {
"default": false,
"type": "boolean"
}
},
"title": "DimensionValidityParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"time_granularity"
],
"title": "DimensionTypeParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"type"
],
"title": "Dimension",
"type": "object"
},
"type": "array"
},
"entities": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"foreign",
"natural",
"primary",
"unique"
]
}
},
"required": [
"name",
"type"
],
"title": "Entity",
"type": "object"
},
"type": "array"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"measures": {
"items": {
"additionalProperties": false,
"properties": {
"agg": {
"enum": [
"sum",
"min",
"max",
"count_distinct",
"sum_boolean",
"average",
"percentile",
"median",
"count"
]
},
"agg_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"percentile": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"use_approximate_percentile": {
"default": false,
"type": "boolean"
},
"use_discrete_percentile": {
"default": false,
"type": "boolean"
}
},
"title": "MeasureAggregationParameters",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"agg_time_dimension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"create_metric": {
"default": false,
"type": "boolean"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"non_additive_dimension": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"window_choice": {
"enum": [
"sum",
"min",
"max",
"count_distinct",
"sum_boolean",
"average",
"percentile",
"median",
"count"
]
},
"window_groupings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"window_choice",
"window_groupings"
],
"title": "NonAdditiveDimension",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"agg"
],
"title": "Measure",
"type": "object"
},
"type": "array"
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"node_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": ""
},
"schema_name": {
"type": "string"
}
},
"required": [
"alias",
"schema_name"
],
"title": "NodeRelation",
"type": "object"
},
{
"type": "null"
}
]
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"primary_entity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"model",
"node_relation"
],
"title": "SemanticModel",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"tags": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"title": "UnitTestConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"expect": {
"additionalProperties": false,
"properties": {
"fixture": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"format": {
"default": "dict",
"enum": [
"csv",
"dict",
"sql"
]
},
"rows": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "UnitTestOutputFixture",
"type": "object"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"given": {
"items": {
"additionalProperties": false,
"properties": {
"fixture": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"format": {
"default": "dict",
"enum": [
"csv",
"dict",
"sql"
]
},
"input": {
"type": "string"
},
"rows": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"input"
],
"title": "UnitTestInputFixture",
"type": "object"
},
"type": "array"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"overrides": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"env_vars": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"macros": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"vars": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "UnitTestOverrides",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"unique_id": {
"type": "string"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"versions": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"exclude": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"include": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "UnitTestNodeVersions",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"model",
"given",
"expect",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn"
],
"title": "UnitTestDefinition",
"type": "object"
}
]
},
"type": "array"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "A mapping of the disabled nodes in the target"
},
"docs": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"block_contents": {
"type": "string"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"resource_type": {
"const": "doc"
},
"unique_id": {
"type": "string"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"block_contents"
],
"title": "Documentation",
"type": "object"
},
"description": "The docs defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"exposures": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
}
},
"title": "ExposureConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"maturity": {
"anyOf": [
{
"enum": [
"low",
"medium",
"high"
]
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"owner": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Owner",
"type": "object"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"const": "exposure"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"type",
"owner"
],
"title": "Exposure",
"type": "object"
},
"description": "The exposures defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group_map": {
"anyOf": [
{
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "A mapping from group names to their nodes"
},
"groups": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"owner": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Owner",
"type": "object"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"resource_type": {
"const": "group"
},
"unique_id": {
"type": "string"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"owner"
],
"title": "Group",
"type": "object"
},
"description": "The groups defined in the dbt project",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"macros": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"default": "",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MacroArgument",
"type": "object"
},
"type": "array"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "MacroDependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"macro_sql": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"resource_type": {
"const": "macro"
},
"supported_languages": {
"anyOf": [
{
"items": {
"enum": [
"python",
"sql"
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"unique_id": {
"type": "string"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"macro_sql"
],
"title": "Macro",
"type": "object"
},
"description": "The macros defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metadata": {
"additionalProperties": false,
"description": "Metadata about the manifest",
"properties": {
"adapter_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The type name of the adapter"
},
"dbt_schema_version": {
"type": "string"
},
"dbt_version": {
"default": "1.8.0b3",
"type": "string"
},
"env": {
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"generated_at": {
"type": "string"
},
"invocation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"project_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A unique identifier for the project, hashed from the project name"
},
"project_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the root project"
},
"send_anonymous_usage_stats": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether dbt is configured to send anonymous usage statistics"
},
"user_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A unique identifier for the user"
}
},
"title": "ManifestMetadata",
"type": "object"
},
"metrics": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "MetricConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"type": "string"
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"const": "metric"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"simple",
"ratio",
"cumulative",
"derived",
"conversion"
]
},
"type_params": {
"additionalProperties": false,
"properties": {
"conversion_type_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"base_measure": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"calculation": {
"default": "conversion_rate",
"enum": [
"conversions",
"conversion_rate"
]
},
"constant_properties": {
"anyOf": [
{
"items": {
"additionalProperties": false,
"properties": {
"base_property": {
"type": "string"
},
"conversion_property": {
"type": "string"
}
},
"required": [
"base_property",
"conversion_property"
],
"title": "ConstantPropertyInput",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"conversion_measure": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"entity": {
"type": "string"
},
"window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"base_measure",
"conversion_measure",
"entity"
],
"title": "ConversionTypeParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"grain_to_date": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"input_measures": {
"items": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
"type": "array"
},
"measure": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fill_nulls_with": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"join_to_timespine": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "MetricInputMeasure",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"metrics": {
"anyOf": [
{
"items": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"offset_to_grain": {
"anyOf": [
{
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
{
"type": "null"
}
],
"default": null
},
"offset_window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "MetricInput",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"window": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"type": "integer"
},
"granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
}
},
"required": [
"count",
"granularity"
],
"title": "MetricTimeWindow",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "MetricTypeParams",
"type": "object"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"description",
"label",
"type",
"type_params"
],
"title": "Metric",
"type": "object"
},
"description": "The metrics defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"nodes": {
"additionalProperties": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"delimiter": {
"default": ",",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "seed",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quote_columns": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SeedConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "MacroDependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "seed"
},
"root_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Seed",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "analysis"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Analysis",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enabled": {
"default": true,
"type": "boolean"
},
"error_if": {
"default": "!= 0",
"type": "string"
},
"fail_calc": {
"default": "count(*)",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "test",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "dbt_test__audit"
},
"severity": {
"default": "ERROR",
"pattern": "^([Ww][Aa][Rr][Nn]|[Ee][Rr][Rr][Oo][Rr])$",
"type": "string"
},
"store_failures": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"store_failures_as": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"warn_if": {
"default": "!= 0",
"type": "string"
},
"where": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "test"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "SingularTest",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "operation"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "HookNode",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"access": {
"default": "protected",
"enum": [
"private",
"protected",
"public"
]
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"access": {
"default": "protected",
"enum": [
"private",
"protected",
"public"
]
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "ModelConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ModelLevelConstraint",
"type": "object"
},
"type": "array"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"deprecation_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"latest_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"primary_key": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "model"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "Model",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "sql_operation"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "SqlOperation",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"attached_node": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"column_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enabled": {
"default": true,
"type": "boolean"
},
"error_if": {
"default": "!= 0",
"type": "string"
},
"fail_calc": {
"default": "count(*)",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "test",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "dbt_test__audit"
},
"severity": {
"default": "ERROR",
"pattern": "^([Ww][Aa][Rr][Nn]|[Ee][Rr][Rr][Oo][Rr])$",
"type": "string"
},
"store_failures": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"store_failures_as": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"warn_if": {
"default": "!= 0",
"type": "string"
},
"where": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"file_key_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "test"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"test_metadata": {
"additionalProperties": false,
"properties": {
"kwargs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"default": "test",
"type": "string"
},
"namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "TestMetadata",
"type": "object"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum"
],
"title": "GenericTest",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"_pre_injected_sql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"alias": {
"type": "string"
},
"build_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"checksum": {
"additionalProperties": false,
"properties": {
"checksum": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"checksum"
],
"title": "FileHash",
"type": "object"
},
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"compiled": {
"default": false,
"type": "boolean"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"compiled_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"check_cols": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "snapshot",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"target_database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"target_schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SnapshotConfig",
"type": "object"
},
"config_call_dict": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "Contract",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defer_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"compiled_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"config": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"column_types": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"contract": {
"additionalProperties": false,
"properties": {
"alias_types": {
"default": true,
"type": "boolean"
},
"enforced": {
"default": false,
"type": "boolean"
}
},
"title": "ContractConfig",
"type": "object"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"full_refresh": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"grants": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"incremental_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"materialized": {
"default": "view",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"on_configuration_change": {
"enum": [
"apply",
"continue",
"fail"
]
},
"on_schema_change": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "ignore"
},
"packages": {
"items": {
"type": "string"
},
"type": "array"
},
"persist_docs": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"post-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"pre-hook": {
"items": {
"additionalProperties": false,
"properties": {
"index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"sql": {
"type": "string"
},
"transaction": {
"default": true,
"type": "boolean"
}
},
"required": [
"sql"
],
"title": "Hook",
"type": "object"
},
"type": "array"
},
"quoting": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"unique_key": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NodeConfig",
"type": "object"
},
{
"type": "null"
}
]
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"database",
"schema",
"alias",
"relation_name",
"resource_type",
"name",
"description",
"compiled_code",
"meta",
"tags",
"config"
],
"title": "DeferRelation",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"docs": {
"additionalProperties": false,
"properties": {
"node_color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"show": {
"default": true,
"type": "boolean"
}
},
"title": "Docs",
"type": "object"
},
"extra_ctes": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"id",
"sql"
],
"title": "InjectedCTE",
"type": "object"
},
"type": "array"
},
"extra_ctes_injected": {
"default": false,
"type": "boolean"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"language": {
"default": "sql",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"metrics": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"raw_code": {
"default": "",
"type": "string"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "snapshot"
},
"schema": {
"type": "string"
},
"sources": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"alias",
"checksum",
"config"
],
"title": "Snapshot",
"type": "object"
}
]
},
"description": "The nodes defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"parent_map": {
"anyOf": [
{
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "A mapping from\u00a0child nodes to their dependencies"
},
"saved_queries": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"cache": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"type": "boolean"
}
},
"title": "SavedQueryCache",
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"export_as": {
"anyOf": [
{
"enum": [
"table",
"view"
]
},
{
"type": "null"
}
],
"default": null
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "SavedQueryConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"exports": {
"items": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": false,
"properties": {
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"export_as": {
"enum": [
"table",
"view"
]
},
"schema_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"export_as"
],
"title": "ExportConfig",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"config"
],
"title": "Export",
"type": "object"
},
"type": "array"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"query_params": {
"additionalProperties": false,
"properties": {
"group_by": {
"items": {
"type": "string"
},
"type": "array"
},
"metrics": {
"items": {
"type": "string"
},
"type": "array"
},
"where": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"where_filters": {
"items": {
"additionalProperties": false,
"properties": {
"where_sql_template": {
"type": "string"
}
},
"required": [
"where_sql_template"
],
"title": "WhereFilter",
"type": "object"
},
"type": "array"
}
},
"required": [
"where_filters"
],
"title": "WhereFilterIntersection",
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"metrics",
"group_by",
"where"
],
"title": "QueryParams",
"type": "object"
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"query_params",
"exports"
],
"title": "SavedQuery",
"type": "object"
},
"description": "The saved queries defined in the dbt project",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"selectors": {
"description": "The selectors defined in selectors.yml",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"semantic_models": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "SemanticModelConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"defaults": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"agg_time_dimension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Defaults",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"dimensions": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"is_partition": {
"default": false,
"type": "boolean"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"type": {
"enum": [
"categorical",
"time"
]
},
"type_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"time_granularity": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
"validity_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"is_end": {
"default": false,
"type": "boolean"
},
"is_start": {
"default": false,
"type": "boolean"
}
},
"title": "DimensionValidityParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"time_granularity"
],
"title": "DimensionTypeParams",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"type"
],
"title": "Dimension",
"type": "object"
},
"type": "array"
},
"entities": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"foreign",
"natural",
"primary",
"unique"
]
}
},
"required": [
"name",
"type"
],
"title": "Entity",
"type": "object"
},
"type": "array"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"measures": {
"items": {
"additionalProperties": false,
"properties": {
"agg": {
"enum": [
"sum",
"min",
"max",
"count_distinct",
"sum_boolean",
"average",
"percentile",
"median",
"count"
]
},
"agg_params": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"percentile": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"use_approximate_percentile": {
"default": false,
"type": "boolean"
},
"use_discrete_percentile": {
"default": false,
"type": "boolean"
}
},
"title": "MeasureAggregationParameters",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"agg_time_dimension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"create_metric": {
"default": false,
"type": "boolean"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"expr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"type": "string"
},
"non_additive_dimension": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"window_choice": {
"enum": [
"sum",
"min",
"max",
"count_distinct",
"sum_boolean",
"average",
"percentile",
"median",
"count"
]
},
"window_groupings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"window_choice",
"window_groupings"
],
"title": "NonAdditiveDimension",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"agg"
],
"title": "Measure",
"type": "object"
},
"type": "array"
},
"metadata": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"file_slice": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"end_line_number": {
"type": "integer"
},
"filename": {
"type": "string"
},
"start_line_number": {
"type": "integer"
}
},
"required": [
"filename",
"content",
"start_line_number",
"end_line_number"
],
"title": "FileSlice",
"type": "object"
},
"repo_file_path": {
"type": "string"
}
},
"required": [
"repo_file_path",
"file_slice"
],
"title": "SourceFileMetadata",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"node_relation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alias": {
"type": "string"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": ""
},
"schema_name": {
"type": "string"
}
},
"required": [
"alias",
"schema_name"
],
"title": "NodeRelation",
"type": "object"
},
{
"type": "null"
}
]
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"primary_entity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"refs": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"package": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "RefArgs",
"type": "object"
},
"type": "array"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"model",
"node_relation"
],
"title": "SemanticModel",
"type": "object"
},
"description": "The semantic models defined in the dbt project",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"sources": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"columns": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"constraints": {
"items": {
"additionalProperties": false,
"properties": {
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"enum": [
"check",
"not_null",
"unique",
"primary_key",
"foreign_key",
"custom"
]
},
"warn_unenforced": {
"default": true,
"type": "boolean"
},
"warn_unsupported": {
"default": true,
"type": "boolean"
}
},
"required": [
"type"
],
"title": "ColumnLevelConstraint",
"type": "object"
},
"type": "array"
},
"data_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"quote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ColumnInfo",
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"enabled": {
"default": true,
"type": "boolean"
}
},
"title": "SourceConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"database": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"default": "",
"type": "string"
},
"external": {
"anyOf": [
{
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"file_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"partitions": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"data_type": {
"default": "",
"type": "string"
},
"description": {
"default": "",
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"default": "",
"type": "string"
}
},
"title": "ExternalPartition",
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"row_format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"tbl_properties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "ExternalTable",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"freshness": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"error_after": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"period": {
"anyOf": [
{
"enum": [
"minute",
"hour",
"day"
]
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Time",
"type": "object"
},
{
"type": "null"
}
]
},
"filter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"warn_after": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"period": {
"anyOf": [
{
"enum": [
"minute",
"hour",
"day"
]
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Time",
"type": "object"
},
{
"type": "null"
}
]
}
},
"title": "FreshnessThreshold",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"identifier": {
"type": "string"
},
"loaded_at_field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"loader": {
"type": "string"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"package_name": {
"type": "string"
},
"patch_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"type": "string"
},
"quoting": {
"additionalProperties": false,
"properties": {
"column": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"database": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"identifier": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Quoting",
"type": "object"
},
"relation_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"resource_type": {
"const": "source"
},
"schema": {
"type": "string"
},
"source_description": {
"type": "string"
},
"source_meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"source_name": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"unique_id": {
"type": "string"
},
"unrendered_config": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"database",
"schema",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn",
"source_name",
"source_description",
"loader",
"identifier"
],
"title": "SourceDefinition",
"type": "object"
},
"description": "The sources defined in the dbt project and its dependencies",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"unit_tests": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"checksum": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"config": {
"additionalProperties": true,
"properties": {
"_extra": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"meta": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"tags": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"title": "UnitTestConfig",
"type": "object"
},
"created_at": {
"type": "number"
},
"depends_on": {
"additionalProperties": false,
"properties": {
"macros": {
"items": {
"type": "string"
},
"type": "array"
},
"nodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "DependsOn",
"type": "object"
},
"description": {
"default": "",
"type": "string"
},
"expect": {
"additionalProperties": false,
"properties": {
"fixture": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"format": {
"default": "dict",
"enum": [
"csv",
"dict",
"sql"
]
},
"rows": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "UnitTestOutputFixture",
"type": "object"
},
"fqn": {
"items": {
"type": "string"
},
"type": "array"
},
"given": {
"items": {
"additionalProperties": false,
"properties": {
"fixture": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"format": {
"default": "dict",
"enum": [
"csv",
"dict",
"sql"
]
},
"input": {
"type": "string"
},
"rows": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"input"
],
"title": "UnitTestInputFixture",
"type": "object"
},
"type": "array"
},
"model": {
"type": "string"
},
"name": {
"type": "string"
},
"original_file_path": {
"type": "string"
},
"overrides": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"env_vars": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"macros": {
"propertyNames": {
"type": "string"
},
"type": "object"
},
"vars": {
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"title": "UnitTestOverrides",
"type": "object"
},
{
"type": "null"
}
],
"default": null
},
"package_name": {
"type": "string"
},
"path": {
"type": "string"
},
"resource_type": {
"enum": [
"model",
"analysis",
"test",
"snapshot",
"operation",
"seed",
"rpc",
"sql_operation",
"doc",
"source",
"macro",
"exposure",
"metric",
"group",
"saved_query",
"semantic_model",
"unit_test",
"fixture"
]
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"unique_id": {
"type": "string"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null
},
"versions": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"exclude": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"include": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "UnitTestNodeVersions",
"type": "object"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"model",
"given",
"expect",
"name",
"resource_type",
"package_name",
"path",
"original_file_path",
"unique_id",
"fqn"
],
"title": "UnitTestDefinition",
"type": "object"
},
"description": "The unit tests defined in the project",
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"metadata",
"nodes",
"sources",
"macros",
"docs",
"exposures",
"metrics",
"groups",
"selectors",
"disabled",
"parent_map",
"child_map",
"group_map",
"saved_queries",
"semantic_models",
"unit_tests"
],
"title": "WritableManifest",
"type": "object"
} | Apache-2.0 | en |
OriginCode/dotfiles | 8bcd6ec23464359dddd444c996a823728eed2e64 | 2024-05-20T07:19:25 | fastfetch/.config/fastfetch/json_schema.json | 6 | 2024-05-29T11:55:22.977331Z | {
"$defs": {
"colors": {
"enum": [
"reset_",
"bright_",
"dim_",
"italic_",
"underline_",
"blink_",
"inverse_",
"hidden_",
"strike_",
"light_",
"black",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"default"
],
"type": "string"
},
"format": {
"description": "Output format of the module",
"type": "string"
},
"key": {
"description": "Key of the module",
"type": "string"
},
"keyColor": {
"$ref": "#/$defs/colors",
"description": "Color of the module key. Left empty to use `display.color.keys`"
},
"keyWidth": {
"default": 0,
"description": "Width of the module key. Use 0 to use `display.keyWidth`",
"minimum": 0,
"type": "integer"
},
"outputColor": {
"$ref": "#/$defs/colors",
"description": "Output color of the module. Left empty to use `display.color.output`"
},
"percent": {
"additionalProperties": false,
"description": "Threshold of percentage colors",
"properties": {
"green": {
"description": "Value less then green will be shown in green",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"yellow": {
"description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"temperature": {
"description": "Detect and display temperature if supported",
"oneOf": [
{
"default": false,
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"green": {
"description": "Value (in celsius) less then green will be shown in green",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"yellow": {
"description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
]
}
},
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`",
"properties": {
"$schema": {
"default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json",
"description": "JSON schema URL, for JSON validation and IDE intelligence",
"format": "uri",
"type": "string"
},
"display": {
"additionalProperties": false,
"description": "Configure how things to be displayed",
"properties": {
"bar": {
"additionalProperties": false,
"description": "Set the bar configuration",
"properties": {
"border": {
"default": true,
"description": "Whether to show a border around the bar",
"type": "boolean"
},
"charElapsed": {
"default": "\u25a0",
"description": "Set the character to use in elapsed part",
"type": "string"
},
"charTotal": {
"default": "-",
"description": "Set the character to use in total part",
"type": "string"
},
"width": {
"default": 10,
"description": "Set the width of the bar, in number of characters",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"binaryPrefix": {
"description": "Set the binary prefix to used when printing bytes",
"oneOf": [
{
"const": "iec",
"description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)"
},
{
"const": "si",
"description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..."
},
{
"const": "jedec",
"description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..."
}
],
"type": "string"
},
"brightColor": {
"default": true,
"description": "Set if the keys, title and ASCII logo should be printed in bright color",
"type": "boolean"
},
"color": {
"description": "Set the color of the keys and title",
"oneOf": [
{
"$ref": "#/$defs/colors",
"description": "Set the both color of the keys and title"
},
{
"additionalProperties": false,
"properties": {
"keys": {
"$ref": "#/$defs/colors",
"description": "Set the color of the keys"
},
"output": {
"$ref": "#/$defs/colors",
"description": "Set the color of the module output"
},
"title": {
"$ref": "#/$defs/colors",
"description": "Set the color of the title"
}
},
"type": "object"
}
]
},
"disableLinewrap": {
"default": true,
"description": "Whether to disable line wrap during the run",
"type": "boolean"
},
"hideCursor": {
"default": true,
"description": "Whether to hide the cursor during the run",
"type": "boolean"
},
"keyWidth": {
"default": 0,
"description": "Align the width of keys to number of characters, 0 to disable",
"minimum": 0,
"type": "integer"
},
"noBuffer": {
"default": false,
"description": "Whether to disable the stdout application buffer",
"type": "boolean"
},
"percent": {
"additionalProperties": false,
"description": "Set how a percentage value should be displayed",
"properties": {
"color": {
"additionalProperties": false,
"description": "Set color used in different states of percentage bars and numbers",
"properties": {
"green": {
"$ref": "#/$defs/colors",
"description": "Color used in green state"
},
"red": {
"$ref": "#/$defs/colors",
"description": "Color used in red state"
},
"yellow": {
"$ref": "#/$defs/colors",
"description": "Color used in yellow state"
}
},
"type": "object"
},
"ndigits": {
"default": 0,
"description": "Set the number of digits to keep after the decimal point when formatting percentage numbers",
"maximum": 9,
"minimum": 0,
"type": "number"
},
"type": {
"default": 9,
"description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number",
"maximum": 255,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"pipe": {
"default": false,
"description": "Whether to enable pipe mode (disable logo and all escape sequences)",
"type": "boolean"
},
"separator": {
"default": ": ",
"description": "Set the separator between key and value",
"type": "string"
},
"showErrors": {
"default": false,
"description": "Print occurring errors to the console. False to ignore errored modules",
"type": "boolean"
},
"size": {
"additionalProperties": false,
"description": "Set how a size value should be displayed",
"properties": {
"maxPrefix": {
"default": "YB",
"description": "Set the largest binary prefix to use when formatting sizes",
"enum": [
"B",
"kB",
"MB",
"GB",
"TB",
"PB",
"EB",
"ZB",
"YB"
],
"type": "string"
},
"ndigits": {
"default": 2,
"description": "Set the number of digits to keep after the decimal point when formatting sizes",
"maximum": 9,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"stat": {
"default": false,
"description": "Show time usage (in ms) for individual modules",
"type": "boolean"
},
"temp": {
"additionalProperties": false,
"description": "Set how temperature values should be displayed",
"properties": {
"color": {
"additionalProperties": false,
"description": "Set color used in different states of temperature values",
"properties": {
"green": {
"$ref": "#/$defs/colors",
"description": "Color used in green state"
},
"red": {
"$ref": "#/$defs/colors",
"description": "Color used in red state"
},
"yellow": {
"$ref": "#/$defs/colors",
"description": "Color used in yellow state"
}
},
"type": "object"
},
"ndigits": {
"default": 1,
"description": "Set the number of digits to keep after the decimal point when formatting temperature values",
"maximum": 9,
"minimum": 0,
"type": "integer"
},
"unit": {
"default": "C",
"description": "Set the unit of the temperature",
"enum": [
"CELSIUS",
"C",
"FAHRENHEIT",
"F",
"KELVIN",
"K"
],
"type": "string"
}
},
"type": "object"
},
"tsVersion": {
"default": true,
"description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking",
"type": "boolean"
}
},
"type": "object"
},
"general": {
"additionalProperties": false,
"description": "Fastfetch general configurations",
"properties": {
"dsForceDrm": {
"default": false,
"description": "Force display detection to use DRM. Linux only",
"oneOf": [
{
"const": false,
"description": "Try `wayland`, then `x11`, then `drm`",
"type": "boolean"
},
{
"const": "sysfs-only",
"description": "Use `/sys/class/drm` only.",
"type": "string"
},
{
"const": true,
"description": "Try `libdrm` first, then `sysfs` if libdrm failed",
"type": "boolean"
}
]
},
"escapeBedrock": {
"default": true,
"description": "On Bedrock Linux, whether to escape the bedrock jail",
"type": "boolean"
},
"multithreading": {
"default": true,
"description": "Use multiple threads to detect values",
"type": "boolean"
},
"playerName": {
"description": "The name of the player to use for module Media and Player. Linux only",
"type": "string"
},
"processingTimeout": {
"default": 1000,
"description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout",
"type": "integer"
},
"thread": {
"default": true,
"description": "Alias of multithreading",
"type": "boolean"
},
"wmiTimeout": {
"default": 5000,
"description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only",
"type": "integer"
}
},
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Set the path of a library to load",
"properties": {
"chafa": {
"description": "Image output as ascii art (Linux, FreeBSD, macOS)",
"type": "string"
},
"dbus": {
"description": "Bluetooth, Player & Media detection (Linux, FreeBSD)",
"type": "string"
},
"dconf": {
"description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)",
"type": "string"
},
"ddcutil": {
"description": "Used for brightness detection of external displays (Linux)",
"type": "string"
},
"drm": {
"description": "Used for fast resolution and refresh rate detection (Linux)",
"type": "string"
},
"egl": {
"description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)",
"type": "string"
},
"freetype": {
"description": "Used for Termux font detection (Android)",
"type": "string"
},
"gio": {
"description": "Needed for values that are only stored GSettings (Linux, FreeBSD)",
"type": "string"
},
"glx": {
"description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)",
"type": "string"
},
"imagemagick": {
"description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)",
"type": "string"
},
"nm": {
"description": "NetworkManager. Used for Wifi detection (Linux)",
"type": "string"
},
"opencl": {
"description": "OpenCL module (Linux, FreeBSD, Windows)",
"type": "string"
},
"osmesa": {
"description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)",
"type": "string"
},
"pci": {
"description": "GPU output (Linux and FreeBSD)",
"type": "string"
},
"pulse": {
"description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)",
"type": "string"
},
"rpm": {
"description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)",
"type": "string"
},
"sqlite3": {
"description": "Needed for pkg & rpm package count (Linux, FreeBSD)",
"type": "string"
},
"vulkan": {
"description": "Vulkan module & fallback for GPU output",
"type": "string"
},
"wayland": {
"description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)",
"type": "string"
},
"x11": {
"description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)",
"type": "string"
},
"xcb": {
"description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)",
"type": "string"
},
"xcbRandr": {
"description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)",
"type": "string"
},
"xfconf": {
"description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)",
"type": "string"
},
"xrandr": {
"description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)",
"type": "string"
},
"z": {
"description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)",
"type": "string"
}
},
"type": "object"
},
"logo": {
"oneOf": [
{
"description": "Disable logo",
"type": "null"
},
{
"description": "Set the source file of the logo",
"type": "string"
},
{
"additionalProperties": false,
"description": "Fastfetch logo configurations",
"properties": {
"chafa": {
"additionalProperties": false,
"description": "Chafa configuration. See chafa document for details",
"properties": {
"canvasMode": {
"description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.",
"enum": [
"TRUECOLOR",
"INDEXED_256",
"INDEXED_240",
"INDEXED_16",
"FGBG_BGFG",
"FGBG",
"INDEXED_8",
"INDEXED_16_8"
],
"type": "string"
},
"colorSpace": {
"description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.",
"enum": [
"RGB",
"DIN99D"
],
"type": "string"
},
"ditherMode": {
"description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.",
"enum": [
"NONE",
"ORDERED",
"DIFFUSION"
],
"type": "string"
},
"fgOnly": {
"default": false,
"description": "Produce character-cell output using foreground colors only",
"type": "boolean"
},
"symbols": {
"description": "Specify character symbols to employ in final output",
"type": "string"
}
},
"type": "object"
},
"color": {
"additionalProperties": false,
"description": "Overwrite a color in the logo",
"properties": {
"1": {
"$ref": "#/$defs/colors",
"description": "Color 1"
},
"2": {
"$ref": "#/$defs/colors",
"description": "Color 2"
},
"3": {
"$ref": "#/$defs/colors",
"description": "Color 3"
},
"4": {
"$ref": "#/$defs/colors",
"description": "Color 4"
},
"5": {
"$ref": "#/$defs/colors",
"description": "Color 5"
},
"6": {
"$ref": "#/$defs/colors",
"description": "Color 6"
},
"7": {
"$ref": "#/$defs/colors",
"description": "Color 7"
},
"8": {
"$ref": "#/$defs/colors",
"description": "Color 8"
},
"9": {
"$ref": "#/$defs/colors",
"description": "Color 9"
}
},
"type": "object"
},
"height": {
"description": "Set the height of the logo (in characters). Required for iTerm image protocol",
"minimum": 1,
"type": "integer"
},
"padding": {
"additionalProperties": false,
"description": "Set the padding of the logo",
"properties": {
"left": {
"description": "Set the left padding of the logo",
"minimum": 0,
"type": "integer"
},
"right": {
"description": "Set the right padding of the logo",
"minimum": 0,
"type": "integer"
},
"top": {
"description": "Set the top padding of the logo",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"preserveAspectRatio": {
"default": false,
"description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol",
"type": "boolean"
},
"printRemaining": {
"default": false,
"description": "Whether to print the remaining logo, if it has more lines than modules to display",
"type": "boolean"
},
"recache": {
"default": false,
"description": "If true, regenerate image logo cache",
"type": "boolean"
},
"separate": {
"default": false,
"description": "If true, print modules at bottom of the logo",
"type": "boolean"
},
"source": {
"description": "Set the source file of the logo",
"type": "string"
},
"type": {
"default": "auto",
"description": "Set the type of the logo given",
"enum": [
"auto",
"builtin",
"small",
"file",
"file-raw",
"data",
"data-raw",
"sixel",
"kitty",
"kitty-direct",
"iterm",
"chafa",
"raw",
"none"
]
},
"width": {
"description": "Set the width of the logo (in characters). Required for iTerm image protocol",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
}
]
},
"modules": {
"description": "Fastfetch modules to run",
"items": {
"anyOf": [
{
"description": "Run module with default configurations",
"enum": [
"battery",
"bios",
"bluetooth",
"board",
"break",
"brightness",
"camera",
"chassis",
"cpu",
"cpuusage",
"command",
"colors",
"cursor",
"datetime",
"display",
"disk",
"diskio",
"de",
"font",
"gamepad",
"gpu",
"host",
"icons",
"kernel",
"lm",
"loadavg",
"locale",
"localip",
"media",
"memory",
"monitor",
"netio",
"opencl",
"opengl",
"os",
"packages",
"physicaldisk",
"player",
"poweradapter",
"processes",
"publicip",
"separator",
"shell",
"sound",
"swap",
"terminal",
"terminalfont",
"terminalsize",
"terminaltheme",
"title",
"theme",
"uptime",
"users",
"version",
"vulkan",
"wallpaper",
"weather",
"wm",
"wifi",
"wmtheme"
],
"type": "string"
},
{
"description": "Run module with custom configurations",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"const": "break",
"description": "Print a empty line"
}
},
"title": "Break",
"type": "object"
},
{
"additionalProperties": false,
"description": "No additional properties",
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"anyOf": [
{
"const": "bios",
"description": "Print BIOS name, version, release date, etc"
},
{
"const": "board",
"description": "Print mather board name and other info"
},
{
"const": "camera",
"description": "Print available cameras"
},
{
"const": "cursor",
"description": "Print cursor style name"
},
{
"const": "datetime",
"description": "Print current date and time"
},
{
"const": "font",
"description": "Print system font name"
},
{
"const": "host",
"description": "Print product name of your computer"
},
{
"const": "icons",
"description": "Print icon style name"
},
{
"const": "kernel",
"description": "Print system kernel version"
},
{
"const": "lm",
"description": "Print login manager (desktop manager) name and version"
},
{
"const": "locale",
"description": "Print system locale name"
},
{
"const": "media",
"description": "Print playing song name"
},
{
"const": "monitor",
"description": "Print connected physical monitor information"
},
{
"const": "opencl",
"description": "Print highest OpenCL version supported by the GPU"
},
{
"const": "os",
"description": "Print operating system name and version"
},
{
"const": "player",
"description": "Print music player name"
},
{
"const": "poweradapter",
"description": "Print power adapter name and charging watts"
},
{
"const": "processes",
"description": "Count running processes"
},
{
"const": "shell",
"description": "Print current shell name and version"
},
{
"const": "terminal",
"description": "Print current terminal name and version"
},
{
"const": "terminalfont",
"description": "Print font name and size used by current terminal"
},
{
"const": "terminalsize",
"description": "Print current terminal size"
},
{
"const": "terminaltheme",
"description": "Print current terminal theme (foreground and background colors)"
},
{
"const": "theme",
"description": "Print current theme of desktop environment"
},
{
"const": "uptime",
"description": "Print how long system has been running"
},
{
"const": "users",
"description": "Print users currently logged in"
},
{
"const": "version",
"description": "Print Fastfetch version"
},
{
"const": "vulkan",
"description": "Print highest Vulkan version supported by the GPU"
},
{
"const": "wallpaper",
"description": "Print image file path of current wallpaper"
},
{
"const": "wifi",
"description": "Print connected Wi-Fi info (SSID, connection and security protocol)"
},
{
"const": "wmtheme",
"description": "Print current theme of window manager"
}
]
}
},
"title": "module",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"temp": {
"$ref": "#/$defs/temperature"
},
"type": {
"const": "battery",
"description": "Print battery capacity, status, etc"
},
"useSetupApi": {
"default": false,
"description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only",
"type": "boolean"
}
},
"title": "Battery",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"showDisconnected": {
"default": false,
"description": "Set if disconnected bluetooth devices should be printed",
"type": "boolean"
},
"type": {
"const": "bluetooth",
"description": "List bluetooth devices"
}
},
"title": "Bluetooth",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"ddcciSleep": {
"default": 10,
"description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail",
"maximum": 400,
"minimum": 0,
"type": "integer"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"type": {
"const": "brightness",
"description": "Print current brightness level of your monitors"
}
},
"title": "Brightness",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "chassis",
"description": "Print chassis type (desktop, laptop, etc)"
}
},
"title": "Chassis",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"freqNdigits": {
"default": 2,
"description": "Set the number of digits to keep after the decimal point when printing CPU frequency",
"maximum": 9,
"minimum": 0,
"type": "integer"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"temp": {
"$ref": "#/$defs/temperature"
},
"type": {
"const": "cpu",
"description": "Print CPU name, frequency, etc"
}
},
"title": "CPU",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"percent": {
"$ref": "#/$defs/percent"
},
"separate": {
"default": false,
"description": "Display CPU usage per CPU logical core, instead of an average result",
"type": "boolean"
},
"type": {
"const": "cpuusage",
"description": "Print CPU usage. Costs some time to collect data"
}
},
"title": "CPU Usage",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"block": {
"additionalProperties": false,
"description": "Set behavior of block printing",
"properties": {
"range": {
"description": "Set the range of colors in the blocks to print",
"items": {
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"width": {
"default": 3,
"description": "Set the block width in spaces",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"key": {
"$ref": "#/$defs/key"
},
"paddingLeft": {
"default": 0,
"description": "Set the number of white spaces to print before the symbol",
"minimum": 0,
"type": "integer"
},
"symbol": {
"default": "block",
"description": "Set the symbol to use",
"enum": [
"block",
"circle",
"diamond",
"triangle",
"square",
"star"
],
"type": "string"
},
"type": {
"const": "colors",
"description": "Print some colored blocks"
}
},
"title": "Colors",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"shell": {
"description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix",
"type": "string"
},
"text": {
"description": "Set the command text to be executed",
"type": "string"
},
"type": {
"const": "command",
"description": "Running custom shell scripts"
}
},
"title": "Command",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"description": "Text to print",
"type": "string"
},
"key": {
"description": "Leave empty not to print the key",
"type": "string"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "custom",
"description": "Print a custom string, with or without key"
}
},
"title": "Custom",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"compactType": {
"default": "none",
"description": "Set if all displays should be printed in one line",
"enum": [
"none",
"original",
"scaled",
"original-with-refresh-rate",
"scaled-with-refresh-rate"
]
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"order": {
"default": "none",
"description": "Set the order should be used when printing",
"enum": [
"none",
"asc",
"desc"
]
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"preciseRefreshRate": {
"default": false,
"description": "Set if decimal refresh rates should not be rounded into integers when printing",
"type": "boolean"
},
"type": {
"const": "display",
"description": "Print resolutions, refresh rates, etc"
}
},
"title": "Display",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"folders": {
"description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options",
"type": "string"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"showExternal": {
"default": true,
"description": "Set if external volume should be printed",
"type": "boolean"
},
"showHidden": {
"default": false,
"description": "Set if hidden volumes should be printed",
"type": "boolean"
},
"showReadOnly": {
"default": false,
"description": "Set if read only volumes should be printed",
"type": "boolean"
},
"showSubvolumes": {
"default": false,
"description": "Set if subvolumes should be printed",
"type": "boolean"
},
"showUnknown": {
"default": false,
"description": "Set if unknown (unable to detect sizes) volumes should be printed",
"type": "boolean"
},
"type": {
"const": "disk",
"description": "Print partitions, space usage, disk type, etc"
},
"useAvailable": {
"default": false,
"description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes",
"type": "boolean"
}
},
"title": "Disk",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"detectTotal": {
"default": false,
"description": "Detect total bytes instead of current rate",
"type": "boolean"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"namePrefix": {
"description": "Show disks with given name prefix only",
"type": "string"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "diskio",
"description": "Print physical disk I/O throughput"
}
},
"title": "DiskIO",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"slowVersionDetection": {
"default": "false",
"description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.",
"type": "boolean"
},
"type": {
"const": "de",
"description": "Print desktop environment name"
}
},
"title": "DE",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"type": {
"const": "gamepad",
"description": "List connected gamepads"
}
},
"title": "Gamepad",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"driverSpecific": {
"default": false,
"description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)",
"type": "boolean"
},
"forceVulkan": {
"default": false,
"description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`",
"type": "boolean"
},
"format": {
"$ref": "#/$defs/format"
},
"hideType": {
"default": "none",
"description": "Specify the type of GPUs should not be printed",
"enum": [
"integrated",
"discrete",
"none"
]
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"temp": {
"$ref": "#/$defs/temperature"
},
"type": {
"const": "gpu",
"description": "Print GPU names, graphic memory size, type, etc"
}
},
"title": "GPU",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"compact": {
"default": false,
"description": "Show all IPs in one line",
"type": "boolean"
},
"defaultRouteOnly": {
"default": true,
"description": "Show ips that are used for default routing only",
"type": "boolean"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"namePrefix": {
"description": "Show IPs with given name prefix only",
"type": "string"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"showIpv4": {
"default": true,
"description": "Show IPv4 addresses",
"type": "boolean"
},
"showIpv6": {
"default": false,
"description": "Show IPv6 addresses",
"type": "boolean"
},
"showLoop": {
"default": false,
"description": "Show loop back addresses (127.0.0.1)",
"type": "boolean"
},
"showMac": {
"default": false,
"description": "Show MAC addresses",
"type": "boolean"
},
"showPrefixLen": {
"default": true,
"description": "Show network prefix length (/N)",
"type": "boolean"
},
"type": {
"const": "localip",
"description": "List local IP addresses (v4 or v6), MAC addresses, etc"
}
},
"title": "Local IP",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"type": {
"const": "memory",
"description": "Print system memory usage info"
}
},
"title": "Memory",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"ndigits": {
"default": 2,
"description": "Set the number of digits to keep after the decimal point",
"maximum": 9,
"minimum": 0,
"type": "integer"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "loadavg",
"description": "Print system load averages"
}
},
"title": "Loadavg",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"defaultRouteOnly": {
"default": true,
"description": "Show ips that are used for default routing only",
"type": "boolean"
},
"detectTotal": {
"default": false,
"description": "Detect total bytes instead of current rate",
"type": "boolean"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"namePrefix": {
"description": "Show IPs with given name prefix only",
"type": "string"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "netio",
"description": "Print network I/O throughput"
}
},
"title": "NetIO",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"library": {
"default": "auto",
"description": "Set the OpenGL context creation library to use. Linux only",
"enum": [
"auto",
"egl",
"glx",
"osmesa"
]
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "opengl",
"description": "Print highest OpenGL version supported by the GPU"
}
},
"title": "OpenGL",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"default": [
"winget"
],
"description": "List of package managers to be disabled when detecting",
"items": {
"enum": [
"am",
"apk",
"brew",
"choco",
"dpkg",
"emerge",
"eopkg",
"flatpak",
"macports",
"nix",
"opkg",
"pacman",
"paludis",
"pkg",
"pkgtool",
"rpm",
"scoop",
"snap",
"winget",
"xbps"
],
"type": "string",
"uniqueItems": true
},
"type": "array"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "packages",
"description": "List installed package managers and count of installed packages"
}
},
"title": "Packages",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"namePrefix": {
"description": "Show disks with given name prefix only",
"type": "string"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"temp": {
"$ref": "#/$defs/temperature"
},
"type": {
"const": "physicaldisk",
"description": "Print physical disk information"
}
},
"title": "Physical Disk",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"ipv6": {
"default": false,
"description": "Whether to use IPv6 for public IP detection server",
"type": "boolean"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"timeout": {
"default": "disabled (0)",
"description": "Time in milliseconds to wait for the public ip server to respond",
"minimum": 0,
"type": "integer"
},
"type": {
"const": "publicip",
"description": "Print your public IP address, etc"
},
"url": {
"default": "http://ipinfo.io/ip",
"description": "The URL of public IP detection server to be used. Only HTTP protocol is supported",
"format": "url",
"type": "string"
}
},
"title": "Public IP",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"string": {
"default": "-",
"description": "Set the string to be printed",
"type": "string"
},
"type": {
"const": "separator",
"description": "Print a separator line"
}
},
"title": "Separator",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"soundType": {
"default": "main",
"description": "Set what type of sound devices should be printed",
"enum": [
"main",
"active",
"all"
],
"type": "string"
},
"type": {
"const": "sound",
"description": "Print sound devices, volume, etc"
}
},
"title": "Sound",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"percent": {
"$ref": "#/$defs/percent"
},
"type": {
"const": "swap",
"description": "Print swap (paging file) space usage"
}
},
"title": "Swap",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"color": {
"additionalProperties": false,
"description": "Set colors of the different part of title",
"properties": {
"at": {
"$ref": "#/$defs/colors",
"description": "Set color of the @ symbol (middle part)"
},
"host": {
"$ref": "#/$defs/colors",
"description": "Set color of the host name (right part)"
},
"user": {
"$ref": "#/$defs/colors",
"description": "Set color of the user name (left part)"
}
},
"type": "object"
},
"format": {
"$ref": "#/$defs/format"
},
"fqdn": {
"default": false,
"description": "Set if the title should use fully qualified domain name",
"type": "boolean"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "title",
"description": "Print title, which contains your user name, hostname"
}
},
"title": "Title",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"location": {
"description": "The location to display",
"type": "string"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"outputFormat": {
"default": "%t+-+%C+(%l)",
"description": "The output weather format to be used (must be URI encoded)",
"type": "string"
},
"timeout": {
"default": "disabled (0)",
"description": "Time in milliseconds to wait for the weather server to respond",
"minimum": 0,
"type": "integer"
},
"type": {
"const": "weather",
"description": "Print weather information"
}
},
"title": "Weather",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"detectPlugin": {
"default": false,
"description": "Set if window manager plugin should be detected on supported platforms",
"type": "boolean"
},
"format": {
"$ref": "#/$defs/format"
},
"key": {
"$ref": "#/$defs/key"
},
"keyColor": {
"$ref": "#/$defs/keyColor"
},
"keyWidth": {
"$ref": "#/$defs/keyWidth"
},
"outputColor": {
"$ref": "#/$defs/outputColor"
},
"type": {
"const": "wm",
"description": "Print window manager name and version"
}
},
"title": "WM",
"type": "object"
}
],
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array"
}
},
"title": "JSON config",
"type": "object"
} | WTFPL | en |
UUDigitalHumanitieslab/I-analyzer | d26c99e10bc5fbb96850c551d7a5448a34245d04 | 2024-03-08T12:07:16 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"$ref": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/field.schema.json"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"description": "default sort settings for search results",
"properties": {
"ascending": {
"type": "boolean"
},
"field": {
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"description": "when showing document context, sort them like this",
"properties": {
"ascending": {
"type": "boolean"
},
"field": {
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | d7a3ae6d0477bcb28859dca04f006a33862f2413 | 2024-04-11T16:56:21 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "Describes how to sort search results",
"properties": {
"ascending": {
"description": "whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "name of on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "longer description for users",
"type": "string"
},
"display_name": {
"description": "human-friendly name",
"type": "string"
},
"extract": {
"description": "how to extract this field's value from source files",
"properties": {
"column": {
"description": "name of the column in CSV source files",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "search filter for the field",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_json"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "default sort settings for search results"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "when showing document context, sort them like this"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"description": "information about the source data files",
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | c1f40c9d375a4694939ddcb087c167a7d1d9e45a | 2024-05-15T12:55:07 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "How to sort search results",
"properties": {
"ascending": {
"description": "Whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "Name of the field on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a corpus in I-analyzer",
"properties": {
"fields": {
"description": "List of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "Longer description for users",
"type": "string"
},
"display_name": {
"description": "Human-friendly name",
"type": "string"
},
"extract": {
"description": "How to extract this field's value from source files",
"properties": {
"column": {
"description": "Name of the column in CSV source files",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "Language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "Internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "Whether users can filter results based on this field, and if the filter widget is shown by default",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "Whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "Whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "Whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "Whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "Whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"description": "The type of data",
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_json"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "Nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "The date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content. List as most to least frequent.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "Default sort settings for search results"
},
"document_context": {
"description": "Description of how documents can be grouped",
"properties": {
"context_fields": {
"description": "The fields to group by",
"items": {
"description": "Name of the field",
"type": "string"
},
"type": "array"
},
"display_name": {
"description": "Display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "How documents within a group should be sorted"
}
},
"required": [
"context_fields",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "Name of the field that contains the IETF tag of each document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"description": "Information about the source data files",
"properties": {
"options": {
"description": "Additional options for source files",
"properties": {
"delimiter": {
"description": "Delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "Data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | 8e54aa40ae43679a19a0262ced90d288ff07238c | 2024-04-16T14:32:27 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "Describes how to sort search results",
"properties": {
"ascending": {
"description": "whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "name of on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "longer description for users",
"type": "string"
},
"display_name": {
"description": "human-friendly name",
"type": "string"
},
"extract": {
"description": "how to extract this field's value from source files",
"properties": {
"column": {
"description": "name of the column in CSV source files",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "search filter for the field",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_point"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "default sort settings for search results"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "when showing document context, sort them like this"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"description": "information about the source data files",
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | e88a5a2e923c2445c39181dba2d31228756e871a | 2024-05-16T14:43:01 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "How to sort search results",
"properties": {
"ascending": {
"description": "Whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "Name of the field on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a corpus in I-analyzer",
"properties": {
"fields": {
"description": "List of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "Longer description for users",
"type": "string"
},
"display_name": {
"description": "Human-friendly name",
"type": "string"
},
"extract": {
"description": "How to extract this field's value from source files",
"properties": {
"column": {
"description": "Name of the column in CSV source files",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "Language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "Internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "Whether users can filter results based on this field, and if the filter widget is shown by default",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "Whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "Whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "Whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "Whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "Whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"description": "The type of data",
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_point"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "Nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "The date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content. List as most to least frequent.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "Default sort settings for search results"
},
"document_context": {
"description": "Description of how documents can be grouped",
"properties": {
"context_fields": {
"description": "The fields to group by",
"items": {
"description": "Name of the field",
"type": "string"
},
"type": "array"
},
"display_name": {
"description": "Display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "How documents within a group should be sorted"
}
},
"required": [
"context_fields",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "Name of the field that contains the IETF tag of each document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"description": "Information about the source data files",
"properties": {
"options": {
"description": "Additional options for source files",
"properties": {
"delimiter": {
"description": "Delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "Data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | bfec271390b0771c85ef605823f35161a29b74b0 | 2024-04-10T13:48:47 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "Describes how to sort search results",
"properties": {
"ascending": {
"description": "whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "name of on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "longer description for users",
"type": "string"
},
"display_name": {
"description": "human-friendly name",
"type": "string"
},
"extract": {
"description": "how to extract this field's value from source files",
"properties": {
"column": {
"description": "name of the column in the CSV file",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "search filter for the field",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_json"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "default sort settings for search results"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "when showing document context, sort them like this"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"description": "information about the source data files",
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | 57fbd33f4371a066765dfc09997dd178f0a35ae7 | 2024-03-08T12:25:33 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"description": "Describes how to sort search results",
"properties": {
"ascending": {
"description": "whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "name of on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"description": "A field in a corpus",
"properties": {
"description": {
"description": "longer description for users",
"type": "string"
},
"display_name": {
"description": "human-friendly name",
"type": "string"
},
"extract": {
"description": "how to extract this field's value from source files",
"properties": {
"column": {
"description": "name of the column in the CSV file",
"type": "string"
}
},
"required": [
"column"
],
"type": "object"
},
"language": {
"description": "language of the field's content. Either an IETF tag, or \"dynamic\".",
"type": "string"
},
"name": {
"description": "internal name",
"type": "string"
},
"options": {
"properties": {
"filter": {
"description": "search filter for the field",
"enum": [
"show",
"hide",
"none"
],
"type": "string"
},
"hidden": {
"description": "whether the field is hidden from the interface",
"type": "boolean"
},
"preview": {
"description": "whether the field is included in the preview of a document",
"type": "boolean"
},
"search": {
"description": "whether the field supports full-text search",
"type": "boolean"
},
"sort": {
"description": "whether search results can be sorted on this field",
"type": "boolean"
},
"visualize": {
"description": "whether the field is visualised",
"type": "boolean"
}
},
"required": [
"search",
"filter",
"preview",
"visualize",
"sort",
"hidden"
],
"type": "object"
},
"type": {
"enum": [
"text_content",
"text_metadata",
"url",
"integer",
"float",
"date",
"boolean",
"geo_json"
],
"type": "string"
}
},
"required": [
"name",
"display_name",
"type",
"options",
"extract"
],
"type": "object"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "default sort settings for search results"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "when showing document context, sort them like this"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
UUDigitalHumanitieslab/I-analyzer | ae426a1185ea11db1a53656d29d2512a9699231d | 2024-03-08T12:07:16 | backend/addcorpus/schemas/corpus.schema.json | 6 | 2024-05-28T05:00:25.475345Z | {
"$defs": {
"sortSetting": {
"$anchor": "sortSetting",
"properties": {
"ascending": {
"description": "whether the sort direction is ascending or descending",
"type": "boolean"
},
"field": {
"description": "name of on which to sort",
"type": "string"
}
},
"required": [
"field",
"ascending"
],
"type": "object"
}
},
"$id": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/corpus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A corpus on I-analyzer",
"properties": {
"fields": {
"description": "list of fields",
"items": {
"$ref": "https://github.com/UUDigitalHumanitieslab/I-analyzer/blob/develop/backend/addcorpus/schemas/field.schema.json"
},
"type": "array"
},
"meta": {
"description": "Metadata about the corpus",
"properties": {
"category": {
"description": "nature of the content",
"enum": [
"parliament",
"periodical",
"finance",
"ruling",
"review",
"inscription",
"oration",
"book",
"informative"
],
"type": "string"
},
"date_range": {
"description": "the date range of the content",
"properties": {
"max": {
"format": "date",
"type": "string"
},
"min": {
"format": "date",
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Longer description",
"type": "string"
},
"languages": {
"description": "IETF tags of languages used in the content",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"title": {
"description": "Human-friendly name",
"type": "string"
}
},
"required": [
"title",
"description",
"languages",
"category",
"date_range"
],
"type": "object"
},
"name": {
"description": "Internal name. Used in the URL and the database.",
"type": "string"
},
"options": {
"properties": {
"default_sort": {
"$ref": "#sortSetting",
"description": "default sort settings for search results"
},
"document_context": {
"description": "description of how documents can be grouped",
"properties": {
"context_field": {
"description": "name of the field to group by",
"type": "string"
},
"display_name": {
"description": "display name of a group, ,e.g. 'book'",
"type": "string"
},
"sort": {
"$ref": "#sortSetting",
"description": "when showing document context, sort them like this"
}
},
"required": [
"context_field",
"display_name"
],
"type": "object"
},
"language_field": {
"description": "name of the field that contains the IETF tag of the document's content",
"type": "string"
}
},
"type": "object"
},
"source_data": {
"properties": {
"options": {
"description": "additional options for source files",
"properties": {
"delimiter": {
"description": "delimiter between values in the source files",
"enum": [
",",
";",
"\t"
],
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "data type of the source files",
"enum": [
"csv"
],
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"meta",
"source_data",
"fields"
],
"title": "Corpus",
"type": "object"
} | MIT | en |
uulm-mrm/ros2_def | e4d022bed41a748645e51b2a89811c06fab87837 | 2023-05-04T09:36:38 | ros2/orchestrator/schemas/launch_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$id": "launch_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Extended ros graph launch configuration",
"properties": {
"inputs": {
"$comment": "TODO: specify this"
},
"nodes": {
"patternProperties": {
"^.+": {
"additionalProperties": false,
"properties": {
"config_file": {
"items": false,
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"title": "Package name",
"type": "string"
},
{
"title": "Config file name",
"type": "string"
}
],
"type": "array"
},
"remappings": {
"patternProperties": {
"^.+": {
"type": "string"
}
},
"title": "List of remappings",
"type": "object"
},
"state_sequence": {
"type": "array"
}
},
"required": [
"config_file"
],
"title": "Node instance specification",
"type": "object"
}
},
"title": "List of named nodes",
"type": "object"
}
},
"required": [
"nodes"
],
"title": "Launch Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 3d4a716ce61655bfd1a3e41ad12f32c7bba0c6b1 | 2023-08-24T12:37:13 | ros2/orchestrator/schemas/launch_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$id": "launch_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Extended ros graph launch configuration",
"properties": {
"inputs": {
"$comment": "TODO: specify this"
},
"nodes": {
"patternProperties": {
"^.+": {
"additionalProperties": false,
"properties": {
"config_file": {
"items": false,
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"title": "Package name",
"type": "string"
},
{
"title": "Config file name",
"type": "string"
}
],
"type": [
"array",
"string"
]
},
"remappings": {
"patternProperties": {
"^.+": {
"type": "string"
}
},
"title": "List of remappings",
"type": "object"
},
"state_sequence": {
"type": "array"
}
},
"required": [
"config_file"
],
"title": "Node instance specification",
"type": "object"
}
},
"title": "List of named nodes",
"type": "object"
}
},
"required": [
"nodes"
],
"title": "Launch Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 925ff227ab8b81e57ad5bc7fa5093b956e5e0267 | 2023-08-08T20:38:19 | ros2/orchestrator/schemas/node_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$defs": {
"callback_spec": {
"additionalProperties": false,
"properties": {
"changes_dataprovider_state": {
"type": "boolean"
},
"may_cause_reconfiguration": {
"type": "boolean"
},
"name": {
"type": "string"
},
"outputs": {
"items": {
"$comment": "TODO!",
"type": "string"
},
"type": "array"
},
"service_calls": {
"items": {
"title": "Service name",
"type": "string"
},
"type": "array"
},
"trigger": {
"oneOf": [
{
"title": "Internal input topic name",
"type": "string"
},
{
"$ref": "#/$defs/trigger_topic"
},
{
"$ref": "#/$defs/trigger_timer"
},
{
"$ref": "#/$defs/trigger_timesync"
}
]
}
},
"required": [
"trigger",
"outputs"
],
"title": "Callback specification",
"type": "object"
},
"trigger_timer": {
"additionalProperties": false,
"properties": {
"period": {
"exclusiveMinimum": 0,
"title": "Timer period in nanoseconds",
"type": "integer"
},
"type": {
"const": "timer",
"type": "string"
}
},
"required": [
"type",
"period"
],
"title": "Timer",
"type": "object"
},
"trigger_timesync": {
"additionalProperties": false,
"properties": {
"input_topics": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"queue_size": {
"type": "integer"
},
"slop": {
"type": "number"
},
"type": {
"const": "approximate_time_sync",
"type": "string"
}
},
"required": [
"type",
"input_topics",
"slop",
"queue_size"
],
"title": "ApproximateTimeSynchronizer",
"type": "object"
},
"trigger_topic": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "topic",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "Internal input topic name",
"type": "object"
}
},
"$id": "node_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Behavior specification of a ROS node",
"properties": {
"callbacks": {
"items": {
"$ref": "#/$defs/callback_spec"
},
"title": "List of callback specifications",
"type": "array"
},
"name": {
"type": "string"
},
"services": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"callbacks"
],
"title": "Node Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 30aeab4c2aec22e8af8916e68f4b0464cb78cf8c | 2023-03-24T11:05:37 | ros2/orchestrator/schemas/launch_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$id": "launch_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Extended ros graph launch configuration",
"properties": {
"inputs": {
"$comment": "TODO: specify this"
},
"nodes": {
"patternProperties": {
"^.+": {
"additionalProperties": false,
"properties": {
"config_file": {
"items": false,
"minItems": 2,
"prefixItems": [
{
"title": "Package name",
"type": "string"
},
{
"title": "Config file name",
"type": "string"
}
],
"type": "array"
},
"remappings": {
"patternProperties": {
"^.+": {
"type": "string"
}
},
"title": "List of remappings",
"type": "object"
}
},
"required": [
"config_file"
],
"title": "Node instance specification",
"type": "object"
}
},
"title": "List of named nodes",
"type": "object"
}
},
"required": [
"nodes"
],
"title": "Launch Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 0b9b81589d7d51306214af4a94e31cf1074fdfcb | 2023-05-04T14:53:19 | ros2/orchestrator/schemas/node_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$defs": {
"callback_spec": {
"additionalProperties": false,
"properties": {
"changes_dataprovider_state": {
"type": "boolean"
},
"name": {
"type": "string"
},
"outputs": {
"items": {
"$comment": "TODO!",
"type": "string"
},
"type": "array"
},
"service_calls": {
"items": {
"title": "Service name",
"type": "string"
},
"type": "array"
},
"trigger": {
"oneOf": [
{
"title": "Internal input topic name",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "topic",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "Internal input topic name",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"period": {
"exclusiveMinimum": 0,
"title": "Timer period in nanoseconds",
"type": "integer"
},
"type": {
"const": "timer",
"type": "string"
}
},
"required": [
"type",
"period"
],
"title": "Timer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"input_topics": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"queue_size": {
"type": "integer"
},
"slop": {
"type": "number"
},
"type": {
"const": "approximate_time_sync",
"type": "string"
}
},
"required": [
"type",
"input_topics",
"slop",
"queue_size"
],
"title": "ApproximateTimeSynchronizer",
"type": "object"
}
]
}
},
"required": [
"trigger",
"outputs"
],
"title": "Callback specification",
"type": "object"
}
},
"$id": "node_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Behavior specification of a ROS node",
"properties": {
"callbacks": {
"items": {
"$ref": "#/$defs/callback_spec"
},
"title": "List of callback specifications",
"type": "array"
},
"name": {
"type": "string"
},
"services": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"callbacks"
],
"title": "Node Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 1d353456a5790dfe5824194c773334e8a34716dc | 2023-03-24T10:53:23 | ros2/orchestrator/schemas/node_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$defs": {
"callback_spec": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"outputs": {
"items": {
"$comment": "TODO!",
"type": "string"
},
"type": "array"
},
"service_calls": {
"items": {
"title": "Service name",
"type": "string"
},
"type": "array"
},
"trigger": {
"oneOf": [
{
"title": "Internal input topic name",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "topic",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "Internal input topic name",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"period": {
"exclusiveMinimum": 0,
"title": "Timer period in nanoseconds",
"type": "integer"
},
"type": {
"const": "timer",
"type": "string"
}
},
"required": [
"type",
"period"
],
"title": "Timer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"input_topics": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"queue_size": {
"type": "integer"
},
"slop": {
"type": "number"
},
"type": {
"const": "approximate_time_sync",
"type": "string"
}
},
"required": [
"type",
"input_topics",
"slop",
"queue_size"
],
"title": "ApproximateTimeSynchronizer",
"type": "object"
}
]
}
},
"required": [
"trigger",
"outputs"
],
"title": "Callback specification",
"type": "object"
}
},
"$id": "node_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Behavior specification of a ROS node",
"properties": {
"callbacks": {
"items": {
"$ref": "#/$defs/callback_spec"
},
"title": "List of callback specifications",
"type": "array"
},
"name": {
"type": "string"
},
"services": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"callbacks"
],
"title": "Node Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | f8603b731639626ae624554a0dfc300e6e44685c | 2023-12-06T16:07:29 | ros2/orchestrator/schemas/node_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$defs": {
"callback_spec": {
"additionalProperties": false,
"properties": {
"changes_dataprovider_state": {
"type": "boolean"
},
"may_cause_reconfiguration": {
"type": "boolean"
},
"name": {
"type": "string"
},
"outputs": {
"items": {
"$comment": "TODO!",
"type": "string"
},
"type": "array"
},
"service_calls": {
"items": {
"title": "Service name",
"type": "string"
},
"type": "array"
},
"trigger": {
"oneOf": [
{
"title": "Internal input topic name",
"type": "string"
},
{
"$ref": "#/$defs/trigger_topic"
},
{
"$ref": "#/$defs/trigger_timer"
},
{
"$ref": "#/$defs/trigger_timesync"
}
]
}
},
"required": [
"trigger",
"outputs"
],
"title": "Callback specification",
"type": "object"
},
"trigger_timer": {
"additionalProperties": false,
"properties": {
"period": {
"exclusiveMinimum": 0,
"title": "Timer period in nanoseconds",
"type": "integer"
},
"type": {
"const": "timer",
"type": "string"
}
},
"required": [
"type",
"period"
],
"title": "Timer",
"type": "object"
},
"trigger_timesync": {
"additionalProperties": false,
"properties": {
"input_topics": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"queue_size": {
"type": "integer"
},
"slop": {
"type": "number"
},
"type": {
"const": "approximate_time_sync",
"type": "string"
}
},
"required": [
"type",
"input_topics",
"slop",
"queue_size"
],
"title": "ApproximateTimeSynchronizer",
"type": "object"
},
"trigger_topic": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "topic",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "Internal input topic name",
"type": "object"
}
},
"$id": "node_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Behavior specification of a ROS node",
"properties": {
"callbacks": {
"items": {
"$ref": "#/$defs/callback_spec"
},
"title": "List of callback specifications",
"type": "array"
},
"name": {
"type": "string"
},
"priority": {
"type": "number"
},
"services": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"callbacks"
],
"title": "Node Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | e88a00a470ed90fc9e8b0f87fa910b9948713205 | 2023-05-09T14:20:37 | ros2/orchestrator/schemas/node_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$defs": {
"callback_spec": {
"additionalProperties": false,
"properties": {
"changes_dataprovider_state": {
"type": "boolean"
},
"may_cause_reconfiguration": {
"type": "boolean"
},
"name": {
"type": "string"
},
"outputs": {
"items": {
"$comment": "TODO!",
"type": "string"
},
"type": "array"
},
"service_calls": {
"items": {
"title": "Service name",
"type": "string"
},
"type": "array"
},
"trigger": {
"oneOf": [
{
"title": "Internal input topic name",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"const": "topic",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "Internal input topic name",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"period": {
"exclusiveMinimum": 0,
"title": "Timer period in nanoseconds",
"type": "integer"
},
"type": {
"const": "timer",
"type": "string"
}
},
"required": [
"type",
"period"
],
"title": "Timer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"input_topics": {
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"queue_size": {
"type": "integer"
},
"slop": {
"type": "number"
},
"type": {
"const": "approximate_time_sync",
"type": "string"
}
},
"required": [
"type",
"input_topics",
"slop",
"queue_size"
],
"title": "ApproximateTimeSynchronizer",
"type": "object"
}
]
}
},
"required": [
"trigger",
"outputs"
],
"title": "Callback specification",
"type": "object"
}
},
"$id": "node_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Behavior specification of a ROS node",
"properties": {
"callbacks": {
"items": {
"$ref": "#/$defs/callback_spec"
},
"title": "List of callback specifications",
"type": "array"
},
"name": {
"type": "string"
},
"services": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"callbacks"
],
"title": "Node Configuration",
"type": "object"
} | Apache-2.0 | en |
uulm-mrm/ros2_def | 9e52ee8fc79d4062aebcd2e758a7e58ae80c1f59 | 2023-03-27T12:11:24 | ros2/orchestrator/schemas/launch_config_schema.json | 8 | 2024-05-27T06:39:45.843023Z | {
"$id": "launch_config_schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Extended ros graph launch configuration",
"properties": {
"inputs": {
"$comment": "TODO: specify this"
},
"nodes": {
"patternProperties": {
"^.+": {
"additionalProperties": false,
"properties": {
"config_file": {
"items": false,
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"title": "Package name",
"type": "string"
},
{
"title": "Config file name",
"type": "string"
}
],
"type": "array"
},
"remappings": {
"patternProperties": {
"^.+": {
"type": "string"
}
},
"title": "List of remappings",
"type": "object"
}
},
"required": [
"config_file"
],
"title": "Node instance specification",
"type": "object"
}
},
"title": "List of named nodes",
"type": "object"
}
},
"required": [
"nodes"
],
"title": "Launch Configuration",
"type": "object"
} | Apache-2.0 | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/shared-credentials-historical-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"domain-list": {
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"items": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"shared": {
"$ref": "#/definitions/domain-list"
}
},
"required": [
"shared"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"from": {
"$ref": "#/definitions/domain-list"
},
"fromDomainsAreObsoleted": {
"type": "boolean"
},
"to": {
"$ref": "#/definitions/domain-list"
}
},
"required": [
"from",
"to"
],
"type": "object"
}
]
},
"type": "array"
} | MIT | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/websites-that-append-2fa-to-password-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
} | MIT | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/change-password-URLs-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {
"type": "string"
},
"type": "object"
} | MIT | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/password-rules-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {
"additionalProperties": false,
"properties": {
"password-rules": {
"type": "string"
}
},
"required": [
"password-rules"
],
"type": "object"
},
"type": "object"
} | MIT | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/websites-with-shared-credential-backends-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"items": {
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"type": "array"
} | MIT | en |
apple/password-manager-resources | 363e97cebf9da3c382e32c2440149182a24291f2 | 2022-06-22T21:10:08 | quirks/schemas/shared-credentials-schema.json | 4,100 | 2024-05-28T04:44:12.154105Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"domain-list": {
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"items": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"shared": {
"$ref": "#/definitions/domain-list"
}
},
"required": [
"shared"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"from": {
"$ref": "#/definitions/domain-list"
},
"fromDomainsAreObsoleted": {
"type": "boolean"
},
"to": {
"$ref": "#/definitions/domain-list"
}
},
"required": [
"from",
"to"
],
"type": "object"
}
]
},
"type": "array"
} | MIT | en |
cerbos/cerbos-sdk-net | afd7a1f1b4072d37935ea1510c5a5ecbe4fd2dd8 | 2022-07-19T15:18:49 | src/Sdk.UnitTests/res/policies/_schemas/principal.json | 14 | 2024-05-27T09:31:54.745164Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"geography": {
"type": "string"
},
"jobRoles": {
"items": {
"type": "string"
},
"type": "array"
},
"managed_geographies": {
"type": "string"
},
"orgId": {
"type": "string"
},
"tags": {
"properties": {
"brands": {
"items": {
"type": "string"
},
"type": "array"
},
"classes": {
"items": {
"type": "string"
},
"type": "array"
},
"regions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-net | afd7a1f1b4072d37935ea1510c5a5ecbe4fd2dd8 | 2022-07-19T15:18:49 | src/Sdk.UnitTests/res/policies/_schemas/resources/leave_request.json | 14 | 2024-05-27T09:31:54.745164Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"dev_record": {
"type": "boolean"
},
"geography": {
"type": "string"
},
"id": {
"type": "string"
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team",
"id"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/files/_schemas/a.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"a": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/files/_schemas/1/b.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"b": {
"type": "number"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.27/_schemas/principal.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"country": {
"properties": {
"alpha2": {
"pattern": "[A-Z]{2}",
"type": "string"
},
"alpha3": {
"pattern": "[A-Z]{3}",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.16/_schemas/principal.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"country": {
"properties": {
"alpha2": {
"pattern": "[A-Z]{2}",
"type": "string"
},
"alpha3": {
"pattern": "[A-Z]{3}",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.27/_schemas/document.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"owner": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/files/_schemas/testdata/c.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"c": {
"type": "boolean"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.29/_schemas/principal.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"country": {
"properties": {
"alpha2": {
"pattern": "[A-Z]{2}",
"type": "string"
},
"alpha3": {
"pattern": "[A-Z]{3}",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.16/_schemas/document.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"owner": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-javascript | 62741ad4388aca920bd46ee231261011e25ad6ff | 2024-03-22T13:06:34 | private/test/servers/policies/0.29/_schemas/document.json | 68 | 2024-05-28T06:13:05.149977Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"owner": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-rust | da151ed4834f0eacff3ef7e66fa2f54fbd37c5c8 | 2022-04-28T12:16:49 | resources/store/_schemas/leave_request.json | 7 | 2024-05-27T08:51:10.699767Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"dev_record": {
"type": "boolean"
},
"geography": {
"type": "string"
},
"id": {
"type": "string"
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team",
"id"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-rust | da151ed4834f0eacff3ef7e66fa2f54fbd37c5c8 | 2022-04-28T12:16:49 | resources/store/_schemas/salary_record.json | 7 | 2024-05-27T08:51:10.699767Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"type": "string"
},
"dev_record": {
"type": "boolean"
},
"geography": {
"type": "string"
},
"id": {
"type": "string"
},
"owner": {
"type": "string"
},
"team": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-rust | da151ed4834f0eacff3ef7e66fa2f54fbd37c5c8 | 2022-04-28T12:16:49 | resources/store/_schemas/purchase_order.json | 7 | 2024-05-27T08:51:10.699767Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"ownerOrgId": {
"type": "string"
},
"tags": {
"properties": {
"brand": {
"type": "string"
},
"class": {
"type": "string"
},
"region": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos-sdk-rust | da151ed4834f0eacff3ef7e66fa2f54fbd37c5c8 | 2022-04-28T12:16:49 | resources/store/_schemas/principal.json | 7 | 2024-05-27T08:51:10.699767Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"geography": {
"type": "string"
},
"jobRoles": {
"items": {
"type": "string"
},
"type": "array"
},
"managed_geographies": {
"type": "string"
},
"orgId": {
"type": "string"
},
"tags": {
"properties": {
"brands": {
"items": {
"type": "string"
},
"type": "array"
},
"classes": {
"items": {
"type": "string"
},
"type": "array"
},
"regions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/schema/fs/_schemas/customer_absolute.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"billing_address": {
"$ref": "cerbos:///address.json"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"shipping_address": {
"$ref": "cerbos:///address.json"
}
},
"required": [
"first_name",
"last_name",
"shipping_address",
"billing_address"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/schema/fs/_schemas/address.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"street_address": {
"type": "string"
}
},
"required": [
"street_address",
"city",
"state"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | b44a108fea90d418e5bed34543da9638d8defaaf | 2022-07-26T14:51:46 | docs/modules/ROOT/examples/tutorial/09-attribute-schema/cerbos/policies/_schemas/contact.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"active": {
"type": "boolean"
},
"ownerId": {
"type": "string"
}
},
"required": [
"ownerId",
"active"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/schema/fs/_schemas/customer_relative.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"billing_address": {
"$ref": "/address.json"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"shipping_address": {
"$ref": "/address.json"
}
},
"required": [
"first_name",
"last_name",
"shipping_address",
"billing_address"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/store/_schemas/principal.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"geography": {
"type": "string"
},
"jobRoles": {
"items": {
"type": "string"
},
"type": "array"
},
"managed_geographies": {
"type": "string"
},
"orgId": {
"type": "string"
},
"tags": {
"properties": {
"brands": {
"items": {
"type": "string"
},
"type": "array"
},
"classes": {
"items": {
"type": "string"
},
"type": "array"
},
"regions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/schema/fs/_schemas/customer_invalid.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"billing_address": {
"$ref": "/non_existend_address.json"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"shipping_address": {
"$ref": "/non_existent_address.json"
}
},
"required": [
"first_name",
"last_name",
"shipping_address",
"billing_address"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 491e45b400a2e7d381f645d11af333fbdd4cbb13 | 2022-06-14T09:34:38 | internal/test/testdata/store/_schemas/resources/purchase_order.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"ownerOrgId": {
"type": "string"
},
"tags": {
"properties": {
"brand": {
"type": "string"
},
"class": {
"type": "string"
},
"region": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 491e45b400a2e7d381f645d11af333fbdd4cbb13 | 2022-06-14T09:34:38 | internal/test/testdata/store/_schemas/resources/salary_record.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"type": "string"
},
"dev_record": {
"type": "boolean"
},
"geography": {
"type": "string"
},
"id": {
"type": "string"
},
"owner": {
"type": "string"
},
"team": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 9181c405e488f3f74f4a328fb1fe6af54df40eab | 2021-12-09T10:20:22 | internal/test/testdata/schema/fs/_schemas/complex_object.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"boolField": {
"type": "boolean"
},
"boolList": {
"items": {
"type": "boolean"
},
"type": "array"
},
"dateField": {
"format": "date-time",
"type": "string"
},
"floatField": {
"maximum": 400,
"type": "number"
},
"floatList": {
"items": {
"type": "number"
},
"type": "array"
},
"intField": {
"minimum": 20,
"type": "integer"
},
"intList": {
"items": {
"type": "integer"
},
"type": "array"
},
"nestedList": {
"items": {
"properties": {
"floatField": {
"type": "number"
},
"intListField": {
"items": {
"type": "integer"
},
"type": "array"
},
"stringField": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"nestedObject": {
"properties": {
"key1": {
"properties": {
"floatField": {
"type": "number"
},
"intListField": {
"items": {
"type": "integer"
},
"type": "array"
},
"stringField": {
"type": "string"
}
},
"type": "object"
},
"key2": {
"items": {
"type": "string"
},
"type": "array"
},
"key3": {
"type": "boolean"
}
},
"type": "object"
},
"simpleObject": {
"properties": {
"floatField": {
"type": "number"
},
"stringField": {
"type": "string"
}
},
"type": "object"
},
"stringField": {
"minLength": 5,
"type": "string"
},
"stringList": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"stringField",
"intField"
],
"type": "object"
} | Apache-2.0 | en |
cerbos/cerbos | 491e45b400a2e7d381f645d11af333fbdd4cbb13 | 2022-06-14T09:34:38 | internal/test/testdata/store/_schemas/resources/leave_request.json | 2,561 | 2024-05-29T18:04:35.070583Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"department": {
"enum": [
"marketing",
"engineering"
],
"type": "string"
},
"dev_record": {
"type": "boolean"
},
"geography": {
"type": "string"
},
"id": {
"type": "string"
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"team": {
"type": "string"
}
},
"required": [
"department",
"geography",
"team",
"id"
],
"type": "object"
} | Apache-2.0 | en |
CesiumGS/cesium-native | 3fab3be7e47a6e03aa987ac8f89a161672640baf | 2024-04-10T04:31:12 | CesiumQuantizedMeshTerrain/schema/layer.schema.json | 373 | 2024-05-28T04:42:55.610782Z | {
"$id": "layer.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A quantized-mesh terrain layer.json.",
"properties": {
"attribution": {
"default": "",
"description": "The attribution (credit) string for the terrain.",
"type": "string"
},
"available": {
"description": "The tile availability information. The outer array is indexed by tile level. The inner array is a list of rectangles of availability at that level. Tiles themselves may also contain further availability information for their subtree.",
"items": {
"items": {
"$ref": "availabilityRectangle.schema.json"
},
"type": "array"
},
"type": "array"
},
"bounds": {
"default": [
-180,
-90,
180,
90
],
"description": "The bounding box of the terrain, expressed as west, south, east, north in degrees.",
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
"description": {
"default": "",
"description": "The description of this terrain tileset.",
"type": "string"
},
"extensions": {
"description": "The extensions available for this tileset.",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"default": "quantized-mesh-1.0",
"description": "The format of the terrain tiles. Should be `\"quantized-mesh-1.0\"`.",
"type": "string"
},
"maxzoom": {
"description": "The maximum level for which there are any available tiles.",
"type": "integer"
},
"metadataAvailability": {
"description": "The levels at metadata is found in tiles. For example, if this value is 10, then metadata is found at levels 0, 10, 20, etc.",
"type": "integer"
},
"minzoom": {
"default": 0,
"description": "The minimum level for which there are any available tiles.",
"type": "integer"
},
"name": {
"default": "Terrain",
"description": "The name of this terrain tileset.",
"type": "string"
},
"parentUrl": {
"description": "The URL of the parent layer.json that this one is layered on top of.",
"type": "string"
},
"projection": {
"default": "EPSG:4326",
"description": "The map projection of this tileset. Valid values are `\"EPSG:4326\"` and `\"EPSG:3857\"`.",
"type": "string"
},
"scheme": {
"default": "tms",
"description": "The tiling scheme. The only valid value is `\"tms\"`.",
"type": "string"
},
"tiles": {
"description": "The URL templates from which to obtain tiles.",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"default": "1.0.0",
"description": "The version of this tileset.",
"type": "string"
}
},
"required": [
"tiles",
"maxzoom"
],
"title": "Layer"
} | Apache-2.0 | en |
Subsets and Splits