X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/1b189f6cdeca7b1f9669e0152c92875dff7b761a..7fc6ce990669464f5172b63fafa3724f5f308be3:/README.md?ds=inline diff --git a/README.md b/README.md index 12af03f..911d1f9 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,15 @@ black [OPTIONS] [SRC]... Options: -l, --line-length INTEGER Where to wrap around. [default: 88] + --py36 Allow using Python 3.6-only syntax on all input + files. This will put trailing commas in function + signatures and calls also after *args and + **kwargs. [default: per-file auto-detection] + --pyi Format all input files like typing stubs + regardless of file extension (useful when piping + source on standard input). + -S, --skip-string-normalization + Don't normalize string quotes or prefixes. --check 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 @@ -77,18 +86,22 @@ Options: for each file on stdout. --fast / --safe If --fast given, skip temporary sanity checks. [default: --safe] + --include TEXT A regular expression that matches files and + directories that should be included on + recursive searches. On Windows, use forward + slashes for directories. [default: \.pyi?$] + --exclude TEXT A regular expression that matches files and + directories that should be excluded on + recursive searches. On Windows, use forward + slashes for directories. [default: + build/|buck-out/|dist/|_build/|\.git/|\.hg/| + \.mypy_cache/|\.tox/|\.venv/] -q, --quiet Don't emit non-error messages to stderr. Errors are still emitted, silence those with 2>/dev/null. - --pyi Consider all input files typing stubs regardless - of file extension (useful when piping source on - standard input). - --py36 Allow using Python 3.6-only syntax on all input - files. This will put trailing commas in function - signatures and calls also after *args and - **kwargs. [default: per-file auto-detection] - -S, --skip-string-normalization - Don't normalize string quotes or prefixes. + -v, --verbose Also emit messages to stderr about files + that were not changed or were ignored due to + --exclude=. --version Show the version and exit. --help Show this message and exit. ``` @@ -617,13 +630,13 @@ repos: hooks: - id: black args: [--line-length=88, --safe] - python_version: python3.6 + language_version: python3.6 ``` Then run `pre-commit install` and you're ready to go. `args` in the above config is optional but shows you how you can change the line length if you really need to. If you're already using Python -3.7, switch the `python_version` accordingly. Finally, `stable` is a tag +3.7, switch the `language_version` accordingly. Finally, `stable` is a tag that is pinned to the latest release on PyPI. If you'd rather run on master, this is also an option. @@ -698,11 +711,19 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.6b0 +* added `--include` and `--exclude` (#270) + * added `--skip-string-normalization` (#118) +* added `--verbose` (#283) + +* the header output in `--diff` now actually conforms to the unified diff spec + * fixed stdin handling not working correctly if an old version of Click was used (#276) +* *Black* now preserves line endings when formatting a file in place (#258) + ### 18.5b1