shell script 실행 시 "$'\r': command not found" 오류
예를 들어 볼까요? ^^ 윈도우 환경에서 다음과 같이 간단한 shell script를 만들고,
echo "TEST"
이를 WSL 환경, 또는 리눅스 환경에서 실행하면 다음과 같이 오류가 발생합니다.
$ ./test.sh
./test.sh: line 1: $'\r': command not found
TEST
./test.sh: line 3: $'\r': command not found
./test.sh: line 5: syntax error near unexpected token `$'{\r''
'/test.sh: line 5: `{
왜냐하면, 리눅스의 경우 개행 처리가 0x0a('\n') 단일 문자이지만, 윈도우의 경우는 0x0d('\r'), 0x0a('\n') 2개의 문자이기 때문입니다. 게다가 리눅스의 bash 쉘은 '\r' 문자를 파싱해야 할 대상으로 취급하니 문제가 됩니다.
재미있는 것은, 저 규칙이 git으로 관리하는 프로젝트의 경우 혼란스러운 상황을 연출할 수 있습니다.
가령, 윈도우에서 개발하느라 리눅스에서의 사용을 고려해 ".sh" 파일만 특별하게 '\n' 단일 개행을 해서 저장했는데, 이 파일을 다른 윈도우 환경에서 git fetch로 업데이트를 받는 경우 '\r', '\n'으로 자동 변경이 됩니다.
이 규칙은 git의 core.eol / core.autocrlf로 인한 것인데요,
git 에서 CRLF 개행 문자 차이로 인한 문제 해결하기
; https://www.lesstif.com/gitbook/git-crlf-20776404.html
따라서, git fetch로 인한 업데이트 시에 ".sh" 파일의 개행을 윈도우 환경에서도 그대로 받으려면 "core.autocrlf"를 false로 설정해야 합니다.
그런데, 위의 글에 보면 false가 기본 설정이라고 하는데 비주얼 스튜디오와 함께 설치되는 git 클라이언트의 경우에는 기본값이 true로 설정돼 있습니다.
C:\temp> where git
C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\Git\cmd\git.exe
C:\temp> git config --list
error: cannot spawn less: No such file or directory
core.symlinks=false
core.autocrlf=true
color.diff=auto
color.status=auto
color.branch=auto
color.interactive=true
pack.packsizelimit=2g
help.format=html
http.sslcainfo=/ssl/certs/ca-bundle.crt
diff.astextplain.textconv=astextplain
rebase.autosquash=true
filter.lfs.clean=git-lfs clean -- %f
filter.lfs.smudge=git-lfs smudge -- %f
filter.lfs.process=git-lfs filter-process
filter.lfs.required=true
include.path=C:/Program Files (x86)/Git/etc/gitconfig
include.path=C:/Program Files/Git/etc/gitconfig
core.repositoryformatversion=0
core.filemode=false
core.bare=false
core.logallrefupdates=true
core.symlinks=false
core.ignorecase=true
remote.origin.url=ssh://git@git.testgit.com:5000/testusr/test-prj.git
remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
branch.main.remote=origin
branch.main.merge=refs/heads/main
따라서 이런 경우에는 명시적으로 false로 설정해야 합니다.
C:\temp> git config --global core.autocrlf false
이렇게 환경 설정이 되면, 윈도우에서 get fetch해도 해당 .sh 파일을 wsl(또는 리눅스) 환경에서 정상적으로 실행할 수 있습니다.
하지만 개인적으로 저 설정을 다른 개발자 PC에서 일일이 하는 것은 다소 불편한 해결책으로 보입니다. 그보다는, sh 파일에 대한 개행을 특별히 LF만으로 처리할 것이기 때문에 ".gitattributes" 파일을 통해 개행 자동 관리에서 제외하는 설정이 더 나은 듯합니다.
# .gitattributes
*.sh -text
(참고로 이렇게 설정 후, 타 PC의 'git fetch'에 반영하려면 대상 파일이 당연히 변경되어야 합니다. 그렇지 않으면 "git fetch"로는 변경 사항이 없으므로 다시 내려받지 않아 기존 파일이 유지될 뿐입니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]