https://github.com/franneck94/vscode-c-cpp-config
https://github.com/franneck94/vscode-c-cpp-config
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/franneck94/vscode-c-cpp-config
- Owner: franneck94
- License: mit
- Created: 2023-05-11T09:07:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T19:51:30.000Z (about 1 year ago)
- Last Synced: 2025-04-02T14:03:07.550Z (6 months ago)
- Language: Python
- Size: 546 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VSCode C/C++ Config
Creates config files with pre-defined settings for modern C/C++ projects.
The following file will be created in the local .vscode folder, this might override the already present file:
- settings.json: Best default settings for C/C++, CMake etc. extensions
The following files will be created in the root directory, if they are not yet present*:
- .clang-format: Configuration for the formatting tool
- .clang-tidy: Configuration for the static linting tool
- .editorconfig: Standard editor settings (line-feed, insert new-line, etc.)
- .gitattributes: Gives attributes to pathnames
- .gitignore: Specifies intentionally untracked files to ignore
The following files will be created when the root dir contains a CMakeLists.txt, if they are not yet present*:
- .pre-commit-config.yaml
- .cmake-format.yaml
- tools/run-clang-format.py
- tools/run-clang-tidy.py
- .github/workflows/documentation.yaml
- .github/workflows/macos.yaml
- .github/workflows/pre-commit.yaml
- .github/workflows/ubuntu.yaml
- .github/workflows/windows.yaml
(*) If you still want to have them overridden, just delete them beforehand and execute the generate config files command again.
## How to use
Just run the command:
- 'Generate C Config Files'
- 'Generate C++ Config Files'
in VSCode's command palette (F1).
## Settings
- ⚙️ Line Length: Max. line length for the clang format tool (defaults to 120, Global Setting)
- ⚙️ Aggressive Settings: If auto formatting should be turned on (defaults to false, Global Setting)
## Release Notes
Refer to the [CHANGELOG](CHANGELOG.md).
## License
Copyright (C) 2022-2024 Jan Schaffranek.
Licensed under the [MIT License](LICENSE).