fms-fe-core-modules

Description

imas-fe core module packages

사용 기술

• pnpm
• parcel
• typescript

초기 설정 & 실행

1. pnpm & dependencies 설치

npm install -g pnpm
pnpm install

• pnpm으로 모노레포를 관리하기 때문에 pnpm 이외의 package manager를 사용하면 안됩니다.
• "preinstall": "npx only-allow pnpm" 을 설정하여 스크립트 실행전 pnpm 사용여부 체크

2. 배포할 모듈 추가 및 변경

• packages 하위 디렉토리의 src 폴더에서 작업

• src/index.ts에서 import 및 export

• 예시

  // packages/utils/src/print.ts
  
  export function printHello(name: string) {
    console.log(`Hello, ${name}`);
  }

  // packages/utils/src/index.ts
  
  import { printHello } from "./print";
  
  export { printHello };

3. 버전 수정

• 배포 전 변경된 packages 하위 디렉토리의 package.json 버전을 수정
• 버전 규칙은 상의해서 결정
• 현재(초기 버전)는 0.0.2로 배포되어 있습니다.
• 예시

  // packages/utils/package.json
  {
    "name": "@imasdev/utils",
    "version": "수정할 버전",
    "description": "util functions",
    "source": "src/index.ts",
    "main": "dist/index.js",
    "module": "dist/index.module.js",
    "types": "dist/index.d.ts",
    "files": ["dist"],
    "sideEffects": false,
    "keywords": [],
    "author": "imasdev",
    "license": "ISC",
    "repository": {
      "type": "git",
      "url": "https://github.com/imasdev/fms-fe-core-modules"
    },
    "publishConfig": {
      "@imasdev:registry": "https://npm.pkg.github.com"
    }
  }

4. 빌드 & 배포

   pnpm은 자체적으로 workspace를 이용하기 때문에 directory 별로 배포를 진행하는 별도의 명령어 (yarn workspaces ~ foreach ...)를 실행할 필요가 없습니다.

• recursive publish

  • 현재 디렉토리에 있는 모든 패키지를 재귀적으로 찾아 배포 (워크스페이스에 있는 모든 패키지 배포)
  • 하위 패키지에 있는 종속성도 함께 배포됨

• 현재 작업중인 모든 변경 사항을 commit 또는 push해야 배포가 가능합니다.

  pnpm build
  pnpm recursive publish

모노레포 github pacakges 초기 세팅 문서

초기 세팅 가이드 문서입니다.

github packages 모노레포 초기 세팅 가이드