Skip to content

Commit

Permalink
Update to accomodate isort 5 release changes.
Browse files Browse the repository at this point in the history
Isort 5 introduced profiles and ensure_newline_before_comments options. Either needs to be added to work correctly with black.
  • Loading branch information
mcsitter authored Jul 21, 2020
1 parent 2c5041c commit e119be4
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions docs/compatible_configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand Down Expand Up @@ -62,7 +63,17 @@ The option `force_grid_wrap = 0` is just to tell isort to only wrap imports that
the `line_length` limit.

Finally, isort should be told to wrap imports when they surpass _Black_'s default limit
of 88 characters via `line_length = 88`.
of 88 characters via `line_length = 88` as well as `ensure_newline_before_comments = True`
to ensure spacing import sections with comments works the same as with _Black_.

---

NOTE

`ensure_newline_before_comments = True` only works since isort >= 5 but does not break previous ones so you can keep it if you are running previous versions. If only isort >= 5 is used you can add `profile = black` instead of all the options since
[profiles](https://timothycrosley.github.io/isort/docs/configuration/profiles/) are available and do the configuring for you.

---

### Formats

Expand All @@ -75,6 +86,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand All @@ -89,6 +101,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand All @@ -100,9 +113,10 @@ line_length = 88
```toml
[tool.isort]
multi_line_output = 3
include_trailing_comma = true
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = true
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand All @@ -117,6 +131,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand Down

0 comments on commit e119be4

Please sign in to comment.