schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
configSchema.json | local | Ports on the host machine to map | {"type": "string", "pattern": "^\\d+-\\d+$"} |
configSchema.json | container | Ports inside the container to map | {"type": "string", "pattern": "^\\d+-\\d+$"} |
configSchema.json | protocol | Protocol to use (eg. TCP or UDP) | {"type": "string", "minLength": 1} |
configSchema.json | type | Type of volume mount | {"type": "string", "enum": ["local"]} |
configSchema.json | local | Path on the host machine to mount | {"type": "string", "minLength": 1} |
configSchema.json | container | Path inside the container to mount the host path at | {"type": "string", "minLength": 1} |
configSchema.json | options | Docker volume mount options to use when creating mount | {"type": "string", "enum": ["cached", "delegated", "consistent", "default", "ro"]} |
configSchema.json | type | Type of volume mount | {"type": "string", "enum": ["cache"]} |
configSchema.json | name | Name of the cache | {"type": "string", "minLength": 1} |
configSchema.json | container | Path inside the container to mount the cache at | {"type": "string", "minLength": 1} |
configSchema.json | options | Docker volume mount options to use when creating mount | {"type": "string", "enum": ["cached", "delegated", "consistent", "default", "ro"]} |
configSchema.json | type | Type of volume mount | {"type": "string", "enum": ["tmpfs"]} |
configSchema.json | container | Path inside the container to mount the tmpfs filesystem at | {"type": "string", "minLength": 1} |
configSchema.json | options | Docker tmpfs mount options to use when creating mount | {"type": "string"} |
configSchema.json | retries | The number of times to perform the health check before considering the container unhealthy | {"type": "integer", "minimum": 0} |
configSchema.json | interval | The interval between runs of the health check. Accepts values such as `2s` (two seconds) or `1m` (one minute). | {"type": "string", "minLength": 1} |
configSchema.json | start_period | The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as `2s` (two seconds) or `1m` (one minute). | {"type": "string", "minLength": 1} |
configSchema.json | timeout | The time to wait before timing out a single health check command invocation. Accepts values such as `2s` (two seconds) or `1m` (one minute). | {"type": "string", "minLength": 1} |
configSchema.json | command | The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy. | {"type": "string", "minLength": 1} |
configSchema.json | enabled | Set to `true` to enable 'run as current user' mode | {"type": "boolean", "enum": [false]} |
configSchema.json | enabled | Set to `true` to enable 'run as current user' mode | {"type": "boolean", "enum": [true]} |
configSchema.json | home_directory | Directory to use as home directory for user inside container | {"type": "string", "minLength": 1} |
configSchema.json | command | Command to execute | {"type": "string", "minLength": 1} |
configSchema.json | working_directory | Working directory to start the command in (defaults to container working directory if not set) | {"type": "string", "minLength": 1} |
configSchema.json | configVariablesList | Definitions for each of the config variables used to configure your tasks and containers | {"type": "object", "additionalProperties": {}} |
configSchema.json | configVariable | Definition of a single config variable | {"type": "object", "additionalProperties": false, "properties": {"default": {"type": "string", "minLength": 1}}} |
configSchema.json | description | Human-readable description of the purpose of the variable | {"type": "string", "minLength": 1} |
configSchema.json | default | Default value of the variable if one is not provided elsewhere | {"type": "string", "minLength": 1} |
configSchema.json | includesList | List of configuration files to include in this project | {"type": "array", "items": {}} |
configSchema.json | include | Path (relative to this file) to the file to include | {"type": "string"} |
configSchema.json | type | The type of include | {"type": "string", "enum": ["file"]} |
configSchema.json | path | Path (relative to this file) of the file to include | {"type": "string", "minLength": 1} |
configSchema.json | type | The type of include | {"type": "string", "enum": ["git"]} |
configSchema.json | repo | Git repository containing the file to include | {"type": "string", "minLength": 1} |
configSchema.json | ref | Git reference (commit, tag or branch) containing the file to include | {"type": "string"} |
configSchema.json | path | Path (relative to the root of the repository) of the file to include (defaults to batect-bundle.yml if not set) | {"type": "string", "minLength": 1} |
ruff.json | msg | The message to display when the API is used. | {"type": "string"} |
ruff.json | Convention | Use Google-style docstrings. | {"type": "string", "enum": ["google"]} |
ruff.json | Convention | Use NumPy-style docstrings. | {"type": "string", "enum": ["numpy"]} |
ruff.json | Convention | Use PEP257-style docstrings. | {"type": "string", "enum": ["pep257"]} |
ruff.json | allow-star-arg-any | Whether to suppress `ANN401` for dynamically typed `*args` and `**kwargs` arguments. | {"type": ["boolean", "null"]} |
ruff.json | ignore-fully-untyped | Whether to suppress `ANN*` rules for any declaration that hasn't been typed at all. This makes it easier to gradually add types to a codebase. | {"type": ["boolean", "null"]} |
ruff.json | mypy-init-return | Whether to allow the omission of a return type hint for `__init__` if at least one argument is annotated. | {"type": ["boolean", "null"]} |
ruff.json | suppress-dummy-args | Whether to suppress `ANN000`-level violations for arguments matching the "dummy" variable regex (like `_`). | {"type": ["boolean", "null"]} |
ruff.json | suppress-none-returning | Whether to suppress `ANN200`-level violations for functions that meet either of the following criteria:
- Contain no `return` statement. - Explicit `return` statement(s) all return `None` (explicitly or implicitly). | {"type": ["boolean", "null"]} |
ruff.json | check-typed-exception | Whether to disallow `try`-`except`-`pass` (`S110`) for specific exception types. By default, `try`-`except`-`pass` is only disallowed for `Exception` and `BaseException`. | {"type": ["boolean", "null"]} |
ruff.json | hardcoded-tmp-directory | A list of directories to consider temporary. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | hardcoded-tmp-directory-extend | A list of directories to consider temporary, in addition to those specified by `hardcoded-tmp-directory`. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extend-immutable-calls | Additional callable functions to consider "immutable" when evaluating, e.g., the `no-mutable-default-argument` rule (`B006`) or `no-function-call-in-dataclass-defaults` rule (`RUF009`). | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | builtins-ignorelist | Ignore list of builtins. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | allow-dict-calls-with-keyword-arguments | Allow `dict` calls that make use of keyword arguments (e.g., `dict(a=1, b=2)`). | {"type": ["boolean", "null"]} |
ruff.json | author | Author to enforce within the copyright notice. If provided, the author must be present immediately following the copyright notice. | {"type": ["string", "null"]} |
ruff.json | min-file-size | A minimum file size (in bytes) required for a copyright notice to be enforced. By default, all files are validated. | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | notice-rgx | The regular expression used to match the copyright notice, compiled with the [`regex`](https://docs.rs/regex/latest/regex/) crate.
Defaults to `(?i)Copyright\s+(\(C\)\s+)?\d{4}(-\d{4})*`, which matches the following: - `Copyright 2023` - `Copyright (C) 2023` - `Copyright 2021-2023` - `Copyright (C) 2021-2023` | {"type": ["string", "null"]} |
ruff.json | max-string-length | Maximum string length for string literals in exception messages. | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | extend-function-names | Additional function names to consider as internationalization calls, in addition to those included in `function-names`. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | function-names | The function names to consider as internationalization calls. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | allow-multiline | Whether to allow implicit string concatenations for multiline strings. By default, implicit concatenations of multiline strings are allowed (but continuation lines, delimited with a backslash, are prohibited).
Note that setting `allow-multiline = false` should typically be coupled with disabling `explicit-string-concatenation` (`ISC003`). Otherwise, both explicit and implicit multiline string concatenations will be seen as violations. | {"type": ["boolean", "null"]} |
ruff.json | aliases | The conventional aliases for imports. These aliases can be extended by the `extend_aliases` option. | {"type": ["object", "null"], "additionalProperties": {"type": "string"}} |
ruff.json | banned-aliases | A mapping from module to its banned import aliases. | {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
ruff.json | banned-from | A list of modules that are allowed to be imported from | {"type": ["array", "null"], "items": {"type": "string"}, "uniqueItems": true} |
ruff.json | extend-aliases | A mapping from module to conventional import alias. These aliases will be added to the `aliases` mapping. | {"type": ["object", "null"], "additionalProperties": {"type": "string"}} |
ruff.json | fixture-parentheses | Boolean flag specifying whether `@pytest.fixture()` without parameters should have parentheses. If the option is set to `true` (the default), `@pytest.fixture()` is valid and `@pytest.fixture` is invalid. If set to `false`, `@pytest.fixture` is valid and `@pytest.fixture()` is invalid. | {"type": ["boolean", "null"]} |
ruff.json | mark-parentheses | Boolean flag specifying whether `@pytest.mark.foo()` without parameters should have parentheses. If the option is set to `true` (the default), `@pytest.mark.foo()` is valid and `@pytest.mark.foo` is invalid. If set to `false`, `@pytest.fixture` is valid and `@pytest.mark.foo()` is invalid. | {"type": ["boolean", "null"]} |
ruff.json | parametrize-names-type | Expected type for multiple argument names in `@pytest.mark.parametrize`. The following values are supported:
- `csv` — a comma-separated list, e.g. `@pytest.mark.parametrize('name1,name2', ...)` - `tuple` (default) — e.g. `@pytest.mark.parametrize(('name1', 'name2'), ...)` - `list` — e.g. `@pytest.mark.parametrize(['name1', 'name2'], ...)` | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | parametrize-values-row-type | Expected type for each row of values in `@pytest.mark.parametrize` in case of multiple parameters. The following values are supported:
- `tuple` (default) — e.g. `@pytest.mark.parametrize(('name1', 'name2'), [(1, 2), (3, 4)])` - `list` — e.g. `@pytest.mark.parametrize(('name1', 'name2'), [[1, 2], [3, 4]])` | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | parametrize-values-type | Expected type for the list of values rows in `@pytest.mark.parametrize`. The following values are supported:
- `tuple` — e.g. `@pytest.mark.parametrize('name', (1, 2, 3))` - `list` (default) — e.g. `@pytest.mark.parametrize('name', [1, 2, 3])` | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | raises-extend-require-match-for | List of additional exception names that require a match= parameter in a `pytest.raises()` call. This extends the default list of exceptions that require a match= parameter. This option is useful if you want to extend the default list of exceptions that require a match= parameter without having to specify the entire list. Note that this option does not remove any exceptions from the default list. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | raises-require-match-for | List of exception names that require a match= parameter in a `pytest.raises()` call. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | avoid-escape | Whether to avoid using single quotes if a string contains single quotes, or vice-versa with double quotes, as per [PEP 8](https://peps.python.org/pep-0008/#string-quotes). This minimizes the need to escape quotation marks within strings. | {"type": ["boolean", "null"]} |
ruff.json | docstring-quotes | Quote style to prefer for docstrings (either "single" or "double"). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | inline-quotes | Quote style to prefer for inline strings (either "single" or "double"). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | multiline-quotes | Quote style to prefer for multiline strings (either "single" or "double"). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | ignore-names | A list of names to ignore when considering `flake8-self` violations. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | ban-relative-imports | Whether to ban all relative imports (`"all"`), or only those imports that extend into the parent module or beyond (`"parents"`). | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | banned-api | Specific modules or module members that may not be imported or accessed. Note that this rule is only meant to flag accidental uses, and can be circumvented via `eval` or `importlib`. | {"type": ["object", "null"], "additionalProperties": {}} |
ruff.json | exempt-modules | Exempt certain modules from needing to be moved into type-checking blocks. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | runtime-evaluated-base-classes | Exempt classes that list any of the enumerated classes as a base class from needing to be moved into type-checking blocks. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | runtime-evaluated-decorators | Exempt classes decorated with any of the enumerated decorators from needing to be moved into type-checking blocks. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | strict | Enforce TC001, TC002, and TC003 rules even when valid runtime imports are present for the same module. See flake8-type-checking's [strict](https://github.com/snok/flake8-type-checking#strict) option. | {"type": ["boolean", "null"]} |
ruff.json | ignore-variadic-names | Whether to allow unused variadic arguments, like `*args` and `**kwargs`. | {"type": ["boolean", "null"]} |
ruff.json | classes | An override list of tokens to always recognize as a Class for `order-by-type` regardless of casing. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | combine-as-imports | Combines as imports on the same line. See isort's [`combine-as-imports`](https://pycqa.github.io/isort/docs/configuration/options.html#combine-as-imports) option. | {"type": ["boolean", "null"]} |
ruff.json | constants | An override list of tokens to always recognize as a CONSTANT for `order-by-type` regardless of casing. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | extra-standard-library | A list of modules to consider standard-library, in addition to those known to Ruff in advance. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | force-single-line | Forces all from imports to appear on their own line. | {"type": ["boolean", "null"]} |
ruff.json | force-sort-within-sections | Don't sort straight-style imports (like `import sys`) before from-style imports (like `from itertools import groupby`). Instead, sort the imports by module, independent of import style. | {"type": ["boolean", "null"]} |
ruff.json | force-to-top | Force specific imports to the top of their appropriate section. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | force-wrap-aliases | Force `import from` statements with multiple members and at least one alias (e.g., `import A as B`) to wrap such that every line contains exactly one member. For example, this formatting would be retained, rather than condensing to a single line:
```python from .utils import ( test_directory as test_directory, test_id as test_id ) ```
Note that this setting is only effective when combined with `combine-as-imports = true`. When `combine-as-imports` isn't enabled, every aliased `import from` will be given its own line, in which case, wrapping is not necessary. | {"type": ["boolean", "null"]} |
ruff.json | forced-separate | A list of modules to separate into auxiliary block(s) of imports, in the order specified. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | known-first-party | A list of modules to consider first-party, regardless of whether they can be identified as such via introspection of the local filesystem. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | known-local-folder | A list of modules to consider being a local folder. Generally, this is reserved for relative imports (`from . import module`). | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | known-third-party | A list of modules to consider third-party, regardless of whether they can be identified as such via introspection of the local filesystem. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | lines-after-imports | The number of blank lines to place after imports. Use `-1` for automatic determination. | {"type": ["integer", "null"], "format": "int"} |
ruff.json | lines-between-types | The number of lines to place between "direct" and `import from` imports. | {"type": ["integer", "null"], "format": "uint", "minimum": 0.0} |
ruff.json | no-lines-before | A list of sections that should _not_ be delineated from the previous section via empty lines. | {"type": ["array", "null"], "items": {}} |
ruff.json | order-by-type | Order imports by type, which is determined by case, in addition to alphabetically. | {"type": ["boolean", "null"]} |
ruff.json | relative-imports-order | Whether to place "closer" imports (fewer `.` characters, most local) before "further" imports (more `.` characters, least local), or vice versa.
The default ("furthest-to-closest") is equivalent to isort's `reverse-relative` default (`reverse-relative = false`); setting this to "closest-to-furthest" is equivalent to isort's `reverse-relative = true`. | {"anyOf": [{}, {"type": "null"}]} |
ruff.json | required-imports | Add the specified import line to all files. | {"type": ["array", "null"], "items": {"type": "string"}} |
ruff.json | section-order | Override in which order the sections should be output. Can be used to move custom sections. | {"type": ["array", "null"], "items": {}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.