{ "name": "sqruff", "runtime": "component", "exports": { "run": { "description": "Run a native command with literal arguments.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "array", "items": { "type": "string" }, "description": "Output artifacts to collect as NAME=PATH entries; names must be unique." }, "arguments": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Literal native command argument tokens." } }, "required": [ "runDir", "arguments" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "version": { "description": "Print the installed tool version.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "array", "items": { "type": "string" }, "description": "Output artifacts to collect as NAME=PATH entries; names must be unique." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "lint": { "description": "Lint SQL without modifying files and fail the pipeline on violations.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "array", "items": { "type": "string" }, "description": "Output artifacts to collect as NAME=PATH entries; names must be unique." }, "config": { "type": "string", "minLength": 1, "description": "Additional Sqruff configuration file overriding discovered configuration." }, "dialect": { "type": "string", "minLength": 1, "description": "SQL dialect override, for example postgres, ansi, or bigquery." }, "format": { "type": "string", "minLength": 1, "description": "Report format: human, github-annotation-native, gitlab, json, sarif, or none." }, "ignoreLocalConfig": { "type": "boolean", "description": "Ignore discovered global and project configuration; explicit config is still loaded." }, "parsingErrors": { "type": "boolean", "description": "Include SQL parsing errors in diagnostics." }, "disableNoqa": { "type": "boolean", "description": "Ignore inline noqa suppression comments." }, "files": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "." ], "description": "SQL files or directories to check or fix. Default: [\".\"]." }, "writeOutput": { "type": "string", "minLength": 1, "description": "Destination for a GitLab Code Quality report when using the gitlab format." }, "annotationLevel": { "type": "string", "minLength": 1, "description": "Severity for GitLab findings: notice, warning, failure, or error." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } }, "fix": { "description": "Apply SQL formatting and fixable lint rules to the selected project files.", "input": { "type": "object", "properties": { "project": { "type": "string", "default": ".", "minLength": 1, "description": "Working directory containing the source checkout; defaults to the current directory. Default: \".\"." }, "runDir": { "type": "string", "minLength": 1, "description": "Fresh directory for this invocation’s execution report and task logs; must not already exist." }, "executable": { "type": "string", "minLength": 1, "description": "Native CLI executable name or absolute path; defaults to this operation’s tool." }, "timeoutMs": { "type": "integer", "minimum": 1, "default": 900000, "description": "Maximum task duration in milliseconds; defaults to 900000. Default: 900000." }, "artifacts": { "type": "array", "items": { "type": "string" }, "description": "Output artifacts to collect as NAME=PATH entries; names must be unique." }, "config": { "type": "string", "minLength": 1, "description": "Additional Sqruff configuration file overriding discovered configuration." }, "dialect": { "type": "string", "minLength": 1, "description": "SQL dialect override, for example postgres, ansi, or bigquery." }, "format": { "type": "string", "minLength": 1, "description": "Report format: human, github-annotation-native, gitlab, json, sarif, or none." }, "ignoreLocalConfig": { "type": "boolean", "description": "Ignore discovered global and project configuration; explicit config is still loaded." }, "parsingErrors": { "type": "boolean", "description": "Include SQL parsing errors in diagnostics." }, "disableNoqa": { "type": "boolean", "description": "Ignore inline noqa suppression comments." }, "files": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "." ], "description": "SQL files or directories to check or fix. Default: [\".\"]." } }, "required": [ "runDir" ], "additionalProperties": false }, "output": { "type": "object", "required": [ "outcome", "runDir", "reportPath", "stdoutPath", "stderrPath" ], "properties": { "outcome": { "type": "string" }, "runDir": { "type": "string" }, "reportPath": { "type": "string" }, "stdoutPath": { "type": "string" }, "stderrPath": { "type": "string" } }, "additionalProperties": false } } } }