Merge pull request #22 from qdanik/release/2.1.0

Release/2.1.0

Author: qdanik

.gitignore

@@ -2,6 +2,7 @@
 .idea
 
 node_modules
+coverage
 
 lib
 lib/*

README.md

@@ -1,4 +1,6 @@
-# eslint-plugin-path [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+# eslint-plugin-path
+[![Biome](https://img.shields.io/badge/linting-biome-60a5fa?style=flat-square)](https://biomejs.dev)
+[![code style: biome](https://img.shields.io/badge/code_style-biome-60a5fa?style=flat-square)](https://biomejs.dev)
 
 An ESLint plugin for enforcing consistent imports across project. In other words, it helps to replace all relatives import with absolutes dependinng on settings.
 
@@ -87,6 +89,19 @@ If you are using custom paths in your `tsconfig.json` or `jsconfig.json` file, y
 }
 ```
 
+`path/no-absolute-imports` can also flag `compilerOptions.paths` aliases as absolute imports. This is opt-in via `useAliases`:
+
+```json
+{
+  "rules": {
+    "path/no-absolute-imports": ["error", {
+      "useAliases": true,
+      "maxDepth": 1
+    }]
+  }
+}
+```
+
 ## Configuration
 
 Enable the rules in your ESLint configuration file:

biome.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+  "vcs": {
+    "useIgnoreFile": true,
+    "defaultBranch": "main",
+    "enabled": true,
+    "clientKind": "git"
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "attributePosition": "auto",
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100,
+    "lineEnding": "lf"
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "single",
+      "quoteStyle": "single"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "performance": {
+        "noDelete": "off",
+        "useTopLevelRegex": "error"
+      },
+      "nursery": {
+        "noImportCycles": "error"
+      },
+      "complexity": {
+        "useLiteralKeys": "off"
+      },
+      "correctness": {
+        "noUnusedImports": "error",
+        "noInvalidPositionAtImportRule": "off"
+      },
+      "suspicious": {
+        "noImplicitAnyLet": "off",
+        "noExplicitAny": "off",
+        "noUnknownAtRules": "off"
+      },
+      "security": {
+        "noBlankTarget": "error"
+      },
+      "recommended": true
+    }
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "identifierOrder": "natural"
+          }
+        }
+      }
+    }
+  }
+}

docs/rules/no-absolute-imports.md

@@ -1,12 +1,20 @@
 # path/no-absolute-imports
 
-Disallows the use of absolute file imports. This rule only affects paths included in tsconfig or jsconfig.
+Disallows absolute file imports and replaces them with relative paths.
+
+Any import that resolves to a local file but is not a relative path (`./` or `../`) will be flagged. This includes:
+
+- Rooted imports (`/components/button`)
+- tsconfig/jsconfig `paths` aliases (`@components/button`)
+- `baseUrl`-resolved imports (`presentation/presenters/auth`)
+
+External packages (e.g. `react`, `lodash`) are not affected since they don't resolve to local files.
 
 **Fixable:** This rule is automatically fixable using the `--fix` command line option.
 
-**Doesn't work with eslint-plugin-import/no-absolute-path:**
+**Conflicts with eslint-plugin-import/no-absolute-path:**
 ```
-"import/no-absolute-path": "off" // disable this rule
+"import/no-absolute-path": "off"
 ```
 
 ## Example
@@ -16,33 +24,55 @@ These examples have the following project structure:
 ```
 project
 └─── package.json
+└─── tsconfig.json
 └─── src
-    └─── components
-    └─── pages
+    └─── components/
+    └─── presentation/
+        └─── presenters/
 ```
 
-`project/jsconfig.json` or `project/tsconfig.json`
+`project/tsconfig.json`:
 
-```
+```json
 {
   "compilerOptions": {
-    "baseUrl": "./src"
+    "baseUrl": ".",
+    "paths": {
+      "@components/*": ["src/components/*"]
+    }
   }
 }
 ```
 
-if `compilerOptions.baseUrl` is unset, it will use `project/` = the dirname of `package.json`
-
 ## Fail
 
 ```js
-// inside "project/src/pages/users/details/index.js"
+// Rooted import
 import foo from "/components/button";
+
+// Alias import
+import foo from "@components/button";
+
+// baseUrl import
+import foo from "presentation/presenters/auth";
 ```
 
 ## Pass
 
 ```js
-// inside "project/src/components/common/input/index.js"
+// Relative import
 import foo from "../../components/button";
+
+// External package — not a local file
+import React from "react";
+```
+
+## Configuration
+
+```json
+{
+  "rules": {
+    "path/no-absolute-imports": "error"
+  }
+}
 ```

jest.config.js

@@ -0,0 +1,15 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  testMatch: ['<rootDir>/tests/**/*.test.js'],
+  collectCoverageFrom: ['lib/**/*.js', '!lib/**/*.d.ts'],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  coverageThreshold: {
+    global: {
+      branches: 85,
+      functions: 100,
+      lines: 100,
+      statements: 100,
+    },
+  },
+};