schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
gherking.schema.json
keep
To set which comment types should be kept, not removed.
{"type": "array", "items": {"type": "string", "enum": ["NONE", "BEFORE_TAGS", "PRECEDING", "DESCRIPTION", "TAG", "ROW", "DOC_STRING", "STEP", "START", "END", "ALL"]}, "minItems": 1}
gherking.schema.json
gpcRemoveDuplicates
The RemoveDuplicates precompiler is responsible for having only a reasonable amount of tags and/or rows in each feature file.
{"type": "object", "properties": {"path": {"const": "gpc-remove-duplicates"}, "configuration": {"type": "object", "properties": {"processTags": {"type": "boolean", "default": true}, "processRows": {"type": "boolean", "default": false}}, "additionalProperties": false}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
processTags
Should tags on the same level and from parent be de-duplicated.
{"type": "boolean", "default": true}
gherking.schema.json
processRows
Should table rows be de-duplicated.
{"type": "boolean", "default": false}
gherking.schema.json
gpcScenarioNumbering
The ScenarioNumbering precompiler is responsible for adding an index to all scenarios and scenario outlines.
{"type": "object", "properties": {"path": {"const": "gpc-scenario-numbering"}, "configuration": {"type": "object", "properties": {"format": {"type": "string", "default": "${i}. ${name}", "minLength": 11, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{i\\}.*$"}]}}, "additionalProperties": false}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
format
The format, how index should be added to the name of the scenario/scenairo outline. Possible tokens: ${name} the original name, ${i} the index
{"type": "string", "default": "${i}. ${name}", "minLength": 11, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{i\\}.*$"}]}
gherking.schema.json
gpcScenarioOutlineExpander
This precompiler is responsible for converting Scenario Outlines to single Scenarios as Cucumber would do and adds the first column as a tag.
{"type": "object", "properties": {"path": {"const": "gpc-scenario-outline-expander"}, "configuration": {"type": "object", "properties": {"ignoreTag": {"type": "string", "default": "@notExpand", "minLength": 2, "pattern": "^@[^ ]+$"}}, "additionalProperties": false}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
ignoreTag
Tag used to mark scenarios to be ignored during expanding Scenario Outlines.
{"type": "string", "default": "@notExpand", "minLength": 2, "pattern": "^@[^ ]+$"}
gherking.schema.json
gpcScenarioOutlineNumbering
This precompiler can add numbering column to Examples tables, and apply formatting to the name of the Scenario Outline.
{"type": "object", "properties": {"path": {"const": "gpc-scenario-outline-numbering"}, "configuration": {"type": "object", "properties": {"addParameters": {"type": "boolean", "default": false}, "parameterDelimiter": {"type": "string", "default": ",", "minLength": 1}, "parameterFormat": {"type": "string", "default": "${name} - ${parameters}", "minLength": 20, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{parameters\\}.*$"}]}, "addNumbering": {"type": "boolean", "default": true}, "numberingFormat": {"type": "string", "default": "${i} - ${name}", "minLength": 11, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{i\\}.*$"}]}, "strictNaming": {"type": "boolean", "default": false}}, "additionalProperties": false}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
addParameters
Should the example parameters be added to the name of the Scenario Outline.
{"type": "boolean", "default": false}
gherking.schema.json
parameterDelimiter
The delimiter to use when adding the parameters to the name of the Scenario Outline.
{"type": "string", "default": ",", "minLength": 1}
gherking.schema.json
parameterFormat
The format how the output Scenario Outline name should look with the parameters. Tokens to use: ${name}, ${parameters}
{"type": "string", "default": "${name} - ${parameters}", "minLength": 20, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{parameters\\}.*$"}]}
gherking.schema.json
addNumbering
Should an index be added to the name of the Scenario Outline.
{"type": "boolean", "default": true}
gherking.schema.json
numberingFormat
The format how the output Scenario Outline name should look with the index. Tokens to use: ${name}, ${i}
{"type": "string", "default": "${i} - ${name}", "minLength": 11, "allOf": [{"pattern": "^.*\\$\\{name\\}.*$"}, {"pattern": "^.*\\$\\{i\\}.*$"}]}
gherking.schema.json
strictNaming
Should the existing numbering field (num) block execution (true) or be used for numbering (false).
{"type": "boolean", "default": false}
gherking.schema.json
gpcStepGroups
The StepGroups precompiler is responsible for correcting the gherkin keywords of steps to make the tests more readable.
{"type": "object", "properties": {"path": {"const": "gpc-step-groups"}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
gpcTestData
This precompiler can load external data (JSON, CSV, or XLS/XLSX) into exmaples table.
{"type": "object", "properties": {"path": {"const": "gpc-test-data"}, "configuration": {"type": "object", "properties": {"keepTag": {"type": "boolean", "default": false}, "defaultValue": {"type": ["string", "number"], "default": ""}, "appendData": {"type": "boolean", "default": true}, "ignoreKeyCase": {"type": "boolean", "default": true}}, "additionalProperties": false}}, "required": ["path"], "additionalProperties": false}
gherking.schema.json
keepTag
Whether the load-tags should be kept or removed.
{"type": "boolean", "default": false}
gherking.schema.json
defaultValue
The default value to be added to the table if a column/value is not found.
{"type": ["string", "number"], "default": ""}
gherking.schema.json
appendData
Whether the loaded data should be appended to the existing rows of the examples table or overwritten.
{"type": "boolean", "default": true}
gherking.schema.json
ignoreKeyCase
Whether the casing of the example columns and data columns should be ignored.
{"type": "boolean", "default": true}
gherking.schema.json
gpcLicense
This precompiler can be used to inject License statement into the feature files.
{"type": "object", "properties": {"path": {"const": "gpc-license"}, "configuration": {"type": "object", "properties": {"licenseFile": {"type": "string", "minLength": 1}, "licenseText": {"type": "string", "minLength": 1}, "placement": {"type": "string", "enum": ["start", "end"]}}, "additionalProperties": false, "anyOf": [{"required": ["licenseFile"]}, {"required": ["licenseText"]}]}}, "required": ["path", "configuration"], "additionalProperties": false}
gherking.schema.json
licenseFile
The file's path where the license is stored.
{"type": "string", "minLength": 1}
gherking.schema.json
licenseText
The exact license text. It can contain the ${LICENSE} token to set the content of the license file.
{"type": "string", "minLength": 1}
gherking.schema.json
placement
The place to inject the license text, either in start or end comment.
{"type": "string", "enum": ["start", "end"]}
gherking.schema.json
formatOptions
Options to pass to gherkin-formatter, on how to format the output feature files.
{"type": "object", "properties": {"oneTagPerLine": {"type": "boolean", "default": false}, "separateStepGroups": {"type": "boolean", "default": false}, "compact": {"type": "boolean", "default": false}, "lineBreak": {"type": ["string", "null"], "default": null}, "indentation": {"type": "string", "default": " "}}, "additionalProperties": false}
gherking.schema.json
oneTagPerLine
Should the tags be rendered separately, one by line?
{"type": "boolean", "default": false}
gherking.schema.json
separateStepGroups
Should step groups (when-then) be separated?
{"type": "boolean", "default": false}
gherking.schema.json
compact
Should empty lines be skipped, removed from the result?
{"type": "boolean", "default": false}
gherking.schema.json
lineBreak
The line break character(s).
{"type": ["string", "null"], "default": null}
gherking.schema.json
indentation
The indentation character(s).
{"type": "string", "default": " "}
prettierrc.json
arrowParens
Include parentheses around a sole arrow function parameter.
{"default": "always", "oneOf": [{"enum": ["always"]}, {"enum": ["avoid"]}]}
prettierrc.json
arrowParens
Always include parens. Example: `(x) => x`
{"enum": ["always"]}
prettierrc.json
arrowParens
Omit parens when possible. Example: `x => x`
{"enum": ["avoid"]}
prettierrc.json
bracketSameLine
Put > of opening tags on the last line instead of on a new line.
{"default": false, "type": "boolean"}
prettierrc.json
bracketSpacing
Print spaces between brackets.
{"default": true, "type": "boolean"}
prettierrc.json
cursorOffset
Print (to stderr) where a cursor at the given position would move to after formatting. This option cannot be used with --range-start and --range-end.
{"default": -1, "type": "integer"}
prettierrc.json
editorconfig
Whether parse the .editorconfig file in your project and convert its properties to the corresponding Prettier configuration. This configuration will be overridden by .prettierrc, etc.
{"default": false, "type": "boolean"}
prettierrc.json
embeddedLanguageFormatting
Control how Prettier formats quoted code embedded in the file.
{"default": "auto", "oneOf": [{"enum": ["auto"]}, {"enum": ["off"]}]}
prettierrc.json
embeddedLanguageFormatting
Format embedded code if Prettier can automatically identify it.
{"enum": ["auto"]}
prettierrc.json
embeddedLanguageFormatting
Never automatically format embedded code.
{"enum": ["off"]}
prettierrc.json
endOfLine
Which end of line characters to apply.
{"default": "lf", "oneOf": [{"enum": ["lf"]}, {"enum": ["crlf"]}, {"enum": ["cr"]}, {"enum": ["auto"]}]}
prettierrc.json
endOfLine
Line Feed only (\n), common on Linux and macOS as well as inside git repos
{"enum": ["lf"]}
prettierrc.json
endOfLine
Carriage Return + Line Feed characters (\r\n), common on Windows
{"enum": ["crlf"]}
prettierrc.json
endOfLine
Carriage Return character only (\r), used very rarely
{"enum": ["cr"]}
prettierrc.json
endOfLine
Maintain existing (mixed values within one file are normalised by looking at what's used after the first line)
{"enum": ["auto"]}
prettierrc.json
filepath
Specify the input filepath. This will be used to do parser inference.
{"type": "string"}
prettierrc.json
htmlWhitespaceSensitivity
How to handle whitespaces in HTML.
{"default": "css", "oneOf": [{"enum": ["css"]}, {"enum": ["strict"]}, {"enum": ["ignore"]}]}
prettierrc.json
htmlWhitespaceSensitivity
Respect the default value of CSS display property.
{"enum": ["css"]}
prettierrc.json
htmlWhitespaceSensitivity
Whitespaces are considered sensitive.
{"enum": ["strict"]}
prettierrc.json
htmlWhitespaceSensitivity
Whitespaces are considered insensitive.
{"enum": ["ignore"]}
prettierrc.json
insertPragma
Insert @format pragma into file's first docblock comment.
{"default": false, "type": "boolean"}
prettierrc.json
jsxSingleQuote
Use single quotes in JSX.
{"default": false, "type": "boolean"}
prettierrc.json
parser
Which parser to use.
{"anyOf": [{"enum": ["flow"]}, {"enum": ["babel"]}, {"enum": ["babel-flow"]}, {"enum": ["babel-ts"]}, {"enum": ["typescript"]}, {"enum": ["acorn"]}, {"enum": ["espree"]}, {"enum": ["meriyah"]}, {"enum": ["css"]}, {"enum": ["less"]}, {"enum": ["scss"]}, {"enum": ["json"]}, {"enum": ["json5"]}, {"enum": ["json-stringify"]}, {"enum": ["graphql"]}, {"enum": ["markdown"]}, {"enum": ["mdx"]}, {"enum": ["vue"]}, {"enum": ["yaml"]}, {"enum": ["glimmer"]}, {"enum": ["html"]}, {"enum": ["angular"]}, {"enum": ["lwc"]}, {"type": "string"}]}
prettierrc.json
parser
Flow
{"enum": ["flow"]}
prettierrc.json
parser
JavaScript
{"enum": ["babel"]}
prettierrc.json
parser
Flow
{"enum": ["babel-flow"]}
prettierrc.json
parser
TypeScript
{"enum": ["babel-ts"]}
prettierrc.json
parser
TypeScript
{"enum": ["typescript"]}
prettierrc.json
parser
JavaScript
{"enum": ["acorn"]}
prettierrc.json
parser
JavaScript
{"enum": ["espree"]}
prettierrc.json
parser
JavaScript
{"enum": ["meriyah"]}
prettierrc.json
parser
CSS
{"enum": ["css"]}
prettierrc.json
parser
Less
{"enum": ["less"]}
prettierrc.json
parser
SCSS
{"enum": ["scss"]}
prettierrc.json
parser
JSON
{"enum": ["json"]}
prettierrc.json
parser
JSON5
{"enum": ["json5"]}
prettierrc.json
parser
JSON.stringify
{"enum": ["json-stringify"]}
prettierrc.json
parser
GraphQL
{"enum": ["graphql"]}
prettierrc.json
parser
Markdown
{"enum": ["markdown"]}
prettierrc.json
parser
MDX
{"enum": ["mdx"]}
prettierrc.json
parser
Vue
{"enum": ["vue"]}
prettierrc.json
parser
YAML
{"enum": ["yaml"]}
prettierrc.json
parser
Ember / Handlebars
{"enum": ["glimmer"]}
prettierrc.json
parser
HTML
{"enum": ["html"]}
prettierrc.json
parser
Angular
{"enum": ["angular"]}
prettierrc.json
parser
Lightning Web Components
{"enum": ["lwc"]}
prettierrc.json
parser
Custom parser
{"type": "string"}
prettierrc.json
pluginSearchDirs
Custom directory that contains prettier plugins in node_modules subdirectory. Overrides default behavior when plugins are searched relatively to the location of Prettier. Multiple values are accepted.
{"default": [], "oneOf": [{"type": "array", "items": {"type": "string"}}, {"enum": [false]}]}
prettierrc.json
pluginSearchDirs
Disable plugin autoloading.
{"enum": [false]}
prettierrc.json
plugins
Add a plugin. Multiple plugins can be passed as separate `--plugin`s.
{"default": [], "type": "array", "items": {"type": "string"}}
prettierrc.json
printWidth
The line length where Prettier will try wrap.
{"default": 80, "type": "integer"}
prettierrc.json
proseWrap
How to wrap prose.
{"default": "preserve", "oneOf": [{"enum": ["always"]}, {"enum": ["never"]}, {"enum": ["preserve"]}]}
prettierrc.json
proseWrap
Wrap prose if it exceeds the print width.
{"enum": ["always"]}
prettierrc.json
proseWrap
Do not wrap prose.
{"enum": ["never"]}
prettierrc.json
proseWrap
Wrap prose as-is.
{"enum": ["preserve"]}
prettierrc.json
quoteProps
Change when properties in objects are quoted.
{"default": "as-needed", "oneOf": [{"enum": ["as-needed"]}, {"enum": ["consistent"]}, {"enum": ["preserve"]}]}
prettierrc.json
quoteProps
Only add quotes around object properties where required.
{"enum": ["as-needed"]}
prettierrc.json
quoteProps
If at least one property in an object requires quotes, quote all properties.
{"enum": ["consistent"]}
prettierrc.json
quoteProps
Respect the input use of quotes in object properties.
{"enum": ["preserve"]}
prettierrc.json
rangeEnd
Format code ending at a given character offset (exclusive). The range will extend forwards to the end of the selected statement. This option cannot be used with --cursor-offset.
{"default": null, "type": "integer"}
prettierrc.json
rangeStart
Format code starting at a given character offset. The range will extend backwards to the start of the first line containing the selected statement. This option cannot be used with --cursor-offset.
{"default": 0, "type": "integer"}
prettierrc.json
requirePragma
Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.
{"default": false, "type": "boolean"}
prettierrc.json
semi
Print semicolons.
{"default": true, "type": "boolean"}
prettierrc.json
singleAttributePerLine
Enforce single attribute per line in HTML, Vue and JSX.
{"default": false, "type": "boolean"}
prettierrc.json
singleQuote
Use single quotes instead of double quotes.
{"default": false, "type": "boolean"}
prettierrc.json
tabWidth
Number of spaces per indentation level.
{"default": 2, "type": "integer"}
prettierrc.json
trailingComma
Print trailing commas wherever possible when multi-line.
{"default": "es5", "oneOf": [{"enum": ["es5"]}, {"enum": ["none"]}, {"enum": ["all"]}]}
prettierrc.json
trailingComma
Trailing commas where valid in ES5 (objects, arrays, etc.)
{"enum": ["es5"]}
prettierrc.json
trailingComma
No trailing commas.
{"enum": ["none"]}