-
Notifications
You must be signed in to change notification settings - Fork 1
Adding extra info about setting custom rules with fortitude #52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 3 commits
dd6affb
182d07a
f140427
a641ef1
16dea3d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,5 @@ build/ | |
build-cmake/ | ||
*Temporary | ||
.vscode | ||
*.egg-info | ||
*.egg-info | ||
.venv |
This file was deleted.
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -6,7 +6,8 @@ A tool for installing, i.e. `pip` or `homebrew` | |||||
|
||||||
## Installation | ||||||
|
||||||
To install fortitude we can utilise the provided `pyproject.toml` by following the instructions in [the pre-commit install instructions](../README.md#pre-commit). The [quickstart page](https://fortitude.readthedocs.io/en/stable/#quickstart) for Fortitude details multiple other ways of installing the tool. | ||||||
To install fortitude we can utilise the provided `requirements.txt` by following the instructions in [the pre-commit install instructions](../../README.md#pre-commit). | ||||||
The [quickstart page](https://fortitude.readthedocs.io/en/stable/#quickstart) for Fortitude details multiple other ways of installing the tool. | ||||||
|
||||||
## Usage in this repo | ||||||
|
||||||
|
@@ -16,7 +17,10 @@ This repo has been formatted with Fortitude. To check this repo with Fortitude, | |||||
fortitude --config-file formatting/fortitude.toml check | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
``` | ||||||
|
||||||
The config file, [fortitude.toml](./fortitude.toml), we have provided in the above command contains our rules which alter the [default fortitude rules](https://fortitude.readthedocs.io/en/stable/rules/). | ||||||
The config file, [fortitude.toml](./fortitude.toml), we have provided in the above command contains our rules which alter the | ||||||
[default fortitude rules](https://fortitude.readthedocs.io/en/stable/rules/). | ||||||
|
||||||
|
||||||
|
||||||
### pre-commit | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,9 @@ | ||||||
[check] | ||||||
# A set of rules we ignore. Fortitude will not enforce these rules. | ||||||
ignore = [ | ||||||
"C003", # 'implicit none' missing 'external' | ||||||
] | ||||||
|
||||||
# A custom maxmum line length for our repo which will effect the | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add details about the cases where this rule does not apply (eg. text-only There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Spelling. |
||||||
# behaviour of rule S001 (line-too-long) | ||||||
line-length = 132 |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
fortitude-lint>=0.7.2 | ||
pre-commit>=4.2.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.