Skip to content

Commit

Permalink
Add more default aliases (#36)
Browse files Browse the repository at this point in the history
* Add fm, fmr, fmc and fmcp aliases
* Deprecate makecol and makeros
* Remove deprecated make aliases from documentation
* Update alias comment
  • Loading branch information
fmauch committed Aug 20, 2024
1 parent d647765 commit ff6cea9
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 22 deletions.
21 changes: 18 additions & 3 deletions bin/rob_folders_source.sh
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,30 @@ fi



# define some legacy aliases from old robot_folders
# define some aliases for robot_folders
RED='\033[0;31m'
NC='\033[0m' # No Color
alias ce="fzirob change_environment"
alias cdr="fzirob cd"
alias cdros="fzirob cd ros"
alias cdcol="fzirob cd colcon"
alias cdmisc="fzirob cd misc"
alias cdhome="fzirob cd"
alias makeros="fzirob make ros"
alias makecol="fzirob make colcon"
alias fm="fzirob make"
alias fmc="fzirob make colcon"
alias fmr="fzirob make ros"
alias fmcp="fzirob make colcon --colcon-args --packages-select"

makeros()
{
echo -e "${RED}\`makeros\` is deprecated. Please use \`fmr\` instead.${NC}"
fzirob make ros
}
makecol()
{
echo -e "${RED}\`makecol\` is deprecated. Please use \`fmc\` instead.${NC}"
fzirob make colcon
}

add_fzi_project()
{
Expand Down
40 changes: 21 additions & 19 deletions docs/aliases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,24 @@ Robot folders aliases
necessarily as easy and logical to remember as for example ``fzirob change_environment``, but once
you get to know them, you'll probably enjoy simply typing ``ce`` instead.

+---------+---------------------------+
| Alias | fzirob command |
+=========+===========================+
| ce | fzirob change_environment |
+---------+---------------------------+
| cdr | fzirob cd |
+---------+---------------------------+
| cdros | fzirob cd ros |
+---------+---------------------------+
| cdcol | fzirob cd colcon |
+---------+---------------------------+
| cdmisc | fzirob cd misc |
+---------+---------------------------+
| cdhome | fzirob cd |
+---------+---------------------------+
| makeros | fzirob make ros |
+---------+---------------------------+
| makecol | fzirob make colcon |
+---------+---------------------------+
+---------+----------------------------------------------------+
| Alias | fzirob command |
+=========+====================================================+
| ce | fzirob change_environment |
+---------+----------------------------------------------------+
| cdr | fzirob cd |
+---------+----------------------------------------------------+
| cdros | fzirob cd ros |
+---------+----------------------------------------------------+
| cdcol | fzirob cd colcon |
+---------+----------------------------------------------------+
| cdmisc | fzirob cd misc |
+---------+----------------------------------------------------+
| cdhome | fzirob cd |
+---------+----------------------------------------------------+
| fm | fzirob make |
+---------+----------------------------------------------------+
| fmc | fzirob make colcon |
+---------+----------------------------------------------------+
| fmcp | fzirob make colcon --colcon-args --packages-select |
+---------+----------------------------------------------------+

0 comments on commit ff6cea9

Please sign in to comment.