Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .changeset/brave-tigers-fly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
"@naverpay/markdown-lint": major
---

### Breaking Changes

- `postinstall` 스크립트 제거로 패키지 설치 시 자동 설정 파일 생성 기능이 제거됨
- 기존: `npm install` 시 `.markdownlint.json` 파일이 프로젝트 루트에 자동 생성
- 변경: 수동으로 설정 파일 생성 필요 또는 `@naverpay/code-style-cli` 사용 권장

### 코드 정리

- `package.json`에서 `postinstall` 스크립트 제거
- npm 배포 대상(`files`)에서 `postInstall` 디렉토리 제외

### 문서 업데이트

- README에 새로운 설치 가이드 추가 (`@naverpay/code-style-cli` 사용 또는 수동 설정 방법 안내)
18 changes: 18 additions & 0 deletions .changeset/gentle-clouds-march.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
"@naverpay/editorconfig": major
---

### Breaking Changes

- `postinstall` 스크립트 제거로 패키지 설치 시 자동 설정 파일 생성 기능이 제거됨
- 기존: `npm install` 시 `.editorconfig` 파일이 프로젝트 루트에 자동 생성
- 변경: 수동으로 설정 파일 복사 필요 또는 `@naverpay/code-style-cli` 사용 권장

### 코드 정리

- `createConfigFile.js`, `index.js` 파일 삭제
- `package.json`에서 `postinstall` 스크립트 제거

### 문서 업데이트

- README에 새로운 설치 가이드 추가 (`@naverpay/code-style-cli` 사용 또는 수동 복사 방법 안내)
15 changes: 8 additions & 7 deletions packages/editorconfig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

## 설치 방법

[`@naverpay/code-style-cli`](../code-style-cli/README.md)를 사용하여 설치하는 것을 권장합니다.

```bash
npm install @naverpay/editorconfig -D
npx @naverpay/code-style-cli
```

## 주의 사항

- pnpm 으로 설치 후 `.editorconfig` 파일이 생성되지 않았다면, `node_modules` 를 삭제 후 [side-effects-cache](https://pnpm.io/npmrc#side-effects-cache) 설정을 false로 하고 다시 설치해주세요.
또는 직접 설치 후 설정 파일을 복사할 수 있습니다.

```bash
pnpm install @naverpay/editorconfig -D --side-effects-cache false
```
```bash
npm install @naverpay/editorconfig -D
cp node_modules/@naverpay/editorconfig/.editorconfig .editorconfig
```
29 changes: 0 additions & 29 deletions packages/editorconfig/createConfigFile.js

This file was deleted.

3 changes: 0 additions & 3 deletions packages/editorconfig/index.js

This file was deleted.

5 changes: 1 addition & 4 deletions packages/editorconfig/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,5 @@
},
"license": "MIT",
"author": "@NaverPayDev/frontend",
"type": "commonjs",
"scripts": {
"postinstall": "node index.js"
}
"type": "commonjs"
}
18 changes: 12 additions & 6 deletions packages/markdown-lint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,24 @@
markdown 파일 검사용 lint 도구입니다.
[DavidAnson/markdownlint](https://github.com/DavidAnson/markdownlint)에서 제공하는 패키지와 규칙을 사용하고 있으며, 몇 가지 rule은 커스텀 되어 있습니다.

## Installation
## 설치 방법

[`@naverpay/code-style-cli`](../code-style-cli/README.md)를 사용하여 설치하는 것을 권장합니다.

```bash
npx @naverpay/code-style-cli
```
npm i @naverpay/markdown-lint -D

또는 직접 설치 후 설정 파일을 생성할 수 있습니다.

```bash
npm install @naverpay/markdown-lint -D
echo '{"extends": "@naverpay/markdown-lint"}' > .markdownlint.jsonc
```

## Config

`@naverpay/markdown-lint`를 설치하면 `postinstall`을 통해 자동으로 `.markdownlint.json`이 생성됩니다.
이미 `.markdownlint.json`이 존재한다면 생성되지 않습니다.

> [markdown-lint config](./.markdownlint.jsonc)는 [jsonc](https://code.visualstudio.com/docs/languages/json#_json-with-comments) 형식으로 작성되어 있어, 주석을 통해 rule에 대한 설명을 확인할 수 있습니다.
> [markdown-lint config](./.markdownlint.jsonc)는 [jsonc](https://code.visualstudio.com/docs/languages/json#_json-with-comments) 형식으로 작성되어 있어, 주석을 통해 rule에 대한 설명을 확인할 수 있습니다.
> 각 규칙의 명세는 [여기](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md)서 확인할 수 있습니다.

## Integrating with IDE
Expand Down
2 changes: 0 additions & 2 deletions packages/markdown-lint/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@
},
"files": [
"cli.js",
"postInstall",
".markdownlint.jsonc"
],
"scripts": {
"postinstall": "node postInstall/index.js",
"test": "jest --config jest.config.js"
},
"dependencies": {
Expand Down