feat(lint-package-json): lint-package-json util

dangreen · dangreen · commit 0ec0b35321a7 · 2022-02-04T17:48:12.000+07:00
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -15,3 +15,24 @@ jobs:
         uses: actions/checkout@v2
       - name: Check editorconfig
         uses: editorconfig-checker/action-editorconfig-checker@v1
+  package-json:
+    runs-on: ubuntu-latest
+    name: Checking package.json files
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: 6
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Check package.json files
+        if: success()
+        run: pnpm lint:package-json
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ Scripts and configs for TrigenSoftware's projects.
 | [`@trigen/babel-preset`](packages/babel-preset#readme) | [![NPM version][babel-preset-npm]][babel-preset-npm-url] | [![Dependencies status][babel-preset-deps]][babel-preset-deps-url] |
 | [`@trigen/browserslist-config`](packages/browserslist-config#readme) | [![NPM version][browserslist-config-npm]][browserslist-config-npm-url] | |
 | [`@trigen/eslint-config`](packages/eslint-config#readme) | [![NPM version][eslint-config-npm]][eslint-config-npm-url] | [![Dependencies status][eslint-config-deps]][eslint-config-deps-url] |
+| [`@trigen/lint-package-json`](packages/lint-package-json#readme) | [![NPM version][lint-package-json-npm]][lint-package-json-npm-url] | [![Dependencies status][lint-package-json-deps]][lint-package-json-deps-url] |
 | [`@trigen/npm-package-json-lint-config`](packages/npm-package-json-lint-config#readme) | [![NPM version][npm-package-json-lint-config-npm]][npm-package-json-lint-config-npm-url] | [![Dependencies status][npm-package-json-lint-config-deps]][npm-package-json-lint-config-deps-url] |
 
 <!-- babel-preset -->
@@ -50,6 +51,14 @@ Scripts and configs for TrigenSoftware's projects.
 [eslint-config-deps]: https://img.shields.io/librariesio/release/npm/@trigen/eslint-config
 [eslint-config-deps-url]: https://libraries.io/npm/@trigen%2Feslint-config/tree
 
+<!-- lint-package-json -->
+
+[lint-package-json-npm]: https://img.shields.io/npm/v/%40trigen/lint-package-json.svg
+[lint-package-json-npm-url]: https://www.npmjs.com/package/@trigen/lint-package-json
+
+[lint-package-json-deps]: https://img.shields.io/librariesio/release/npm/@trigen/lint-package-json
+[lint-package-json-deps-url]: https://libraries.io/npm/@trigen%2Fnpm-package-json-lint-config/tree
+
 <!-- npm-package-json-lint-config -->
 
 [npm-package-json-lint-config-npm]: https://img.shields.io/npm/v/%40trigen/npm-package-json-lint-config.svg
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
     "node": ">=14"
   },
   "scripts": {
-    "lint:package-json": "npmPkgJsonLint .",
+    "lint:package-json": "lint-package-json --monorepo",
     "lint": "eslint 'packages/**/*.{js,jsx,ts,tsx}'",
     "jest": "NODE_OPTIONS=--experimental-vm-modules jest -c jest.config.json",
     "test": "run -p lint jest",
@@ -37,7 +37,7 @@
     "@swc/jest": "^0.2.14",
     "@trigen/browserslist-config": "workspace:*",
     "@trigen/eslint-config": "workspace:*",
-    "@trigen/npm-package-json-lint-config": "workspace:*",
+    "@trigen/lint-package-json": "workspace:*",
     "@trigen/scripts": "workspace:*",
     "@types/node": "^17.0.8",
     "clean-publish": "^4.0.0",
diff --git a/packages/eslint-config/src/rules/getExtensionRules.js b/packages/eslint-config/src/rules/getExtensionRules.js
@@ -1,4 +1,3 @@
-/* eslint-disable security/detect-object-injection */
 const commonRules = require('./common').rules
 const es6Rules = require('./es6').rules
 
diff --git a/packages/lint-package-json/.eslintrc.json b/packages/lint-package-json/.eslintrc.json
@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@trigen/eslint-config/esm"
+  ]
+}
diff --git a/packages/lint-package-json/README.md b/packages/lint-package-json/README.md
@@ -0,0 +1,38 @@
+# @trigen/lint-package-json
+
+[![NPM version][npm]][npm-url]
+[![Node version][node]][node-url]
+[![Dependencies status][deps]][deps-url]
+[![Build status][build]][build-url]
+
+[npm]: https://img.shields.io/npm/v/%40trigen/lint-package-json.svg
+[npm-url]: https://npmjs.com/package/@trigen/lint-package-json
+
+[node]: https://img.shields.io/node/v/%40trigen/lint-package-json.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://img.shields.io/librariesio/release/npm/@trigen/lint-package-json
+[deps-url]: https://libraries.io/npm/@trigen%2Feslint-config/tree
+
+[build]: https://img.shields.io/github/workflow/status/TrigenSoftware/scripts/CI.svg
+[build-url]: https://github.com/TrigenSoftware/scripts/actions
+
+Shortcut to run npm-package-json-lint with @trigen/npm-package-json-lint-config.
+
+## Install
+
+```bash
+pnpm add -D @trigen/lint-package-json
+# or
+yarn add -D @trigen/lint-package-json
+# or
+npm i -D @trigen/lint-package-json
+```
+
+## Usage
+
+```bash
+pnpm --package=@trigen/lint-package-json dlx lint-package-json
+# or
+pnpm --package=@trigen/lint-package-json dlx lint-package-json --monorepo
+```
diff --git a/packages/lint-package-json/package.json b/packages/lint-package-json/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "@trigen/lint-package-json",
+  "type": "module",
+  "version": "8.0.0-alpha.4",
+  "description": "Shortcut to run npm-package-json-lint with @trigen/npm-package-json-lint-config.",
+  "author": "dangreen",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TrigenSoftware/scripts.git",
+    "directory": "packages/lint-package-json"
+  },
+  "bugs": {
+    "url": "https://github.com/TrigenSoftware/scripts/issues"
+  },
+  "keywords": [
+    "npm-package-json-lint",
+    "dlx"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "bin": {
+    "lint-package-json": "./src/index.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "package"
+  },
+  "scripts": {
+    "prepublishOnly": "del ./package && clean-publish",
+    "postpublish": "del ./package"
+  },
+  "dependencies": {
+    "@trigen/npm-package-json-lint-config": "8.0.0-alpha.3",
+    "npm-package-json-lint": "^5.4.2"
+  },
+  "readme": ""
+}
diff --git a/packages/lint-package-json/src/index.js b/packages/lint-package-json/src/index.js
@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import NpmPackageJsonLint from 'npm-package-json-lint/src/NpmPackageJsonLint.js'
+import Reporter from 'npm-package-json-lint/src/Reporter.js'
+
+const monorepo = process.argv.includes('--monorepo')
+const config = {
+  extends: monorepo
+    ? ['@trigen/npm-package-json-lint-config', '@trigen/npm-package-json-lint-config/monorepo']
+    : '@trigen/npm-package-json-lint-config'
+}
+const npmPackageJsonLint = new NpmPackageJsonLint({
+  cwd: process.cwd(),
+  config,
+  patterns: ['.']
+})
+const linterOutput = npmPackageJsonLint.lint()
+
+Reporter.write(linterOutput)
+
+if (linterOutput.errorCount > 0) {
+  process.exit(1)
+}
diff --git a/packages/npm-package-json-lint-config/src/index.js b/packages/npm-package-json-lint-config/src/index.js
@@ -1,5 +1,5 @@
 module.exports = {
-  extends: 'npm-package-json-lint-config-default',
+  extends: require.resolve('npm-package-json-lint-config-default'),
   rules: {
     'require-author': 'error',
     'require-bugs': 'error',
diff --git a/packages/scripts/.eslintrc.json b/packages/scripts/.eslintrc.json
@@ -1,7 +1,6 @@
 {
   "extends": [
     "@trigen/eslint-config/esm",
-    "@trigen/eslint-config/typescript",
     "@trigen/eslint-config/jest"
   ]
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-/* eslint-disable security/detect-object-injection */`
`2`	`1`	`const commonRules = require('./common').rules`
`3`	`2`	`const es6Rules = require('./es6').rules`
`4`	`3`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "extends": [
 +    "@trigen/eslint-config/esm"
 +  ]
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": [`
`3`	`3`	`"@trigen/eslint-config/esm",`
`4`		`- "@trigen/eslint-config/typescript",`
`5`	`4`	`"@trigen/eslint-config/jest"`
`6`	`5`	`]`
`7`	`6`	`}`