Trouble Shooting

1. PowerShell 스크립트에서 작성한 Literal 한글이 깨짐 (2020-11-02)

문제 상황

  • VS Code에서 .ps1으로 작성한 스크립트에서 Write-Host 명령으로 한글 출력 
    

    1

    		

    Write-Host " $LinkPath 파일이 이미 존재함."
  • Windows Terminal에서 .ps1 파일 실행시키니 아래처럼 깨짐 
    

    1

    		

    C:/Users/hongg/.gitconfig ?뚯씪???대? 議댁옱??
  • 이 상황에서 VS Code 에서 작성한 .ps1 파일의 파일 encoding은 UTF-8
  • [System.Console]::OutputEncoding 명령으로 확인한 PowerShell의 출력 encoding은 cp949 였다. 
    

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    		

    ❯ [System.Console]::OutputEncoding


BodyName          : ks_c_5601-1987
EncodingName      : 한국어
HeaderName        : ks_c_5601-1987
WebName           : ks_c_5601-1987
WindowsCodePage   : 949
IsBrowserDisplay  : True
IsBrowserSave     : True
IsMailNewsDisplay : True
IsMailNewsSave    : True
IsSingleByte      : False
EncoderFallback   : System.Text.InternalEncoderBestFitFallback
DecoderFallback   : System.Text.InternalDecoderBestFitFallback
IsReadOnly        : True
CodePage          : 949
  • 처음엔 단순히 UTF-8로 encoding 된 스트링을 cp949로 출력하여 발생한 문제로 생각했다.
  • 결론적으로 맞긴 하지만 .. 여기에는 더 복잡한 내막이 있었다…

1차 구글링 - 실패

2차 구글링 - 성공

  • 결정적인 링크 : VS Code 및 PowerShell에서 파일 인코딩 이해 > 맞는 인코딩 선택 - MS 공식 문서
  • 위 링크에 이런 말이 있다
    • 주로 Window 애플리케이션 및 Windows PowerShell로 작업하는 경우 BOM이 포함된 UTF-8 또는 UTF-16과 같은 인코딩을 사용하는 것이 좋습니다.
    • Linux 관련 컨텍스트에서 주로 작업하는 경우 BOM이 포함되지 않은 UTF-8을 사용하는 것이 좋습니다.
  • VS Code에서 작성한 .ps1 파일의 저장 형식은 UTF-8이었다. (맨 아래 상태줄 오른쪽에 보면 나옴)
    • 맨 아래 상태줄에서 UTF-8을 클릭하면, 선택항목 중에 Save with Encoding이 나옴
    • 해당 항목 클릭하면, 여러가지 Encoding이 나오는데…
    • 그 중 UTF-8 with BOM을 선택하면 바로 해당 인코딩으로 저장됨.
  • 이걸 UTF-8 with BOM으로 변경하고 실행해 봤다.
  • 결과는 다음과 같다 확인결과

결과 추론 ( 확인된 내용은 아님)

  • 경고!! 일단 아래 내용은 그냥 추론으로 확인된 내용이 아님.

  • .ps1 파일은 주로 Windows에서 사용하므로 BOM이 있는 UTF-8로 저장하는게 좋음.
  • PowerShell에서 BOM이 있는 UTF-8 문서를 자동 인식하여 결과를 UTF-8 디코딩하여 보여줌.
  • .ps1 파일의 encoding이 기본 UTF-8 이라서 인식하지 못하자…
    • Powershell이 기본 출력 encoding으로 그냥 디코딩해버렸고..
    • 결국 한글이 깨지게 됨.
  • UTF-8 with BOM으로인해 PowerShell이 파일 디코딩 형식을 자동으로 이해하자 제대로 한글을 출력해냄.

유니코드 BOM 이란?

  • BOM은 텍스트에서 사용하는 인코딩을 디코더에 알려주기 위해 텍스트의 시작 부분에 표시됨
  • 리눅스에서는 BOM이 널리 사용되지 않는데 기본적으로 UTF-8이 텍스트 인코딩의 표준처럼 여겨지기 때문임.
  • 또한 BOM은 강제사항이 아님 !!
  • 즉, 리눅스에서 BOM이 있을 경우 처리되지 못하는 경우가 발생할 수 있음.
  • 리눅스에서도 대부분은 BOM을 처리할 수 있다고 함.

How to

Module에 Script 작성하기

  • 발췌 소스 : Script Modules from Learning PowerShell > PowerShell 101 > Script modules
  • 어느때 스크립트(.ps1)를 쓰고 어느때 모듈(.psm1)을 쓰나?
  • module autoloading 이용하기
    • $env.PSModulePath -split ';' 명령으로 나오는 다음 경로에 개인 모듈을 넣을수 있다 
      

      1
2
3
4
5
6

      		

      c:\Users\<사용자>\Documents\PowerShell\Modules
c:\Program Files\PowerShell\Modules
c:\Program Files\PowerShell\7\Modules
c:\Program Files\WindowsPowerShell\Modules
c:\Windows\system32\WindowsPowerShell\v1.0\Modules
c:\Program Files\Intel\Wired Networking\
      • line 1 : 개인용 모듈을 넣을 수 있다 ( 나는 이곳을 선호함)
      • line 2,3 : 해당 머신 전체 사용자가 사용한다 (다른 사용자 아이디로 로그인해서 작업하는 경우가 많다면 이곳이 좋다)
      • line 4,5 : posh5.1용 ? + 전체 사용자
      • line 6 : 특정 애플리케이션 용 모듈 전용
    • 위의 경로밑에..
      • 우선 모듈이름(예를들어,MyScriptModule)을 정하고
      • 해당 모듈이름으로 된 폴더를 만들고
      • 그 폴더내에 해당 모듈이름.psm1 (예를들면, MyScriptMoudule.psm1)을 만들면
      • Module autoloading이 동작한다
  • 모든 모듈은 module manifest(.PSD1 확장자)를 가져야 한다