Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/athackst/vscode-ament-task-provider
Ament task provider extension for vscode
https://github.com/athackst/vscode-ament-task-provider
vscode-extension
Last synced: 6 days ago
JSON representation
Ament task provider extension for vscode
- Host: GitHub
- URL: https://github.com/athackst/vscode-ament-task-provider
- Owner: athackst
- License: apache-2.0
- Created: 2021-06-07T02:44:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T01:03:04.000Z (13 days ago)
- Last Synced: 2024-10-24T14:44:59.625Z (13 days ago)
- Topics: vscode-extension
- Language: TypeScript
- Homepage: https://althack.dev/vscode-ament-task-provider
- Size: 4.3 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ROS 2 Ament Task Provider
Provides [problem matchers](https://code.visualstudio.com/docs/editor/tasks#_processing-task-output-with-problem-matchers) for use with ROS 2 projects using the [ament build system](https://docs.ros.org/en/foxy/Concepts/About-Build-System.html?highlight=ament#id3).
## Installation
You can grab this from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=althack.ament-task-provider) or simply search for "ament task provider" in the extensions tab of VS Code.
## Features
Provides the following problem matchers:
- **\$ament-cpplint** — adds errors and warnings reported by [ament_cpplint](https://github.com/ament/ament_lint/blob/master/ament_cpplint/doc/index.rst)
- **\$ament-cppcheck** — adds errors and warnings reported by [ament_cppcheck](https://github.com/ament/ament_lint/blob/master/ament_cmake_cppcheck/doc/index.rst)
- **\$ament-lint-cmake** — adds errors and warnings reported by [ament_lint_cmake](https://github.com/ament/ament_lint/blob/master/ament_cmake_lint_cmake/doc/index.rst)
- **\$ament-flake8** — adds errors and warnings reported by [ament_flake8](https://github.com/ament/ament_lint/blob/master/ament_flake8/doc/index.rst)
- **\$ament-mypy** — adds errors and warnings reported by [ament_mypy](https://github.com/ament/ament_lint/blob/master/ament_mypy/doc/index.rst)
- **\$ament-pep257** — adds errors and warnings reported by [ament_pep257](https://github.com/ament/ament_lint/blob/master/ament_cmake_pep257/doc/index.rst)
- **\$ament-xmllint** — adds errors and warnings reported by [ament_xmllint](https://github.com/ament/ament_lint/blob/master/ament_xmllint/doc/index.rst)
## Usage
**Prerequiesite** You must have the ament linters installed on your system for the appropriate linter to run.
```bash
sudo apt-get install ros-$ROS_DISTRO-ament-lint
```
From the task panel select ament and then the linter you'd like to run.
That's it!
### tasks.json
You can also save the configuration within your workspace like so:
.vscode/tasks.json
```jsonc
{
"version": "2.0.0",
"tasks": [
{
"type": "ament",
"task": "cppcheck", // The name of the problem matcher
"path": "src/", // The path to your source files
"commandOptions": "", // Optional additional command line options
"envSetup": "" // Optional setup to run before liner (ex: source /opt/ros/humble/setup.bash )
"problemMatcher": [
"$ament_cppcheck" // the corresponding problem matcher - can be used independently
],
"label": "ament: cppcheck"
}
]
}
```
### Settings
There is one optional setting that will set the setup script to run before the all of the linters in the workspace. This can be overwritten in the tasks.json file.
## Contributing
Want to contribute to this plugin! See [Contributing](CONTRIBUTING.md) for development details.
## License
This software is licensed under [Apache 2.0](https://github.com/athackst/htmlproofer-action/blob/main/LICENSE).
### Attributions
[Leaf icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/leaf)