search

RobotWebTools / rclnodejs

Node.js version of ROS 2.0 client
https://docs.ros.org/en/humble/Concepts/Basic/About-Client-Libraries.html?highlight=rclnodejs#community-maintained
Apache License 2.0
316 stars 70 forks source link

Improve UX of msg generation process #759

Closed wayneparrott closed 3 years ago

wayneparrott commented 3 years ago

Improve the rclnodejs message generation experience.

  1. Configure script/generate_messages.js as a nodejs commandline script names generate-ros-messages

  2. Added new README section ROS2 Interface Message Generation. Included are instructions on adding an npm script named generate-ros-messages to an app package that includes rclnodejs as a dependent.

TODO: No tests have been implemented yet. This is a WIP commit for early review.

Fix #750

wayneparrott commented 3 years ago

I reduced this PR down to the following: 1) define a npm binary script in package.json named generate-messages 2) add #! details to generate_messages.js script 3) add section to FAQ.md describing how to generate messages 4) added test case that runs the generate-messages script from root folder of a new node pkg, /node_modules/.bin/generate-messages

It looks like there is a problem with my new test-generate-messages-bin running in CI that I'll track down asap.

coveralls commented 3 years ago

Coverage Status

Coverage decreased (-0.006%) to 91.783% when pulling 3a54764c05026eb6d0f13d0d2b98265c4eab4a4f on wayneparrott:improve_msg_gen_750c into 9c7528b07793c3828ff247bc7c897c06c27050b7 on RobotWebTools:develop.

minggangw commented 3 years ago

Hi @wayneparrott is the PR ready now? because I noticed that there are some conflicts.

wayneparrott commented 3 years ago

@minggangw Work has been a bit busy lately. I'm not sure what's up with CI but test-raw-pub-sub.js is failing on mac. The tests I added for this PR pass consistently on all platforms.

wayneparrott commented 3 years ago

I'm good to go on this PR.