Submodules, you either love them or hate them. The support is getting better for each new Git version, but for some reason there is still no command to remove a submodule from a project. Here is a script to fix that problem.
This file contains 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
| #!/bin/bash | |
| function actual_path() { | |
| if [ [ -z "$1" ] -a [ -d $1 ] ]; then | |
| echo $(cd $1 && test `pwd` = `pwd -P`) | |
| return 0 | |
| else | |
| return 1 | |
| fi | |
| } | |
| function is_submodule() { | |
| local top_level parent_git module_name | |
| if [ -d "$1" ]; then | |
| cd $1 | |
| else | |
| return 1 | |
| fi | |
| # Find the root of this git repo, then check if its parent dir is also a repo | |
| top_level="$(git rev-parse --show-toplevel)" | |
| if [ ! actual_path $toplevel ]; then | |
| top_level="$(cd $top_level && pwd -P)" | |
| fi | |
| module_name="$(basename "$top_level")" | |
| parent_git="$(cd "$top_level/.." && git rev-parse --show-toplevel 2> /dev/null)" | |
| if [[ -n $parent_git ]]; then | |
| return 0 | |
| else | |
| return 1 | |
| fi | |
| } | |
| function is_gitroot() { | |
| if [ "$(pwd -P)" = "$(git rev-parse --show-toplevel)" ]; then | |
| return 0 | |
| else | |
| return 1 | |
| fi | |
| } | |
| # first check if it's a valid path | |
| if [ ! -d "$1" ]; then | |
| echo "Usage: git subrm <path>" | |
| exit | |
| fi | |
| # then check whether we're at git root | |
| if is_gitroot; then | |
| # finally check whether the given path is a submodule | |
| if $(is_submodule "${1}"); then | |
| echo "let's remove those submodules" | |
| # using ${1%/} to remove trailing slashes | |
| git config -f .gitmodules --remove-section submodule.${1%/} | |
| git config -f .git/config --remove-section submodule.${1%/} | |
| git rm --cached ${1%/} | |
| rm -rf ${1%/} | |
| else | |
| echo "git subrm is not recursive yet, aborting." | |
| fi | |
| else | |
| echo "You need to run this command from the toplevel of the working tree." | |
| fi |
by Most of the script consists of sanity checks. The interesting part is in lines 57-60. The submodule information needs to be removed from two different config files, then removed from the main Git repo, and finally the checked out files are removed. You can of course do this manually, but using this script is easier and less error prone.
Add this to the alias section of your .gitconfig file to make it even more convenient:
subrm = !~/bin/git-subrm.sh
Now you can simply use git subrm <submodule path> and be done with it. Awesome!