X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/7c851dfa2c2a8f0bf4c529d7f6faa43798d04325..4ea75cd49521ed7fd8384e7a739e1abb1b6de46a:/docs/usage_and_configuration/the_basics.md?ds=inline diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index 0b2cd3b..fd39b6c 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -26,13 +26,13 @@ python -m black {source_file_or_directory} ### Command line options -_Black_ has quite a few knobs these days, although _Black_ is opinionated so style -configuration options are deliberately limited and rarely added. You can list them by -running `black --help`. +The CLI options of _Black_ can be displayed by expanding the view below or by running +`black --help`. While _Black_ has quite a few knobs these days, it is still opinionated +so style options are deliberately limited and rarely added.
-Help output +CLI reference ```{program-output} black --help @@ -68,13 +68,6 @@ $ black --code "print ( 'hello, world' )" print("hello, world") ``` -```{warning} ---check, --diff, and --safe / --fast have no effect when using -c / --code. Safety -checks normally turned on by default that verify _Black_'s output are disabled as well. -This is a bug which we intend to fix eventually. More details can be found in this [bug -report](https://github.com/psf/black/issues/2104). -``` - ### Writeback and reporting By default _Black_ reformats the files given and/or found in place. Sometimes you need @@ -174,15 +167,28 @@ $ black src/ -q error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio ``` -### Getting the version +### Versions You can check the version of _Black_ you have installed using the `--version` flag. ```console $ black --version -black, version 21.5b0 +black, version 21.12b0 ``` +An option to require a specific version to be running is also provided. + +```console +$ black --required-version 21.9b0 -c "format = 'this'" +format = "this" +$ black --required-version 31.5b2 -c "still = 'beta?!'" +Oh no! 💥 💔 💥 The required version does not match the running version! +``` + +This is useful for example when running _Black_ in multiple environments that haven't +necessarily installed the correct version. This option can be set in a configuration +file for consistent results across environments. + ## Configuration via a file _Black_ is able to read project-specific default values for its command line options