ros2inspector validate
Validate a workspace against architecture rules stored in YAML.
Usage
ros2inspector validate [PATH] [OPTIONS]
PATH is positional and defaults to the current directory. The default policy path is ros2inspector_policy.yaml in the current working directory.
Options
| Option | Default | Description |
|---|---|---|
--policy, -p | ros2inspector_policy.yaml | Policy YAML file |
--fail-on | error | Failure threshold: error, warning, or info |
--format, -f | table | table, json, or yaml |
--no-cache | false | Re-parse source |
Supported rule types
health_threshold, license, naming, dependency, no_circular_deps, maintainer_required, version_not_default, topic_connectivity, node_isolation, service_connectivity, and action_connectivity.
Minimal policy
version: 1
rules:
- type: license
allowed: [Apache-2.0, MIT]
severity: error
- type: no_circular_deps
severity: error
- type: health_threshold
min_score: 70
workspace_min_score: 80
severity: warning
Examples
ros2inspector validate
ros2inspector validate ~/robot_ws --policy ci/policy.yaml
ros2inspector validate --fail-on warning --format json