https://github.com/colcon/colcon-alias

Extension for colcon to create and modify command aliases
https://github.com/colcon/colcon-alias

colcon

Last synced: about 1 year ago
JSON representation

Extension for colcon to create and modify command aliases

• Host: GitHub
• URL: https://github.com/colcon/colcon-alias
• Owner: colcon
• License: apache-2.0
• Created: 2022-02-03T00:42:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-22T21:38:21.000Z (over 1 year ago)
• Last Synced: 2025-05-17T10:09:57.421Z (about 1 year ago)
• Topics: colcon
• Language: Python
• Homepage: http://colcon.readthedocs.io
• Size: 40 KB
• Stars: 2
• Watchers: 8
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
colcon-alias

============

An extension for `colcon-core `_ to create and modify command aliases.

Aliases condense any number of colcon command invocations made up of a verb followed by all associated arguments down to another 'alias' verb. When invoking the alias verb, additional arguments can be appended to the original invocations.

An example alias called 'bat', short for 'build and test'::

    $ colcon alias bat --command build --command test

    Registered command list for alias 'bat':

      build

      test

    $ colcon bat --packages-select colcon-alias

    Running command alias: colcon build --packages-select colcon-alias

    ...

    Running command alias: colcon test --packages-select colcon-alias

    ...

Another example, an alias for building specific packages::

    $ colcon alias buildpkg --command build --event-handler console_direct+ --packages-select

    Registered command list for alias 'buildpkg':

      build --event-handler console_direct+ --packages-select

    $ colcon buildpkg colcon-alias

    Running command alias: colcon build --event-handler console_direct+ --packages-select colcon-alias

    ...

A list of currently registered aliases can be found in the colcon help text::

    $ colcon --help

    ...

    colcon aliases:

      bat                   build

                            test

      buildpkg              build --event-handler console_direct+ --packages-select

    ...

Note: When using ``colcon-alias`` with the ``colcon-mixin`` extension, the ``--mixin`` command line argument is applied as an argument to ``--command`` and not used as an actual mixin to the ``alias`` verb.