[rosidl_gen] Refactor the dot used to generate the JavaScript messages #1014
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
minggangw
changed the title
minggangw
added a commit
that referenced
this pull request
Jan 15, 2025
#1014) `rclnodejs` leverages [`dot`](https://www.npmjs.com/package/dot) to generate the JavaScript classes, representing the ROS messages and wrapping the [`ref`](https://www.npmjs.com/package/@rclnodejs/ref-napi) objects that can read/write from C++ pointer. For a long time, we changed the implementation along with new features introduced into ROS2, so it makes the template itself messy and hard to understand. This patch tries to refactor the template to make it more readable and maintainable, including: 1. Add proper indents for `for`/`if` used by the template to make it easy to understand. 2. Abstract some functionalities into separate functions, like `_setDefaults()`. 3. Add more meaningful comments by ```{{/* */}}```. 4. Remove the consistency checking. Besides, the following changes are made accordingly: 1. Remove the `willCheckConsistency` usage from current JS files. 2. Remove tests related to consistency checking in `test-compound-msg-type-check.js` and `test-security-related.js`. 3. Use `prettier` to format the generated JavaScript files. 4. Pump the generator version to `0.4.0`. Fix: #1015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
rclnodejsleveragesdotto generate the JavaScript classes, representing the ROS messages and wrapping therefobjects that can read/write from C++ pointer. For a long time, we changed the implementation along with new features introduced into ROS2, so it makes the template itself messy and hard to understand.This patch tries to refactor the template to make it more readable and maintainable, including:
for/ifused by the template to make it easy to understand._setDefaults().{{/* */}}.Besides, the following changes are made accordingly:
willCheckConsistencyusage from current JS files.test-compound-msg-type-check.jsandtest-security-related.js.prettierto format the generated JavaScript files.0.4.0.Fix: #1015