Set "type": "module" and fix things

jennydaman · jennydaman · commit 253239b66257 · 2024-08-25T23:18:41.000-04:00
diff --git a/package.json b/package.json
@@ -126,5 +126,6 @@
     "vite": "^5.3.2",
     "vite-plugin-istanbul": "^6.0.2",
     "vitest": "^2.0.5"
-  }
+  },
+  "type": "module"
 }
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -2,34 +2,30 @@
 
 import { defineConfig, devices, PlaywrightTestConfig } from "@playwright/test";
 
-const SHOULD_TEST_SAFARI = getBoolEnvVar('TEST_SAFARI');
-const SHOULD_TEST_LOCALLY = getBoolEnvVar('TEST_LOCAL');
+const SHOULD_TEST_SAFARI = getBoolEnvVar("TEST_SAFARI");
+const SHOULD_TEST_LOCALLY = getBoolEnvVar("TEST_LOCAL");
 
 /**
-  * List of browsers to test against.
-  * 
-  * - Use Safari if indicated by `TEST_SAFARI=y`
-  * - Use only one browser (Desktop Chrome) if testing locally. Tests against a local
-  *   backend use features which modify global state, so we can only use one browser.
-  * - Use multiple browsers and mobile browsers if testing against the public testing server.
-  */
+ * List of browsers to test against.
+ *
+ * - Use Safari if indicated by `TEST_SAFARI=y`
+ * - Use only one browser (Desktop Chrome) if testing locally. Tests against a local
+ *   backend use features which modify global state, so we can only use one browser.
+ * - Use multiple browsers and mobile browsers if testing against the public testing server.
+ */
 const BROWSERS: PlaywrightTestConfig["projects"] = [];
 
 if (SHOULD_TEST_LOCALLY) {
   if (SHOULD_TEST_SAFARI) {
-    BROWSERS.push(
-      {
-        name: 'webkit',
-        use: { ...devices['Desktop Safari'] },
-      },
-    );
+    BROWSERS.push({
+      name: "webkit",
+      use: { ...devices["Desktop Safari"] },
+    });
   } else {
-    BROWSERS.push(
-      {
-        name: "chromium",
-        use: { ...devices["Desktop Chrome"] },
-      },
-    );
+    BROWSERS.push({
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    });
   }
 } else {
   BROWSERS.push(
@@ -38,23 +34,23 @@ if (SHOULD_TEST_LOCALLY) {
       use: { ...devices["Desktop Chrome"] },
     },
     {
-      name: 'firefox',
-      use: { ...devices['Desktop Firefox'] },
+      name: "firefox",
+      use: { ...devices["Desktop Firefox"] },
     },
     {
-      name: 'Mobile Chrome',
-      use: { ...devices['Pixel 5'] },
+      name: "Mobile Chrome",
+      use: { ...devices["Pixel 5"] },
     },
   );
   if (SHOULD_TEST_SAFARI) {
     BROWSERS.push(
       {
-        name: 'webkit',
-        use: { ...devices['Desktop Safari'] },
+        name: "webkit",
+        use: { ...devices["Desktop Safari"] },
       },
       {
-        name: 'Mobile Safari',
-        use: { ...devices['iPhone 12'] },
+        name: "Mobile Safari",
+        use: { ...devices["iPhone 12"] },
       },
     );
   }
@@ -63,7 +59,7 @@ if (SHOULD_TEST_LOCALLY) {
 /**
  * Name of a npm script which starts a UI development server.
  */
-const UI_SCRIPT = SHOULD_TEST_LOCALLY ? 'dev' : 'dev:public';
+const UI_SCRIPT = SHOULD_TEST_LOCALLY ? "dev" : "dev:public";
 /**
  * Port number (on localhost) for the server created by {@link UI_SCRIPT}
  */
@@ -74,7 +70,7 @@ const UI_PORT = SHOULD_TEST_LOCALLY ? 5173 : 25173;
  */
 export default defineConfig({
   /* A script which deletes the previous coverage data */
-  globalSetup: require.resolve('./deleteCoverageData'),
+  globalSetup: "./deleteCoverageData.ts",
 
   testDir: "./tests",
   /* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
@@ -103,14 +99,14 @@ export default defineConfig({
   webServer: {
     command: `env USE_BABEL_PLUGIN_ISTANBUL=y CI=true npm run ${UI_SCRIPT}`,
     url: `http://localhost:${UI_PORT}`,
-    reuseExistingServer:true,
-    timeout: SHOULD_TEST_LOCALLY ? 5 * 60_000 : 60_000  // more time is needed for local testing web server, to download container images and example data
+    reuseExistingServer: true,
+    timeout: SHOULD_TEST_LOCALLY ? 5 * 60_000 : 60_000, // more time is needed for local testing web server, to download container images and example data
   },
 });
 
 /**
  * Get a boolean value from an environment variable.
  */
 function getBoolEnvVar(name: string): boolean {
-  return process.env[name]?.toLowerCase().startsWith('y') || false;
+  return process.env[name]?.toLowerCase().startsWith("y") || false;
 }
diff --git a/src/components/NiivueDatasetViewer/components/RadiologcalConventionToggle.tsx b/src/components/NiivueDatasetViewer/components/RadiologcalConventionToggle.tsx
@@ -8,30 +8,31 @@ type RadiologcalConventionToggleProps = {
   setOptions: Updater<ChNVROptions>;
 };
 
-const RadiologcalConventionToggle: React.FC<RadiologcalConventionToggleProps> =
-  ({ options, setOptions }) => (
-    <ToggleGroup>
-      <ToggleGroupItem
-        text="Neurological"
-        isSelected={!options.isRadiologicalConvention}
-        onChange={() =>
-          setOptions((draft) => {
-            draft.isRadiologicalConvention = false;
-            draft.sagittalNoseLeft = false;
-          })
-        }
-      />
-      <ToggleGroupItem
-        text="Radiological"
-        isSelected={options.isRadiologicalConvention}
-        onChange={() =>
-          setOptions((draft) => {
-            draft.isRadiologicalConvention = true;
-            draft.sagittalNoseLeft = true;
-          })
-        }
-      />
-    </ToggleGroup>
-  );
+const RadiologcalConventionToggle: React.FC<
+  RadiologcalConventionToggleProps
+> = ({ options, setOptions }) => (
+  <ToggleGroup>
+    <ToggleGroupItem
+      text="Neurological"
+      isSelected={!options.isRadiologicalConvention}
+      onChange={() =>
+        setOptions((draft) => {
+          draft.isRadiologicalConvention = false;
+          draft.sagittalNoseLeft = false;
+        })
+      }
+    />
+    <ToggleGroupItem
+      text="Radiological"
+      isSelected={options.isRadiologicalConvention}
+      onChange={() =>
+        setOptions((draft) => {
+          draft.isRadiologicalConvention = true;
+          draft.sagittalNoseLeft = true;
+        })
+      }
+    />
+  </ToggleGroup>
+);
 
 export default RadiologcalConventionToggle;
diff --git a/src/components/Store/index.tsx b/src/components/Store/index.tsx
@@ -162,7 +162,6 @@ const Store = () => {
     );
     if (!adminURL)
       throw new Error("Please provide a link to your chris-admin url");
-    
 
     const client = ChrisAPIClient.getClient();
     const adminCredentials = btoa(`${username.trim()}:${password.trim()}`); // Base64 encoding for Basic Auth
diff --git a/testing/publicCUBE/vite.config.ts b/testing/publicCUBE/vite.config.ts
@@ -5,6 +5,6 @@ import viteConfig from "../../vite.config";
 export default mergeConfig(viteConfig, {
   envDir: "./testing/publicCUBE",
   server: {
-    port: 25173
-  }
+    port: 25173,
+  },
 });
diff --git a/tests/createFeed.spec.ts b/tests/createFeed.spec.ts
@@ -1,9 +1,9 @@
 import { test, expect } from "./fixtures/loggedIn.ts";
 import { faker } from "@faker-js/faker";
 import createFeed from "./helpers/createFeedHelper.ts";
-import path from "path";
+import getProjectFile from "./helpers/projectFile.ts";
 
-const SOME_FILE = path.join(__dirname, "..", "package-lock.json");
+const SOME_FILE = getProjectFile("package-lock.json");
 
 test("Can create a feed", async ({ page }) => {
   test.slow();
diff --git a/tests/feedops.spec.ts b/tests/feedops.spec.ts
@@ -1,9 +1,9 @@
 import { test, expect } from "./fixtures/loggedIn.ts";
 import { faker } from "@faker-js/faker";
 import createFeed from "./helpers/createFeedHelper";
-import path from "path";
+import getProjectFile from "./helpers/projectFile.ts";
 
-const SOME_FILE = path.join(__dirname, "..", "package-lock.json");
+const SOME_FILE = getProjectFile("package-lock.json");
 
 test("Can perform feed operations", async ({ page, isMobile }) => {
   test.slow();
diff --git a/tests/helpers/projectFile.ts b/tests/helpers/projectFile.ts
@@ -0,0 +1,8 @@
+import path from "path";
+import { fileURLToPath } from "url";
+
+export default function getProjectFile(...parts: string[]): string {
+  const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
+  const __dirname = path.dirname(__filename); // get the name of the directory
+  return path.join(__dirname, "..", "..", ...parts);
+}
diff --git a/tests/library.spec.ts b/tests/library.spec.ts
@@ -1,5 +1,5 @@
 import { test, expect } from "./fixtures/loggedIn.ts";
-import path from "path";
+import getProjectFile from "./helpers/projectFile.ts";
 
 test("Tests File Uploads", async ({ page }) => {
   //Avoids timeouts.
@@ -28,7 +28,7 @@ test("Tests File Uploads", async ({ page }) => {
     await page.getByRole("button", { name: /upload files/i }).click();
     const fileChooser = await fileChooserPromise;
 
-    const SOME_FILE = path.join(__dirname, "..", "package-lock.json");
+    const SOME_FILE = getProjectFile("package-lock.json");
     await fileChooser.setFiles(SOME_FILE);
 
     await page.waitForSelector("input[name='horizontal-form-name']");
diff --git a/tsconfig.json b/tsconfig.json
@@ -19,7 +19,7 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
-    "noImplicitAny":true,
+    "noImplicitAny": true
   },
   "references": [{ "path": "./tsconfig.node.json" }]
 }
diff --git a/tsconfig.node.json b/tsconfig.node.json
@@ -4,7 +4,7 @@
     "skipLibCheck": true,
     "module": "ESNext",
     "moduleResolution": "bundler",
-    "noImplicitAny":true,
+    "noImplicitAny": true,
     "allowSyntheticDefaultImports": true
   },
   "include": ["vite.config.ts"]
diff --git a/vite.config.ts b/vite.config.ts
@@ -26,7 +26,6 @@ export default defineConfig({
       // workaround for "Cornerstone3D tools does not build with vite"
       // https://github.com/cornerstonejs/cornerstone3D/issues/1071
       "@cornerstonejs/tools": "@cornerstonejs/tools/dist/umd/index.js",
-      "fs": require.resolve("rollup-plugin-node-builtins")
     },
   },
 });
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -1,17 +1,20 @@
-import { defineConfig, mergeConfig } from 'vitest/config';
-import viteConfig from './vite.config';
+import { defineConfig, mergeConfig } from "vitest/config";
+import viteConfig from "./vite.config";
 
-export default mergeConfig(viteConfig, defineConfig({
-  test: {
-    include: ['src/**/*.{test,spec}.?(c|m)[jt]s?(x)'],
-    environment: 'happy-dom',
-    restoreMocks: true,
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      include: ["src/**/*.{test,spec}.?(c|m)[jt]s?(x)"],
+      environment: "happy-dom",
+      restoreMocks: true,
 
-    // coverage for unit testing not enabled, because we have none!
-    // coverage: {
-    //   enabled: true,
-    //   include: ["src/**"],
-    //   reportsDirectory: "./coverage-vitest",
-    // },
-  },
-}));
+      // coverage for unit testing not enabled, because we have none!
+      // coverage: {
+      //   enabled: true,
+      //   include: ["src/**"],
+      //   reportsDirectory: "./coverage-vitest",
+      // },
+    },
+  }),
+);

Original file line number	Diff line number	Diff line change
`@@ -126,5 +126,6 @@`
`126`	`126`	`"vite": "^5.3.2",`
`127`	`127`	`"vite-plugin-istanbul": "^6.0.2",`
`128`	`128`	`"vitest": "^2.0.5"`
`129`		`- }`
	`129`	`+ },`
	`130`	`+ "type": "module"`
`130`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`"noUnusedLocals": true,`
`20`	`20`	`"noUnusedParameters": true,`
`21`	`21`	`"noFallthroughCasesInSwitch": true,`
`22`		`- "noImplicitAny":true,`
	`22`	`+ "noImplicitAny": true`
`23`	`23`	`},`
`24`	`24`	`"references": [{ "path": "./tsconfig.node.json" }]`
`25`	`25`	`}`