✨ Add option to allow relative imports

README.md

@@ -1,4 +1,4 @@
-# eslint-plugin-no-relative-base-url-imports
+# @opencreek/eslint-plugin
 
 Disalows relative path across the baseUrl of your tsconfig
 
@@ -13,16 +13,20 @@ npm i eslint --save-dev
 Next, install `eslint-plugin-no-relative-base-url-imports`:
 
 ```sh
-npm install eslint-plugin-no-relative-base-url-imports --save-dev
+npm install @opencreek/eslint-plugin --save-dev
+```
+
+```sh
+yarn  add --dev @opencreek/eslint-plugin
 ```
 
 ## Usage
 
-Add `no-relative-base-url-imports` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+Add `@opencreek` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
 ```json
 {
-    "plugins": ["no-relative-base-url-imports"]
+    "plugins": ["@opencreek"]
 }
 ```
 
@@ -31,11 +35,28 @@ Then configure the rules you want to use under the rules section.
 ```json
 {
     "rules": {
-        "no-relative-base-url-imports/rule-name": 2
+        "@opencreek/no-relative-imports": [
+            "error",
+            {
+                "baseUrl": "./src"
+            }
+        ]
     }
 }
 ```
 
 ## Supported Rules
 
--   Fill in provided rules here
+### `@opencreek/no-relative-imports` Disable relative imports.
+
+Config options
+
+```ts
+{
+    "baseUrl": "./src", // The base url that you have set in the tsconfig
+    "allowLocalImports": "local" // possible values: "local" | "in-base-path".
+    // "local": Allows local imports (eg.: "./test")
+    // "in-base-path": Allows everything that does not go back to the base url level (eg: "../../test" in "src/a/b/c/test.ts")
+}
+
+```

lib/index.ts

@@ -20,7 +20,7 @@ export const rules = {
 export const configs = {
     recommended: {
         rules: {
-            "@opencreek/opencreek/no-relative-imports": "error",
+            "@opencreek/no-relative-imports": "error",
         },
     },
 }

lib/rules/no-relative-imports.ts

@@ -63,8 +63,8 @@ export default creator<Options, MessageIds>({
                     options.baseUrl ?? "."
                 )
 
-                const relativeFileName = fileName.replace(basePath, "")
-                const levels = relativeFileName.split("/").length - 2
+                const fileNameInsideBasePath = fileName.replace(basePath, "")
+                const levels = fileNameInsideBasePath.split("/").length - 2
                 const levelImport = "../".repeat(levels)
 
                 const filePath = path.dirname(fileName)
@@ -74,7 +74,7 @@ export default creator<Options, MessageIds>({
                     node.source.value
                 )
                 const isInBasePath = filePath.startsWith(basePath)
-                const absoluteImportPathWithoutBase =
+                const absoluteImportPathInsideBasePath =
                     absoluteImportPath.replace(basePath + "/", "")
 
                 // we import something outside of the basePath
@@ -99,7 +99,7 @@ export default creator<Options, MessageIds>({
                         fix: (fixer) => {
                             return fixer.replaceText(
                                 node.source,
-                                `"${absoluteImportPathWithoutBase}"`
+                                `"${absoluteImportPathInsideBasePath}"`
                             )
                         },
                     })
@@ -122,7 +122,7 @@ export default creator<Options, MessageIds>({
                     fix: (fixer) => {
                         return fixer.replaceText(
                             node.source,
-                            `"${absoluteImportPathWithoutBase}"`
+                            `"${absoluteImportPathInsideBasePath}"`
                         )
                     },
                 })

package.json

@@ -1,7 +1,7 @@
 {
-    "name": "@opencreek/eslint-plugin-opencreek",
+    "name": "@opencreek/eslint-plugin",
     "version": "0.2.0",
-    "description": "Disalows relative path across the baseUrl of your tsconfig",
+    "description": "Disallows relative path across the baseUrl of your tsconfig",
     "type": "module",
     "keywords": [
         "eslint",
@@ -13,7 +13,7 @@
         "build/**"
     ],
     "author": "Opencreek Technology<oss@opencreek.tech>",
-    "repository": "https://github.com/opencreek/provider-stack",
+    "repository": "https://github.com/opencreek/eslint-plugin",
     "license": "MIT",
     "publishConfig": {
         "registry": "https://registry.npmjs.org/",