@mornya/vessel/template/README-CLI.md

Creates/publishes a Node.js module with no build configuration.

# CLI


## Available scripts
`package.json`에 정의된 script 항목에 대한 내용은 아래와 같다.

### `clean`
> 빌드 디렉토리 삭제.
```bash
$ npm run clean
```

### `build`
> 컴파일러를 통해 소스코드를 빌드 후 난독화 하여 `dist` 디렉토리에 출력한다.
```bash
$ npm run build
```

### `watch`
> 컴파일러의 watch 모드로 소스코드 변경을 감시하여 컴파일 한다.
```bash
$ npm run watch
```

### `check`
> 타입스크립트 코드 검증을 위해 컴파일러를 실행한다. `lint-stage` 등에서 필요시 사용한다.
```bash
$ npm run check
```

### `lint`
> Lintest CLI를 실행하여 코드 린트 실행.
```bash
$ npm run lint
```

### `lint:fix`
> Lintest CLI를 실행하여 코드 린트 실행 및 자동 교정한다.
```bash
$ npm run lint:fix
```

### `test`
> Lintest CLI를 실행하여 테스트를 수행한다.
```bash
$ npm run test
```

### `test:watch`
> Lintest CLI를 실행하여 watch mode로 테스트를 수행한다.
```bash
$ npm run test:watch
```

### `test:coverage`
> Lintest CLI를 실행하여 테스트 커버리지 데이터를 수집하여 `/coverage` 디렉토리에 출력한다.
```bash
$ npm run test:coverage
```

### `login`
> NPM 레지스트리로의 퍼블리시를 위한 로그인 처리.<br>
`npm login`에 scope를 선언하여 처리하는 방식과 같다.<br>
레지스트리 경로는 `package.json`의 publishConfig 항목 값이 참조 된다.
```bash
$ npm run login (not "npm login")
```

### `publish`
> 퍼블리시 수행 전 로그인 / 빌드 / 버전체크 등을 먼저 실행 후 정상완료시 퍼블리시가 수행 된다.
```bash
$ npm publish
```

### `sonar`
소나큐브를 이용한 정적 분석이 필요하면 `sonarqube-scanner`를 글로벌 설치 후 아래 명령을 실행하면 된다. 지표 확인은 `sonar-project.properties` 파일 내 정의 된 URL 및 projectKey를 참조한다.
```bash
$ npm run sonar
```