eslint-plugin-boundaries 4.2.0 → 5.0.0-beta.0

package/README.md

@@ -53,22 +53,43 @@ npm install --save-dev eslint eslint-plugin-boundaries
 
 `eslint-plugin-boundaries` does not install `eslint` for you. You must install it yourself.
 
-Activate the plugin and one of the canned configs in your `.eslintrc.(yml|json|js)`:
+Activate the plugin and one of the canned configs in your `.eslint.config.js` file:
 
-```json
-{
-  "plugins": ["boundaries"],
-  "extends": ["plugin:boundaries/recommended"]
-}
+```js
+import boundaries from "eslint-plugin-boundaries";
+
+export default [
+  {
+    files: ["**/*.js"],
+    plugins: {
+      boundaries,
+    },
+    rules: {
+      ...boundaries.configs.recommended.rules,
+    }
+  }
+];
+```
+
+### Eslint v9 and above
+
+You must use beta versions of this plugin starting from `5.0.0-beta.0` to use it with eslint v9 and above. The compatibility is not guaranteed yet. In case you face any issue, please [open an issue](https://github.com/javierbrea/eslint-plugin-boundaries/issues).
+
+To install the latest beta version, you can use the next command:
+
+```bash
+npm install --save-dev eslint-plugin-boundaries@beta
 ```
 
+Note that all examples in these docs except the installation one are still written using JSON format, but you should use JavaScript format in your `.eslint.config.js` file for eslint version 9 and above. Please read the [eslint v9 migration guide](https://eslint.org/docs/latest/use/migrate-to-9.0.0) for further info. Once we have tested enough the compatibility with eslint v9 of predefined configurations, examples, and the integration with other eslint plugins, such as those needed to use TypeScript with this plugin, we will update the examples and release a stable version.
+
 ## Overview
 
 All of the plugin rules need to be able to identify the elements in the project, so, first of all you have to define your project element types by using the `boundaries/elements` setting.
 
 The plugin will use the provided patterns to identify each file as one of the element types. It will also assign a type to each dependency detected in the [dependency nodes (`import` or other statements)](#boundariesdependency-nodes), and it will check if the relationship between the dependent element and the dependency is allowed or not.
 
-```json
+```js
 {
   "settings": {
     "boundaries/elements": [
@@ -286,14 +307,12 @@ By default, the plugin uses the current working directory (`process.cwd()`) as r
 For example, supposing that the `.eslintrc.js` file is located in the project root, you could define the root path as in:
 
 ```js
-{
   settings: {
     "boundaries/root-path": path.resolve(__dirname)
   }
-}
 ```
 
-Note that the path should be absolute and resolved before passing it to the plugin. Otherwise, it will be resolved using the current working directory, and the problem will persist. In case you are defining the configuration in a `.eslintrc.(yml|json)` file, and you don't want to hardcode an absolute path, you can use the next environment variable to define the root path when executing the lint command:
+Note that the path should be absolute and resolved before passing it to the plugin. Otherwise, it will be resolved using the current working directory, and the problem will persist. You can also use the next environment variable to define the root path when executing the lint command:
 
 ```bash
 ESLINT_PLUGIN_BOUNDARIES_ROOT_PATH=../../project-root npm run lint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-boundaries",
-  "version": "4.2.0",
+  "version": "5.0.0-beta.0",
   "description": "Eslint plugin checking architecture boundaries between elements",
   "keywords": [
     "eslint",
@@ -25,33 +25,32 @@
     "lint": "eslint src *.js test",
     "lint-staged": "lint-staged",
     "test": "jest",
-    "test:unit": "cross-env ESLINT_PLUGIN_BOUNDARIES_DEBUG=1 npm run test",
+    "test:unit": "cross-env ESLINT_USE_FLAT_CONFIG=true ESLINT_PLUGIN_BOUNDARIES_DEBUG=1 npm run test",
     "prepare": "is-ci || husky install"
   },
   "peerDependencies": {
-    "eslint": ">=6.0.0"
+    "eslint": ">=9.0.0"
   },
   "dependencies": {
     "chalk": "4.1.2",
     "eslint-import-resolver-node": "0.3.9",
-    "eslint-module-utils": "2.8.0",
+    "eslint-module-utils": "2.8.1",
     "is-core-module": "2.13.1",
     "micromatch": "4.0.5"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "6.9.1",
-    "@typescript-eslint/parser": "6.9.1",
+    "@typescript-eslint/parser": "8.0.0-alpha.30",
+    "@typescript-eslint/eslint-plugin": "8.0.0-alpha.30",
     "cross-env": "7.0.3",
-    "eslint": "8.52.0",
-    "eslint-config-prettier": "9.0.0",
-    "eslint-import-resolver-typescript": "3.6.1",
-    "eslint-plugin-prettier": "5.0.1",
+    "eslint": "9.5.0",
+    "eslint-config-prettier": "9.1.0",
     "eslint-plugin-local-rules": "2.0.1",
-    "husky": "8.0.3",
+    "eslint-plugin-prettier": "5.1.3",
+    "husky": "9.0.11",
     "is-ci": "3.0.1",
     "jest": "29.7.0",
-    "lint-staged": "15.0.2",
-    "prettier": "3.0.3"
+    "lint-staged": "15.2.2",
+    "prettier": "3.2.5"
   },
   "lint-staged": {
     "test/**/*.js": "eslint",
@@ -59,6 +58,6 @@
     "*.js": "eslint"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.18"
   }
 }

package/src/configs/recommended.js

@@ -1,8 +1,5 @@
-const { PLUGIN_NAME } = require("../constants/plugin");
-
 const {
   ELEMENTS,
-  IGNORE,
   // rules
   RULE_ELEMENT_TYPES,
   RULE_ENTRY_POINT,
@@ -14,7 +11,6 @@ const {
 } = require("../constants/settings");
 
 module.exports = {
-  plugins: [PLUGIN_NAME],
   rules: {
     [RULE_ELEMENT_TYPES]: [2],
     [RULE_ENTRY_POINT]: [2],
@@ -31,6 +27,5 @@ module.exports = {
   },
   settings: {
     [ELEMENTS]: [],
-    [IGNORE]: ["**/*.spec?.js", "**/*.test?.js"],
   },
 };