Skip to content

Commit 4697b9f

Browse files
authored
Merge pull request #59 from BillFarber/task/updateLintingAndFormatting
Update the linting and formatting settings.
2 parents 3ddeb8a + ff6e3b7 commit 4697b9f

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

.vscode/settings.json

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
{
2-
"python.formatting.provider": "black",
3-
"python.linting.enabled": true,
4-
"python.linting.flake8Enabled": true,
5-
"python.linting.flake8Args": [
6-
"--max-line-length=88"
7-
],
2+
"[python]": {
3+
"editor.defaultFormatter": "ms-python.black-formatter",
4+
"editor.formatOnSave": true
5+
},
6+
"python.testing.unittestEnabled": false,
7+
"python.testing.pytestEnabled": true,
88
"python.testing.pytestArgs": [
99
"tests"
1010
],
11-
"python.testing.unittestEnabled": false,
12-
"python.testing.pytestEnabled": true,
11+
"flake8.args": [
12+
"--max-line-length=120"
13+
]
1314
}

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ To try this out locally:
66
- `source .venv/bin/activate` to use that virtual environment.
77
- `poetry install` to install project dependencies.
88

9-
VSCode is recommended for development. You can try [these instructions](https://www.pythoncheatsheet.org/blog/python-projects-with-poetry-and-vscode-part-1)
9+
VSCode is recommended for development.
10+
- For formatting, the project uses the [Black](https://github.com/psf/black) code formatter, and the
11+
[Black Formatter VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter)
12+
is recommended.
13+
- For linting, the project uses the [Flake8](https://flake8.pycqa.org/en/latest/) linter and the
14+
[Flake8 extension](https://marketplace.visualstudio.com/items?itemName=ms-python.flake8) is recommended.
15+
These tools are included in the project by pyproject.toml and the settings are in .vscode/settings.json.
16+
17+
You can also get additional information at
18+
[these instructions](https://www.pythoncheatsheet.org/blog/python-projects-with-poetry-and-vscode-part-1)
1019
for getting setup in VSCode with linting and formatting enabled.
1120

1221
## Running the tests

0 commit comments

Comments
 (0)