Propose Using `eslint-plugin-package-json` for `package.json` Validation

[yceffort-naver]

Propose Using eslint-plugin-package-json for package.json Validation

Description

Currently, our ESLint setup does not include any rules for validating package.json. This can lead to inconsistencies in dependencies, scripts, and other configurations. By integrating eslint-plugin-package-json, we can enforce consistency and catch potential issues automatically. (also see #82)

Proposal

• Add eslint-plugin-package-json to our ESLint configuration.
• Use its built-in rules to validate package.json fields such as dependencies, scripts, and metadata.
• Optionally, define custom rules if necessary to enforce project-specific guidelines.

Comparison with publint

publint is another tool that helps validate package.json, but it primarily focuses on package publishing issues, such as:

• Incorrect exports field configuration
• Issues with main, module, and types fields
• Missing files in the published package

On the other hand, eslint-plugin-package-json is more general-purpose, providing rules for consistency and correctness across all package.json fields, not just those related to package publishing.

Benefits

• Ensures consistency in package.json.
• Helps prevent dependency mismatches and missing required fields.
• Improves maintainability of the project by enforcing best practices.
• Complements publint by focusing on broader package.json validation beyond publishing concerns.

Integrating this plugin will enhance the reliability of our dependency management and project configuration.

cc @NaverPayDev/frontend

[yceffort-naver]

eslint-plugin-package-json 규칙 정리

규칙 이름	설명	기본 활성화	자동 수정 (--fix)	추가 정보
no-empty-fields	불필요한 빈 배열과 객체를 허용하지 않음	✅	-	💡
no-redundant-files	불필요한 / 중복된 파일 추가를 방지	-	-	💡
order-properties	package.json 속성은 표준 순서대로 선언해야 함	✅	🔧	-
repository-shorthand	저장소(repository) 필드에서 객체 또는 축약형 표기 중 하나를 강제	✅	🔧	-
require-author	author 필드가 반드시 포함되어야 함	-	-	-
require-files	files 필드가 반드시 포함되어야 함	-	-	-
require-keywords	keywords 필드가 반드시 포함되어야 함	-	-	-
require-name	name 필드가 반드시 포함되어야 함	✅	-	-
require-version	version 필드가 반드시 포함되어야 함	✅	-	-
sort-collections	dependencies, scripts, config 등의 항목을 알파벳 순서로 정렬해야 함	✅	🔧	-
unique-dependencies	동일한 패키지가 dependencies와 devDependencies에 중복 선언되지 않도록 검사	✅	-	💡
valid-local-dependency	package.json에 선언된 로컬 의존성이 실제로 존재하는지 확인	✅	-	-
valid-name	패키지명이 npm 패키지 명명 규칙을 따르는지 확인	✅	-	-
valid-package-definition	package.json이 npm 사양에서 요구하는 필드를 포함하는지 확인	✅	-	❌
valid-repository-directory	repository 필드에서 directory가 지정된 경우, package.json 경로와 일치하는지 확인	✅	-	💡
valid-version	패키지 버전이 올바른 SemVer 형식을 따르는지 확인	✅	-	-