Merge pull request #150 from aiven/add-non-relative-imports

Add alias for absolute imports in coral.
Aiven-Open · Oct 26, 2022 · ef8e08a · ef8e08a
2 parents 65f079e + 7d5eb1d
commit ef8e08a
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 8 deletions.
diff --git a/coral/.eslintrc.cjs b/coral/.eslintrc.cjs
@@ -19,13 +19,17 @@ module.exports = {
     },
     "plugins": [
         "react",
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "no-relative-import-paths"
     ],
     "settings": {
         "react": {
             "version": "detect"
         }
     },
     "rules": {
+        "no-relative-import-paths/no-relative-import-paths": [
+            "error"
+        ]
     }
 }
diff --git a/coral/jest.config.ts b/coral/jest.config.ts
@@ -7,10 +7,10 @@ export default {
   moduleFileExtensions: ["js", "jsx", "ts", "tsx"],
   preset: "ts-jest",
   testEnvironment: "jsdom",
-  setupFilesAfterEnv: ['<rootDir>/test-setup/setup-files-after-env.ts'],
+  setupFilesAfterEnv: ["<rootDir>/test-setup/setup-files-after-env.ts"],
   moduleNameMapper: {
     ".+\\.(png|jpg|ttf|woff|woff2|svg)$": "jest-transform-stub",
     "\\.css$": "identity-obj-proxy",
-    "^@/(.*)$": "<rootDir>/src/$1",
+    "^src/(.*)$": "<rootDir>/src/$1",
   },
 };
diff --git a/coral/package.json b/coral/package.json
@@ -46,6 +46,7 @@
     "@vitejs/plugin-react": "^2.1.0",
     "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-no-relative-import-paths": "^1.4.0",
     "eslint-plugin-react": "^7.31.10",
     "husky": "^8.0.1",
     "identity-obj-proxy": "^3.0.0",

diff --git a/coral/pnpm-lock.yaml b/coral/pnpm-lock.yaml
diff --git a/coral/src/main.tsx b/coral/src/main.tsx
@@ -1,7 +1,7 @@
 import React from "react";
 import ReactDOM from "react-dom/client";
 import { RouterProvider } from "react-router-dom";
-import router from "./router";
+import router from "src/router";
 
 import "@aivenio/design-system/dist/styles.css";
 

diff --git a/coral/src/pages/hello/index.test.tsx b/coral/src/pages/hello/index.test.tsx
@@ -1,4 +1,4 @@
-import HelloPage from "./index";
+import HelloPage from "src/pages/hello";
 import { render, cleanup, screen } from "@testing-library/react";
 
 describe("HelloPage", () => {

diff --git a/coral/src/pages/index.test.tsx b/coral/src/pages/index.test.tsx
@@ -1,4 +1,4 @@
-import HomePage from "./index";
+import HomePage from "src/pages";
 import { render, cleanup, screen } from "@testing-library/react";
 
 describe("HomePage", () => {

diff --git a/coral/src/router.tsx b/coral/src/router.tsx
@@ -1,6 +1,6 @@
 import { createBrowserRouter, Navigate, RouteObject } from "react-router-dom";
-import HomePage from "./pages/index";
-import HelloPage from "./pages/hello";
+import HomePage from "src/pages";
+import HelloPage from "src/pages/hello";
 
 const routes: Array<RouteObject> = [
   {

diff --git a/coral/tsconfig.json b/coral/tsconfig.json
@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "baseUrl": ".",
     "target": "ESNext",
     "useDefineForClassFields": true,
     "lib": ["DOM", "DOM.Iterable", "ESNext"],

diff --git a/coral/vite.config.ts b/coral/vite.config.ts
@@ -1,5 +1,6 @@
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
+import { resolve } from "path";
 
 // https://vitejs.dev/config/
 export default defineConfig({
@@ -16,4 +17,9 @@ export default defineConfig({
       EXAMPLE: "",
     },
   },
+  resolve: {
+    alias: {
+      src: resolve(resolve(__dirname), "./src"),
+    },
+  },
 });