Indicate the usage of generating messages from .idl files #1185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds an informational message to guide users on generating ROS2 JavaScript messages from .idl files. The change introduces a command-line flag detection mechanism and displays a helpful message with documentation link when the --idl flag is not used.
- Adds detection for the
--idlcommand-line argument - Displays informational message with documentation link when IDL generation is not being used
Comments suppressed due to low confidence (1)
scripts/generate_messages.js:22
- [nitpick] The variable name 'useIDL' uses inconsistent casing. Consider renaming to 'useIdl' to follow camelCase naming convention, as 'IDL' is an acronym.
const useIDL = !!process.argv.find((arg) => arg === '--idl');
minggangw
added a commit
that referenced
this pull request
Jul 15, 2025
This PR adds an informational message to guide users on generating ROS2 JavaScript messages from .idl files. The change introduces a command-line flag detection mechanism and displays a helpful message with documentation link when the `--idl` flag is not used. - Adds detection for the `--idl` command-line argument - Displays informational message with documentation link when IDL generation is not being used Fix: #1185
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an informational message to guide users on generating ROS2 JavaScript messages from .idl files. The change introduces a command-line flag detection mechanism and displays a helpful message with documentation link when the
--idlflag is not used.--idlcommand-line argumentFix: #1185