Skip to content

pkg create --build-type ament_python should warn about hyphens in pkg-name #715

@krsche

Description

@krsche

Bug report

Required Info:

  • Operating System:
    • Ubuntu 22.04
  • Installation type:
    • binaries
  • Version or commit hash:
    • humble
  • DDS implementation:
    • /
  • Client library (if applicable):
    • ros2cli

Steps to reproduce issue

cd src
ros2 pkg create --build-type ament_python --license MIT --node-name hello-world  hello-world-python-1   # build breaks
ros2 pkg create --build-type ament_python --license MIT --node-name hello_world  hello-world-python-2   # build breaks
ros2 pkg create --build-type ament_python --license MIT --node-name hello-world  hello_world_python_3   # build breaks
ros2 pkg create --build-type ament_python --license MIT --node-name hello_world  hello_world_python_4   # build works
cd ..
colcon build --packages-select hello-world-python-1 # breaks
colcon build --packages-select hello-world-python-2 # breaks
colcon build --packages-select hello_world_python_3 # breaks
colcon build --packages-select hello_world_python_4 # works

Expected behavior

When running ros2 pkg create with --build-type ament_python warn about hyphens in the name / or abort pkg creation.

Actual behavior

No warning

Additional information

Not really a bug of ros2cli but also not really a feature request. I'd expect a warning, thats why I put it as a bug report.
I assume the check can easily be added here.

If there is agreement on that, I can open a PR with it. Please let me know :)

For reference: PEP-8: Package and Module Names

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions