Merge pull request #145 from NaverPayDev/revert-142-feature/141

Revert "[editorconfig, markdown-lint] postinstall 스크립트 제거"

Author: pja9362

.changeset/brave-tigers-fly.md

@@ -4,15 +4,14 @@
 
 ## 설치 방법
 
-[`@naverpay/code-style-cli`](../code-style-cli/README.md)를 사용하여 설치하는 것을 권장합니다.
-
 ```bash
-npx @naverpay/code-style-cli
+npm install @naverpay/editorconfig -D
 ```
 
-또는 직접 설치 후 설정 파일을 복사할 수 있습니다.
+## 주의 사항
 
-```bash
-npm install @naverpay/editorconfig -D
-cp node_modules/@naverpay/editorconfig/.editorconfig .editorconfig
-```
+- 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
+    ```

.changeset/gentle-clouds-march.md

@@ -0,0 +1,29 @@
+#!/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,
+}

packages/editorconfig/README.md

@@ -0,0 +1,3 @@
+const {createConfigFile} = require('./createConfigFile')
+
+createConfigFile(__dirname, '.editorconfig')

packages/editorconfig/createConfigFile.js

@@ -13,5 +13,8 @@
     },
     "license": "MIT",
     "author": "@NaverPayDev/frontend",
-    "type": "commonjs"
+    "type": "commonjs",
+    "scripts": {
+        "postinstall": "node index.js"
+    }
 }

packages/editorconfig/index.js

@@ -3,24 +3,18 @@
 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
 ```
-
-또는 직접 설치 후 설정 파일을 생성할 수 있습니다.
-
-```bash
-npm install @naverpay/markdown-lint -D
-echo '{"extends": "@naverpay/markdown-lint"}' > .markdownlint.jsonc
+npm i @naverpay/markdown-lint -D
 ```
 
 ## Config
 
-> [markdown-lint config](./.markdownlint.jsonc)는 [jsonc](https://code.visualstudio.com/docs/languages/json#_json-with-comments) 형식으로 작성되어 있어, 주석을 통해 rule에 대한 설명을 확인할 수 있습니다.
+`@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에 대한 설명을 확인할 수 있습니다.  
 > 각 규칙의 명세는 [여기](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md)서 확인할 수 있습니다.
 
 ## Integrating with IDE

packages/editorconfig/package.json

@@ -21,9 +21,11 @@
     },
     "files": [
         "cli.js",
+        "postInstall",
         ".markdownlint.jsonc"
     ],
     "scripts": {
+        "postinstall": "node postInstall/index.js",
         "test": "jest --config jest.config.js"
     },
     "dependencies": {