Unverified Commit beecd6fd authored by Joshua Cannon's avatar Joshua Cannon Committed by GitHub
Browse files

Add --extend-exclude parameter (#2005)

Look ma! I contribute to open source!

Co-authored-by: default avatarRichard Si <63936253+ichard26@users.noreply.github.com>
parent 858225d3
Loading
Loading
Loading
Loading
+11 −19
Changes for README.md: 11 added lines, 19 removed lines.
Original line number Diff line number Diff line
@@ -135,11 +135,17 @@ Options:
                                  hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_bu
                                  ild|buck-out|build|dist)/]

  --extend-exclude TEXT           Like --exclude, but adds additional files
                                  and directories on top of the excluded
                                  ones (useful if you simply want to add to
                                  the default).

  --force-exclude TEXT            Like --exclude, but files and directories
                                  matching this regex will be excluded even
                                  when they are passed explicitly as
                                  arguments.


  --stdin-filename TEXT           The name of the file when passing it through
                                  stdin. Useful to make sure Black will
                                  respect --force-exclude option on some
@@ -151,7 +157,7 @@ Options:

  -v, --verbose                   Also emit messages to stderr about files
                                  that were not changed or were ignored due to
                                  --exclude=.
                                  exclusion patterns.

  --version                       Show the version and exit.
  --config FILE                   Read configuration from FILE path.
@@ -263,7 +269,7 @@ above. What seems like a bug might be intended behaviour.

_Black_ is able to read project-specific default values for its command line options
from a `pyproject.toml` file. This is especially useful for specifying custom
`--include` and `--exclude` patterns for your project.
`--include` and `--exclude`/`--extend-exclude` patterns for your project.

**Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
"No". _Black_ is all about sensible defaults.
@@ -313,25 +319,10 @@ expressions by Black. Use `[ ]` to denote a significant space character.
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
exclude = '''
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
^/(
  (
      \.eggs         # exclude a few common directories in the
    | \.git          # root of the project
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
  | foo.py           # also separately exclude a file named foo.py in
                     # the root of the project
)
^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
'''
```

@@ -616,6 +607,7 @@ Multiple contributions by:
- [Joseph Larson](mailto:larson.joseph@gmail.com)
- [Josh Bode](mailto:joshbode@fastmail.com)
- [Josh Holland](mailto:anowlcalledjosh@gmail.com)
- [Joshua Cannon](mailto:joshdcannon@gmail.com)
- [José Padilla](mailto:jpadilla@webapplicate.com)
- [Juan Luis Cano Rodríguez](mailto:hello@juanlu.space)
- [kaiix](mailto:kvn.hou@gmail.com)
+2 −0
Changes for docs/change_log.md: 2 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -28,6 +28,8 @@

- use lowercase hex strings (#1692)

- added `--extend-exclude` argument (#1571)

#### _Packaging_

- Self-contained native _Black_ binaries are now provided for releases via GitHub
+6 −1
Changes for docs/installation_and_usage.md: 6 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -95,6 +95,11 @@ Options:
                                  when they are passed explicitly as
                                  arguments.

  --extend-exclude TEXT           Like --exclude, but adds additional files
                                  and directories on top of the excluded
                                  ones. (useful if you simply want to add to
                                  the default)

  --stdin-filename TEXT           The name of the file when passing it through
                                  stdin. Useful to make sure Black will
                                  respect --force-exclude option on some
@@ -106,7 +111,7 @@ Options:

  -v, --verbose                   Also emit messages to stderr about files
                                  that were not changed or were ignored due to
                                  --exclude=.
                                  exclusion patterns.

  --version                       Show the version and exit.
  --config FILE                   Read configuration from FILE path.
+4 −18
Changes for docs/pyproject_toml.md: 4 added lines, 18 removed lines.
Original line number Diff line number Diff line
@@ -4,7 +4,8 @@

_Black_ is able to read project-specific default values for its command line options
from a `pyproject.toml` file. This is especially useful for specifying custom
`--include` and `--exclude` patterns for your project.
`--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
project.

**Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
"No". _Black_ is all about sensible defaults.
@@ -54,25 +55,10 @@ expressions by Black. Use `[ ]` to denote a significant space character.
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
exclude = '''
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
^/(
  (
      \.eggs         # exclude a few common directories in the
    | \.git          # root of the project
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
  | foo.py           # also separately exclude a file named foo.py in
                     # the root of the project
)
^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
'''
```

+1 −12
Changes for pyproject.toml: 1 added line, 12 removed lines.
Original line number Diff line number Diff line
@@ -9,19 +9,8 @@
line-length = 88
target-version = ['py36', 'py37', 'py38']
include = '\.pyi?$'
exclude = '''
extend-exclude = '''
/(
    \.eggs
  | \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist

  # The following are specific to Black, you probably don't want those.
  | blib2to3
  | tests/data
Loading