[eslint-plugin] peer-deps-in-dev-deps

.changeset/big-geese-change.md

@@ -0,0 +1,7 @@
+---
+"@naverpay/eslint-plugin": patch
+---
+
+improve report location in peer-deps-in-dev-deps
+
+PR: [[eslint-plugin] peer-deps-in-dev-deps](https://github.com/NaverPayDev/code-style/pull/102)

.changeset/polite-carpets-raise.md

@@ -0,0 +1,9 @@
+---
+"@naverpay/eslint-plugin": patch
+"@naverpay/prettier-config": patch
+"@naverpay/stylelint-config": patch
+---
+
+Add dependency in peerDependencies into devDependencies
+
+PR: [[eslint-plugin] peer-deps-in-dev-deps](https://github.com/NaverPayDev/code-style/pull/102)

eslint.config.mjs

@@ -1,9 +1,17 @@
 import naverpay from '@naverpay/eslint-config'
+import naverpayPlugin from '@naverpay/eslint-plugin'
 
 export default [
     {
         ignores: ['**/dist/**'],
     },
     ...naverpay.configs.node,
     ...naverpay.configs.packageJson,
+    {
+        files: ['**/package.json'],
+        plugins: {'@naverpay': naverpayPlugin},
+        rules: {
+            '@naverpay/peer-deps-in-dev-deps': 'error',
+        },
+    },
 ]

packages/eslint-plugin/docs/peer-deps-in-dev-deps.md

@@ -71,16 +71,43 @@
 
 ## 설정
 
-```json
-{
-  "rules": {
-    "@naverpay/peer-deps-in-dev-deps": "error"
-  }
-}
+```js
+import naverpayPlugin from '@naverpay/eslint-plugin'
+
+// eslint.config.js
+export default [
+  {
+    files: ["**/package.json"],
+    plugins: {'@naverpay': naverpayPlugin},
+    rules: {
+      '@naverpay/peer-deps-in-dev-deps': 'error',
+    },
+  },
+]
 ```
 
 ## 제한
 
 - 이 규칙은 수정(fixable) 기능을 제공하지 않으므로, 자동으로 `devDependencies`에 패키지를 추가해주지 않습니다. 경고 혹은 에러를 보고하면 수동으로 `package.json` 파일을 수정해야 합니다.
   - 개발하시는 패키지에서 필요한 버전을 특정할 수 없어 발생한 제약 입니다.
 - 파일명이 정확히 `package.json`이 아니면 검사 대상에서 제외됩니다.
+- 만약, eslint.config.js 내에 json 파일에 대해 이미 사용하고 parser가 없다면 jsonc-eslint-parser를 추가해주세요.
+
+  ```js
+  // eslint.config.js
+  import naverpayPlugin from '@naverpay/eslint-plugin'
+  import * as parserJsonc from 'jsonc-eslint-parser'
+
+  export default [
+    {
+      files: ["**/package.json"],
+      languageOptions: {
+        parser: parserJsonc,
+      },
+      plugins: {'@naverpay': naverpayPlugin},
+      rules: {
+        '@naverpay/peer-deps-in-dev-deps': 'error',
+      },
+    },
+  ]
+  ```

packages/eslint-plugin/lib/rules/peer-deps-in-dev-deps.js

@@ -1,5 +1,8 @@
 import path from 'path'
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 export default {
     meta: {
         type: 'problem',
@@ -22,11 +25,11 @@ export default {
                     return
                 }
 
-                const sourceCode = context.getSourceCode().getText()
+                const sourceCode = context.sourceCode ?? context.getSourceCode()
                 let json
 
                 try {
-                    json = JSON.parse(sourceCode)
+                    json = JSON.parse(sourceCode.getText())
                 } catch (error) {
                     // eslint-disable-next-line no-console
                     console.error('Failed to parse package.json:', error)
@@ -36,12 +39,20 @@ export default {
                 const peerDeps = json.peerDependencies || {}
                 const devDeps = json.devDependencies || {}
 
+                const peerDepsNode = sourceCode.ast.body[0].expression.properties.find(
+                    (property) => property.key.value === 'peerDependencies',
+                )
+                const devDepsNode = sourceCode.ast.body[0].expression.properties.find(
+                    (property) => property.key.value === 'devDependencies',
+                )
+
                 for (const [depName] of Object.entries(peerDeps)) {
                     if (!Object.prototype.hasOwnProperty.call(devDeps, depName)) {
                         context.report({
                             node,
                             messageId: 'missingInDevDeps',
                             data: {packageName: depName},
+                            loc: devDepsNode?.loc || peerDepsNode?.loc,
                         })
                     }
                 }

packages/eslint-plugin/package.json

@@ -48,6 +48,7 @@
         "@babel/preset-react": "^7.24.7",
         "@typescript-eslint/parser": "^8.15.0",
         "builtin-modules": "^4.0.0",
+        "eslint": "^9.17.0",
         "vitest": "^2.1.5"
     },
     "peerDependencies": {

packages/prettier-config/package.json

@@ -16,6 +16,9 @@
     "license": "MIT",
     "author": "@NaverPayDev/frontend",
     "main": "index.json",
+    "devDependencies": {
+        "prettier": "^3.5.3"
+    },
     "peerDependencies": {
         "prettier": "^2.8.8 || ^3.0.0"
     }

packages/stylelint-config/package.json

@@ -16,6 +16,13 @@
     "license": "MIT",
     "author": "@NaverPayDev/frontend",
     "main": "index.js",
+    "devDependencies": {
+        "postcss": "^8.4.8",
+        "postcss-scss": "^4.0.3",
+        "stylelint": "^14.2.0",
+        "stylelint-order": "^5.0.0",
+        "stylelint-scss": "^4.1.0"
+    },
     "peerDependencies": {
         "postcss": "^8.4.8",
         "postcss-scss": "^4.0.3",