diff --git a/.changeset/brave-monkey-remove.md b/.changeset/brave-monkey-remove.md new file mode 100644 index 0000000..7913579 --- /dev/null +++ b/.changeset/brave-monkey-remove.md @@ -0,0 +1,16 @@ +--- +"@naverpay/editorconfig": major +--- + +postinstall 스크립트 제거 + +**Breaking Changes** + +- `postinstall` 스크립트가 제거되어 설치 시 `.editorconfig` 파일이 자동으로 생성되지 않습니다 +- 기존: `npm install` 시 자동으로 `.editorconfig` 파일 생성 +- 변경: [`@naverpay/code-style-cli`](../code-style-cli/README.md) 사용 또는 수동으로 파일 복사 필요 + +**문서 업데이트** + +- README에 권장 설치 방법 추가 (`@naverpay/code-style-cli` 사용) +- 수동 설치 방법 안내 추가 diff --git a/.changeset/gentle-tiger-simplify.md b/.changeset/gentle-tiger-simplify.md new file mode 100644 index 0000000..63114fa --- /dev/null +++ b/.changeset/gentle-tiger-simplify.md @@ -0,0 +1,16 @@ +--- +"@naverpay/markdown-lint": major +--- + +postinstall 스크립트 제거 + +**Breaking Changes** + +- `postinstall` 스크립트가 제거되어 설치 시 `.markdownlint.json` 파일이 자동으로 생성되지 않습니다 +- 기존: `npm install` 시 자동으로 `.markdownlint.json` 파일 생성 +- 변경: [`@naverpay/code-style-cli`](../code-style-cli/README.md) 사용 또는 수동으로 설정 파일 생성 필요 + +**문서 업데이트** + +- README에 권장 설치 방법 추가 (`@naverpay/code-style-cli` 사용) +- 수동 설치 방법 안내 추가 (`.markdownlint.jsonc` extends 사용) diff --git a/packages/editorconfig/README.md b/packages/editorconfig/README.md index 66038a0..856194d 100644 --- a/packages/editorconfig/README.md +++ b/packages/editorconfig/README.md @@ -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 +``` diff --git a/packages/editorconfig/createConfigFile.js b/packages/editorconfig/createConfigFile.js deleted file mode 100644 index d0c6527..0000000 --- a/packages/editorconfig/createConfigFile.js +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/env node -/* eslint-disable no-console */ -const {execSync} = require('child_process') -const fs = require('fs') -const path = require('path') - -const createConfigFile = (dirname, fileName, destFileName = fileName) => { - try { - const source = path.join(dirname, fileName) - const config = fs.readFileSync(source) - - const gitRoot = execSync('git rev-parse --show-toplevel').toString().trim() - const dest = path.join(gitRoot, destFileName) - - if (fs.existsSync(dest)) { - process.exit(0) - } - fs.writeFileSync(dest, config) - console.log(`${destFileName} is created successfully`) - } catch (error) { - console.log(`Failed to create ${destFileName}`) - console.log(error?.message) - process.exit(0) - } -} - -module.exports = { - createConfigFile, -} diff --git a/packages/editorconfig/index.js b/packages/editorconfig/index.js deleted file mode 100644 index 747492b..0000000 --- a/packages/editorconfig/index.js +++ /dev/null @@ -1,3 +0,0 @@ -const {createConfigFile} = require('./createConfigFile') - -createConfigFile(__dirname, '.editorconfig') diff --git a/packages/editorconfig/package.json b/packages/editorconfig/package.json index a662e7b..05d049f 100644 --- a/packages/editorconfig/package.json +++ b/packages/editorconfig/package.json @@ -13,8 +13,5 @@ }, "license": "MIT", "author": "@NaverPayDev/frontend", - "type": "commonjs", - "scripts": { - "postinstall": "node index.js" - } + "type": "commonjs" } diff --git a/packages/markdown-lint/README.md b/packages/markdown-lint/README.md index dc297d9..c741440 100644 --- a/packages/markdown-lint/README.md +++ b/packages/markdown-lint/README.md @@ -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 diff --git a/packages/markdown-lint/package.json b/packages/markdown-lint/package.json index bc727e1..47103da 100644 --- a/packages/markdown-lint/package.json +++ b/packages/markdown-lint/package.json @@ -21,11 +21,9 @@ }, "files": [ "cli.js", - "postInstall", ".markdownlint.jsonc" ], "scripts": { - "postinstall": "node postInstall/index.js", "test": "jest --config jest.config.js" }, "dependencies": {