Skip to content

K9VULN-3987 update editor schema for cross platform support #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
Closed

K9VULN-3987 update editor schema for cross platform support #661

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b568256
K9VULN-3987 update schema, removed null variant for ruleset since str…
dd-colin Mar 5, 2025
7c38008
updated schema to fix rules autocompleting under rulesets before a ru…
dd-colin Mar 5, 2025
7c728fe
fixed ruleset type name, needs to reflect the fact that rulesets is a…
dd-colin Mar 5, 2025
f2e3e19
attempting to make auto-complete better via json
dd-colin Mar 5, 2025
413bbd6
testing out empty ruleset again
dd-colin Mar 5, 2025
640e2f8
testing out empty ruleset again -- removed
dd-colin Mar 5, 2025
8fe5142
testing out empty ruleset again, again -- remember to clear cache
dd-colin Mar 5, 2025
7a77647
confirmed empty ruleset must be removed to support get autocompletion…
dd-colin Mar 5, 2025
ba4f611
testing out descriptions
dd-colin Mar 5, 2025
8b6904a
testing out descriptions
dd-colin Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 53 additions & 37 deletions schema/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,47 @@
"schema-version": {
"type": "string",
"default": "v1",
"enum": ["v1"]
"enum": [
"v1"
],
"description": "Defines the version of the schema used in the configuration file. Only 'v1' is currently supported."
},
"rulesets": {
"type": "array",
"items": {
"anyOf": [
"oneOf": [
{
"$ref": "#/definitions/ruleset"
},
{
"$ref": "#/definitions/emptyRuleset"
},
{
"type": "string",
"minLength": 1
"minLength": 1,
"description": "A reference to a predefined ruleset name."
}
]
},
"minItems": 1
"minItems": 1,
"description": "List of rulesets to be applied. A ruleset can either be a predefined ruleset name or an object containing rules."
},
"ignore": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern for files or directories to exclude from analysis for all rulesets."
},
"only": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern for files or directories to be exclusively analyzed for all rulesets."
},
"ignore-gitignore": {
"type": "boolean"
"type": "boolean",
"description": "If set to 'true', the rules engine will automatically ignore files specified in the .gitignore file."
},
"ignore-generated-files": {
"type": "boolean"
"type": "boolean",
"description": "If set to 'true', auto-detects and excludes generated files from analysis."
},
"max-file-size-kb": {
"type": "number"
"type": "number",
"description": "Specifies the maximum file size (in kilobytes) to analyze. Files exceeding this size will be ignored."
}
},
"required": [
Expand All @@ -49,16 +56,20 @@
"type": "object",
"properties": {
"ignore": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern specifying files or directories where this rule should not be applied for this rule."
},
"only": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern specifying files or directories where this rule should be enforced for this rule."
},
"arguments": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/argumentValue"
}
"$ref": "#/definitions/argumentValue",
"description": "A rule definition containing category, arguments, severity, and the include / ignore patterns."
},
"description": "Key-value pairs of rule-specific arguments that modify its behavior. See rule definition for detailed list of arguments & their usage."
},
"severity": {
"anyOf": [
Expand All @@ -71,7 +82,8 @@
"$ref": "#/definitions/singularSeverityValue"
}
}
]
],
"description": "Defines the severity level of the rule. Can be 'ERROR', 'WARNING', 'NOTICE', or 'NONE'."
},
"category": {
"enum": [
Expand All @@ -80,42 +92,45 @@
"ERROR_PRONE",
"PERFORMANCE",
"SECURITY"
]
],
"description": "Classifies the rule into one of the predefined categories such as Security, Best Practices, etc."
}
}
},
"emptyRuleset": {
"type": "object",
"additionalProperties": {
"type": "null"
},
"minProperties": 1,
"maxProperties": 1
},
"ruleset": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/rule"
}
"$ref": "#/definitions/rule",
"description": "A rule definition containing category, arguments, severity, and the include / ignore patterns."
},
"description": "A collection of rules defined for this ruleset, if this field is included, only these rules will be applied."
},
"ignore": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern specifying files or directories where the ruleset should not be applied."
},
"only": {
"$ref": "#/definitions/pathList"
"$ref": "#/definitions/pathList",
"description": "Glob pattern specifying files or directories where the ruleset should be enforced."
}
},
"minProperties": 2
"additionalProperties": {
"type": "null",
"description": "Name for the ruleset, defined as a key in the ruleset object."
},
"minProperties": 2,
"description": "Defines a ruleset configuration containing specific rules, ignore paths, or included paths."
},
"pathList": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"description": "An array of glob patterns specifying file paths."
},
"argumentValue": {
"anyOf": [
Expand All @@ -128,7 +143,8 @@
"$ref": "#/definitions/singularArgumentValue"
}
}
]
],
"description": "Specifies argument values for a rule, either as a direct value or a mapping of file paths to values."
},
"singularArgumentValue": {
"anyOf": [
Expand All @@ -143,17 +159,17 @@
"type": "boolean",
"$comment": "will be internally coerced to string"
}
]
],
"description": "A singular value that can be a string, number, or boolean, used as an argument for a rule."
},
"singularSeverityValue": {
"enum": [
"ERROR",
"WARNING",
"NOTICE",
"NONE"
]
],
"description": "Defines the severity level of a rule, indicating its impact."
}
}
}


Loading