Flutter 🧱Mason Brick 사용해보기

Mason 이란?

Mason은 Brick (벽돌) 이라는 사용자 정의 템플릿으로 코드를 생성하는 오픈소스 도구 입니다.

간단히 말해서 프로젝트 폴더 구조와 파일을 만들고 모든 프로젝트에서 전역적으로 사용 할 수 있습니다.

Install

# homebrew에서 설치 
$ brew tap felangel/mason 
$ brew install mason

Mason 시작하기

먼저 Flutter 프로젝트의 루트 폴더에서 mason_bricks 라는 이름의 폴더를 만들겠습니다.

그런다음 Android Studio or IntelliJ IDE 에서 터미널을 실행하여 아래의 명령어를 실행하여 Mason 프로젝트를 초기화 합니다.

$ mason init

.mason 디렉토리와 함께 mason.yaml 파일이 생성됩니다.
mason.yaml 은 pubspec.yaml 과 비슷합니다.
brick에 대한 경로를 지정 할 수 있습니다. (로컬 경로 또는Github 주소)

mason.yaml 파일

이제 본격적으로 템플릿을 만들어 보겠습니다.

1. 프로젝트의 루트 폴더에 bricks 라는 새 폴더를 만듭니다.
2. 해당 폴더에 새 템플릿을 만듭니다.

명령어는 다음과 같습니다.

$ mkdir bricks
$ cd bricks
$ mason new {{brick name}} // brick name 에 원하는 템플릿 이름을 넣어주세요

다음과 같이 폴더와 파일이 생성 되었습니다.

폴더 및 파일 설명

1. __brick__ : 이 폴더에는 brick(벽돌)을 만드는 데 필요한 템플릿 파일과 폴더가 포함됩니다.
2. brick.yaml : 이 파일에는 brick을 생성하는 데 필요한 필수 패키지 및 변수가 포함되어 있습니다.
3. CHANGELOG.md : 이 파일은 변경 사항을 기록하는 데 사용됩니다.
4. LICENSE : 이 파일에는 브릭의 라이선스 세부 정보가 포함되어 있습니다.
5. README.md : 이 파일에는 마크다운 형식의 블록 문서가 포함되어 있습니다.

Template 구조

우리의 기능 이름이 Catalog 라면 폴더 구조는 다음과 같습니다

├── catalog_page_vm.dart
├── catalog_screen.dart
├── entity
│   └── catalog_entity.dart
├── usecase
│   └── get_catalog_usecase.dart
├── repository
│   └── catalog_repository.dart

실제 구조

{{name}} 은 터미널에서 입력한 변수 입니다.

기본 개념은 일반적으로 작성하는 것과 동일한 코드를 작성하는 것입니다. Mason이 {{variable}} 를 변수로 변경합니다.

{{name}}_screen.dart 의 샘플 코드 구조

메이슨 실행 (brick 폴더에서 실행)

mason get
mason make clean_arch_feature

메이슨 전역으로 사용하기

mason add --global clean_arch_feature

좀 더 Mason 에 대해서 알아보기 위해서는

https://github.com/felangel/mason/tree/master/packages/mason_cli#readme 의 문서를 읽어보시면 도움이 될 것 같습니다.

감사합니다 : )