build: lint package.json files (#1031)

* build: lint `package.json` files

* build: configure lint-staged for json files

* chore: document why `*.json` is needed

.eslintrc.json

@@ -3,7 +3,8 @@
   // 👇 Added `coverage/**/*` to be able to run 'eslint .' successfully
   //    When upgrading to v9, can include .gitignore here. In v8, you need to add a CLI flag
   //    Given 'eslint .' is not something ran often, it's good enough as ienough as is
-  "ignorePatterns": ["projects/**/*", "coverage/**/*"],
+  //    Removing `projects/**/*` to allow using `eslint .` to lint everything.
+  "ignorePatterns": ["coverage/**/*", "!.*.json"],
   "parserOptions": {
     "ecmaVersion": 9 // for jest.config.js files on IntelliJ
   },
@@ -47,6 +48,17 @@
     {
       "files": ["*.cy.ts"],
       "extends": ["plugin:cypress/recommended"]
+    },
+    {
+      //👇 `*.json` is needed so that when `lint-staged` sends any kind of JSON file,
+      //   ESLint doesn't complain about them. However, just `package.json` files are linted.
+      "files": ["*.json"],
+      "plugins": ["json-files"],
+      "rules": {
+        "json-files/require-unique-dependency-names": "error",
+        "json-files/ensure-repository-directory": "error",
+        "json-files/restrict-ranges": ["error", { "versionHint": "pin" }]
+      }
     }
   ]
 }

.lintstagedrc.json

@@ -1,5 +1,5 @@
 {
-  "!(*.ts)": ["pnpm run format"],
-  "*.ts": ["pnpm run lint:code:raw --fix", "pnpm run format"],
+  "!(*.{json,ts})": ["pnpm run format"],
+  "*.{json,ts}": ["pnpm run lint:code:raw --fix", "pnpm run format"],
   ".github/**/*.{yml,yaml}": ["pnpm run lint:gh-actions"]
 }

angular.json

@@ -37,8 +37,7 @@
           "builder": "@angular-eslint/builder:lint",
           "options": {
             "lintFilePatterns": [
-              "projects/ngx-meta/src/**/*.ts",
-              "projects/ngx-meta/src/**/*.html",
+              "projects/ngx-meta/src/**/*.{ts,html}",
               "projects/ngx-meta/e2e/**/*.ts",
               "projects/ngx-meta/example-apps/**/*.ts",
               "projects/ngx-meta/schematics/**/*.ts"

package.json

@@ -87,6 +87,7 @@
     "eslint-plugin-cypress": "3.6.0",
     "eslint-plugin-jasmine": "4.2.2",
     "eslint-plugin-jest": "28.8.3",
+    "eslint-plugin-json-files": "4.4.1",
     "husky": "9.1.6",
     "jasmine-core": "5.4.0",
     "jest": "29.7.0",

projects/ngx-meta/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../.eslintrc.json",
+  "ignorePatterns": ["dist/**/*", "out/**/*"]
+}

projects/ngx-meta/docs/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../.eslintrc.json",
+  "ignorePatterns": ["content/fonts/**/*"]
+}

projects/ngx-meta/src/.eslintrc.json

@@ -31,6 +31,14 @@
       "files": ["*.spec.ts"],
       "extends": ["plugin:jasmine/recommended"],
       "plugins": ["jasmine"]
+    },
+    {
+      "files": ["package.json"],
+      "plugins": ["json-files"],
+      "rules": {
+        "json-files/require-license": "error",
+        "json-files/restrict-ranges": ["error", { "versionHint": "caret" }]
+      }
     }
   ]
 }