|
| 1 | +{ |
| 2 | + "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | + "$id": "https://github.com/google/pyink/blob/pyink/src/pyink/resources/pyink.schema.json", |
| 4 | + "$comment": "tool.pyink table in pyproject.toml", |
| 5 | + "type": "object", |
| 6 | + "additionalProperties": false, |
| 7 | + "properties": { |
| 8 | + "code": { |
| 9 | + "type": "string", |
| 10 | + "description": "Format the code passed in as a string." |
| 11 | + }, |
| 12 | + "line-length": { |
| 13 | + "type": "integer", |
| 14 | + "description": "How many characters per line to allow.", |
| 15 | + "default": 80 |
| 16 | + }, |
| 17 | + "target-version": { |
| 18 | + "type": "array", |
| 19 | + "items": { |
| 20 | + "enum": [ |
| 21 | + "py33", |
| 22 | + "py34", |
| 23 | + "py35", |
| 24 | + "py36", |
| 25 | + "py37", |
| 26 | + "py38", |
| 27 | + "py39", |
| 28 | + "py310", |
| 29 | + "py311", |
| 30 | + "py312", |
| 31 | + "py313" |
| 32 | + ] |
| 33 | + }, |
| 34 | + "description": "Python versions that should be supported by Pyink's output. You should include all versions that your code supports. By default, Pyink will infer target versions from the project metadata in pyproject.toml. If this does not yield conclusive results, Pyink will use per-file auto-detection." |
| 35 | + }, |
| 36 | + "pyi": { |
| 37 | + "type": "boolean", |
| 38 | + "description": "Format all input files like typing stubs regardless of file extension. This is useful when piping source on standard input.", |
| 39 | + "default": false |
| 40 | + }, |
| 41 | + "ipynb": { |
| 42 | + "type": "boolean", |
| 43 | + "description": "Format all input files like Jupyter Notebooks regardless of file extension. This is useful when piping source on standard input.", |
| 44 | + "default": false |
| 45 | + }, |
| 46 | + "python-cell-magics": { |
| 47 | + "type": "array", |
| 48 | + "items": { |
| 49 | + "type": "string" |
| 50 | + }, |
| 51 | + "description": "When processing Jupyter Notebooks, add the given magic to the list of known python-magics (capture, prun, pypy, python, python3, time, timeit). Useful for formatting cells with custom python magics." |
| 52 | + }, |
| 53 | + "skip-source-first-line": { |
| 54 | + "type": "boolean", |
| 55 | + "description": "Skip the first line of the source code.", |
| 56 | + "default": false |
| 57 | + }, |
| 58 | + "skip-string-normalization": { |
| 59 | + "type": "boolean", |
| 60 | + "description": "Don't normalize string quotes or prefixes.", |
| 61 | + "default": false |
| 62 | + }, |
| 63 | + "skip-magic-trailing-comma": { |
| 64 | + "type": "boolean", |
| 65 | + "description": "Don't use trailing commas as a reason to split lines.", |
| 66 | + "default": false |
| 67 | + }, |
| 68 | + "preview": { |
| 69 | + "type": "boolean", |
| 70 | + "description": "Enable potentially disruptive style changes that may be added to Pyink's main functionality in the next major release.", |
| 71 | + "default": false |
| 72 | + }, |
| 73 | + "unstable": { |
| 74 | + "type": "boolean", |
| 75 | + "description": "Enable potentially disruptive style changes that have known bugs or are not currently expected to make it into the stable style Pyink's next major release. Implies --preview.", |
| 76 | + "default": false |
| 77 | + }, |
| 78 | + "enable-unstable-feature": { |
| 79 | + "type": "array", |
| 80 | + "items": { |
| 81 | + "enum": [ |
| 82 | + "hex_codes_in_unicode_sequences", |
| 83 | + "string_processing", |
| 84 | + "hug_parens_with_braces_and_square_brackets", |
| 85 | + "unify_docstring_detection", |
| 86 | + "no_normalize_fmt_skip_whitespace", |
| 87 | + "wrap_long_dict_values_in_parens", |
| 88 | + "multiline_string_handling", |
| 89 | + "typed_params_trailing_comma", |
| 90 | + "is_simple_lookup_for_doublestar_expression", |
| 91 | + "docstring_check_for_newline", |
| 92 | + "remove_redundant_guard_parens", |
| 93 | + "parens_for_long_if_clauses_in_case_block" |
| 94 | + ] |
| 95 | + }, |
| 96 | + "description": "Enable specific features included in the `--unstable` style. Requires `--preview`. No compatibility guarantees are provided on the behavior or existence of any unstable features." |
| 97 | + }, |
| 98 | + "check": { |
| 99 | + "type": "boolean", |
| 100 | + "description": "Don't write the files back, just return the status. Return code 0 means nothing would change. Return code 1 means some files would be reformatted. Return code 123 means there was an internal error.", |
| 101 | + "default": false |
| 102 | + }, |
| 103 | + "diff": { |
| 104 | + "type": "boolean", |
| 105 | + "description": "Don't write the files back, just output a diff to indicate what changes Pyink would've made. They are printed to stdout so capturing them is simple.", |
| 106 | + "default": false |
| 107 | + }, |
| 108 | + "color": { |
| 109 | + "type": "boolean", |
| 110 | + "description": "Show (or do not show) colored diff. Only applies when --diff is given.", |
| 111 | + "default": false |
| 112 | + }, |
| 113 | + "fast": { |
| 114 | + "type": "boolean", |
| 115 | + "description": "By default, Pyink performs an AST safety check after formatting your code. The --fast flag turns off this check and the --safe flag explicitly enables it. [default: --safe]", |
| 116 | + "default": false |
| 117 | + }, |
| 118 | + "required-version": { |
| 119 | + "type": "string", |
| 120 | + "description": "Require a specific version of Pyink to be running. This is useful for ensuring that all contributors to your project are using the same version, because different versions of Pyink may format code a little differently. This option can be set in a configuration file for consistent results across environments." |
| 121 | + }, |
| 122 | + "exclude": { |
| 123 | + "type": "string", |
| 124 | + "description": "A regular expression that matches files and directories that should be excluded on recursive searches. An empty value means no paths are excluded. Use forward slashes for directories on all platforms (Windows, too). By default, Pyink also ignores all paths listed in .gitignore. Changing this value will override all default exclusions. [default: /(\\.direnv|\\.eggs|\\.git|\\.hg|\\.ipynb_checkpoints|\\.mypy_cache|\\.nox|\\.pytest_cache|\\.ruff_cache|\\.tox|\\.svn|\\.venv|\\.vscode|__pypackages__|_build|buck-out|build|dist|venv)/]" |
| 125 | + }, |
| 126 | + "extend-exclude": { |
| 127 | + "type": "string", |
| 128 | + "description": "Like --exclude, but adds additional files and directories on top of the default values instead of overriding them." |
| 129 | + }, |
| 130 | + "force-exclude": { |
| 131 | + "type": "string", |
| 132 | + "description": "Like --exclude, but files and directories matching this regex will be excluded even when they are passed explicitly as arguments. This is useful when invoking Pyink programmatically on changed files, such as in a pre-commit hook or editor plugin." |
| 133 | + }, |
| 134 | + "include": { |
| 135 | + "type": "string", |
| 136 | + "description": "A regular expression that matches files and directories that should be included on recursive searches. An empty value means all files are included regardless of the name. Use forward slashes for directories on all platforms (Windows, too). Overrides all exclusions, including from .gitignore and command line options.", |
| 137 | + "default": "(\\.pyi?|\\.ipynb)$" |
| 138 | + }, |
| 139 | + "workers": { |
| 140 | + "type": "integer", |
| 141 | + "description": "When Pyink formats multiple files, it may use a process pool to speed up formatting. This option controls the number of parallel workers. This can also be specified via the PYINK_NUM_WORKERS environment variable. Defaults to the number of CPUs in the system." |
| 142 | + }, |
| 143 | + "quiet": { |
| 144 | + "type": "boolean", |
| 145 | + "description": "Stop emitting all non-critical output. Error messages will still be emitted (which can silenced by 2>/dev/null).", |
| 146 | + "default": false |
| 147 | + }, |
| 148 | + "verbose": { |
| 149 | + "type": "boolean", |
| 150 | + "description": "Emit messages about files that were not changed or were ignored due to exclusion patterns. If Pyink is using a configuration file, a message detailing which one it is using will be emitted.", |
| 151 | + "default": false |
| 152 | + } |
| 153 | + } |
| 154 | +} |
0 commit comments