@plugjs/eslint-plugin 0.3.42 → 0.4.0

package/NOTICE.md

@@ -1,4 +1,4 @@
-# Copyright 2022 Juit GmbH
+# Copyright 2022-2025 Juit GmbH
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/README.md

@@ -4,14 +4,62 @@ PlugJS ESLint (v9) Shared Configuration
 This package exports simple configurations for linting our projects. It's the
 easiest way to actually share some configs and plugins.
 
-Just add in your `eslint.config.mjs` something similar to:
+Just create a new `eslint.config.mjs` file following this template, your mileage
+might vary, and according to your specific needs you might need to add/remove
+stuff to fit your project:
 
 ```javascript
 import configurations from '@plugjs/eslint-plugin'
 
 export default [
   ...configurations,
-  // any other configuration you might want to add for your project...
+
+  // ===== DEFINE THE LOCATION OF OUR TSCONFIG.JSON FILES ======================
+  {
+    languageOptions: {
+      parserOptions: {
+        createDefaultProgram: false,
+        project: [
+          './tsconfig.json',
+          './test/tsconfig.json',
+        ],
+      },
+    },
+  },
+
+  // ===== ENSURE THAT OUR MAIN FILES DEPEND ONLY ON PROPER DEPENDENCIES =======
+  {
+    files: [ 'src/**' ],
+    rules: {
+      // Turn _ON_ dependencies checks only for sources
+      'import-x/no-extraneous-dependencies': [ 'error', {
+        'devDependencies': true,
+        'peerDependencies': true,
+        'optionalDependencies': true,
+        'bundledDependencies': false,
+      } ],
+    },
+  },
+
+  // ===== PROJECT LOCAL RULES =================================================
+  // Add any extra rule not tied to a specific "files" pattern here, e.g.:
+  // {
+  //   rules: {
+  //     'camelcase': 'off',
+  //   },
+  // },
+
+  // ===== IGNORED FILES =======================================================
+  // REMEMBER! Ignores *must* be in its own configuration, they can not coexist
+  // with "rules", "languageOptions", "files", ... or anything else, otherwise
+  // ESLint will blaantly ignore the ignore files!
+  {
+    ignores: [
+      'coverage/',
+      'dist/',
+      'node_modules/',
+    ],
+  },
 ]
 ```
 
@@ -37,17 +85,6 @@ This includes a number of configurations:
   * `typescript-eslint/recommended`: recommended config for TypeScript
 * `plugjs-typescript`: our rules overriding `typescript-eslint/recommended`.
 
-Notes on building
------------------
-
-During this transitional period (ESLint from v8 to v9, and TypeScript ESLint
-from v7 to v8) a number of plugins, even if they are working, are specifying
-wrong/old dependencies in their packages.
-
-For those plugins, we bundle them up and ship them with this plugin, and
-hopefully we'll be able to un-bundle them as the various packages move in their
-transitions.
-
 Legal Stuff
 -----------
 

package/check.mjs

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+import { ESLint } from 'eslint'
+
+/** @type Record<string, string[]> */
+const deprecated = {}
+
+// Pretty colors
+const ylw = '\u001b[38;5;220m' // yellow
+const grn = '\u001b[38;5;76m' // greenish
+const rst = '\u001b[0m' // reset
+// Running in GitHub Actions?
+const gh = process.env.GITHUB_ACTIONS === 'true'
+
+// Create a new ESLint
+const eslint = new ESLint()
+
+// Fake lint some sources (JS, TS, ...) to get the deprecated rules
+for (const f of [ 'x.js', 'x.mjs', 'x.cjs', 'x.ts', 'x.cts', 'x.mts' ]) {
+  const results = await eslint.lintText('var foo="bar";', { filePath: f })
+  for (const result of results) {
+    for (const rule of result.usedDeprecatedRules) {
+      deprecated[rule.ruleId] = rule.replacedBy
+    }
+  }
+}
+
+// Print the deprecated rules in order
+const deprecations = Object.entries(deprecated)
+if (deprecations.length !== 0) {
+  deprecations
+      .sort(([ a ], [ b ]) => a.localeCompare(b))
+      .forEach(([ rule, replacement ]) => {
+        if (replacement.length) {
+          console.log(`Rule "${ylw}${rule}${rst}" deprecated and replaced by "${grn}${replacement.join(`${rst}", "${grn}`)}${rst}"`)
+          if (gh) console.log(`::warning::Rule "${rule}" deprecated and replaced by "${replacement.join(', ')}"`)
+        } else {
+          console.log(`Rule "${ylw}${rule}${rst}" deprecated without replacement`)
+          if (gh) console.log(`::warning::Rule "${rule}" deprecated without replacement`)
+        }
+      })
+} else {
+  console.log(`${grn}Success:${rst} no deprecated rules found!`)
+}

package/package.json

@@ -1,23 +1,26 @@
 {
   "name": "@plugjs/eslint-plugin",
-  "version": "0.3.42",
+  "version": "0.4.0",
   "description": "Shared ESLint configurations and extras",
   "main": "./index.mjs",
   "type": "module",
   "author": "Team Juit <developers@juit.com>",
   "license": "Apache-2.0",
+  "bin": {
+    "eslint-check-deprecated-rules": "./check.mjs"
+  },
   "scripts": {
     "build": "node check.mjs && eslint"
   },
   "dependencies": {
     "@eslint/js": "^9.34.0",
-    "@stylistic/eslint-plugin": "^5.2.3",
+    "@stylistic/eslint-plugin": "^5.3.1",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import-x": "^4.16.1",
     "eslint-plugin-unicorn": "^60.0.0",
     "globals": "^16.3.0",
-    "typescript-eslint": "^8.41.0"
+    "typescript-eslint": "^8.42.0"
   },
   "devDependencies": {
     "eslint": "^9.34.0"