Skip to content

[FEAT] directory naming convention 도입하기 #211

@algoORgoal

Description

@algoORgoal

발생한 문제

  • #204에서 import QRDownIcon from "@/assets/QR/qr_down.svg";의 import 경로가 qr 로 되어 있어서 CI pipeline에서 빌드에 실패했다.
  • 로컬 환경에서는 빌드에 문제가 없었으나 CI pipeline에서만 문제가 발생하였다.

원인

macOS/Window의 파일 시스템 동작 방식

  • macOS의 기본 파일 시스템은 APFS/HFS+이다. 따라서 대소문자를 보존하지만 파일 탐색 시에는 구분하지 않는다.(case-insensitve but case-preserving)
  • Window도 macOS와 같이 case-insensitve but case-preserving
  • 예) 파일 탐색시에는 Test.txt와 test.txt를 같은 파일로 취급한다.

CI Pipeline(github actions)의 파일 시스템 동작 방식

  • Linux(Ubuntu)의 기본 파일 시스템은 완전한 case-senstive로, 대소문자를 엄격하게 구분한다.

따라서 로컬(Windows/macOS)는 디렉토리명 QR과 qr을 같은 것으로 인식한다. Github actions의 Linux 환경에서는 QR과 qr을 다른 것으로 인식한다.

AS-IS

  • 현재 몇몇 폴더 이름이 UpperCamelCase로 네이밍되어 있다.
  • 예) QR, SpaceMember

TO-BE

  • 시스템에 따라 상이한 결과를 낼 수 있기 때문에 디렉토리명(폴더명)은 lower-kebab-case로 통일한다.
  • /PullRequests 🚫 => /pull-requests ✅

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions