Skip to content

DOC: describe using astyle within vscode #179

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.

Sign up for GitHub

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

Merged
aaronjridley merged 1 commit into from
Sep 3, 2025
Merged

DOC: describe using astyle within vscode #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,20 @@ on WSL with Ubuntu, the command seems to be:

astyle --options=.astylerc src/*.cpp

#### Linting
Astyle can also be used within VSCode as an extension. Install the "Astyle" extension (author: Chieh Yu). Then go to settings (the "Manage" wheel on the bottom left, then click on "settings"). Under "Extensions", click on "Astyle Configuration". Within that, you can set the location of the astylerc file. Click on "Edit in settings.json". Modify the file so it has the following line:
"[cpp]": {
"editor.defaultFormatter": "chiehyu.vscode-astyle",
"editor.formatOnSave": true
},
"astyle.astylerc": "${workspaceRoot}/.astylerc"

For *C++* code make sure to use a static code checker like
[cpplint](https://github.com/cpplint/cpplint) to check the code for
any style issues before submitting. For *Python*,
[flake8](https://flake8.pycqa.org/en/latest/) is a good option. Both
of these may by installed using pip.
This should then allow you to format the code using the defaults that we have set in the astyle file. This can be done with (Ctrl-Shift-I for Linux, Alt-Shift-F for Windows) and upon saving the file - this reformats the whole file to put it into the astyle format.

To install `cpplint`
#### Linting

```sh
# depending on your system one of these lines applies
pip install --user cpplint
pip install cpplint
python3 -m pip cpplint
python3 -m pip --user cpplint
```
For *Python*,
[flake8](https://flake8.pycqa.org/en/latest/) is a good option. This may by installed using pip.

Using a linter in an editor is a good supplement, but not a replacement for the
static linters. The linter in the 'atom' editor requires that you install the
`linter` and `gcc-linter` packages. Atom also has additional packages
`whitespaces` and `tabs-to-spaces` to automatically remove whitespaces at the
end of the lines, and convert tabs to spaces.

## Commit Styling

Expand Down
Loading