tests: update vitest.config

vitest.config.js

@@ -1,16 +1,39 @@
 /// <reference types="vitest" />
 
 import { defineConfig } from "vite";
-import { vitestSetupFilePath, getClarinetVitestsArgv } from "@hirosystems/clarinet-sdk/vitest";
+import {
+  vitestSetupFilePath,
+  getClarinetVitestsArgv,
+} from "@hirosystems/clarinet-sdk/vitest";
+
+/*
+  In this file, Vitest is configured so that it works seamlessly with Clarinet and the Simnet.
+
+  The `vitest-environment-clarinet` will initialise the clarinet-sdk
+  and make the `simnet` object available globally in the test files.
+
+  `vitestSetupFilePath` points to a file in the `@hirosystems/clarinet-sdk` package that does two things:
+    - run `before` hooks to initialize the simnet and `after` hooks to collect costs and coverage reports.
+    - load custom vitest matchers to work with Clarity values (such as `expect(...).toBeUint()`)
+
+  The `getClarinetVitestsArgv()` will parse options passed to the command `vitest run --`
+    - vitest run -- --manifest ./Clarinet.toml  # pass a custom path
+    - vitest run -- --coverage --costs          # collect coverage and cost reports
+*/
 
-console.log(vitestSetupFilePath);
 export default defineConfig({
   test: {
-    environment: "clarinet",
+    environment: "clarinet", // use vitest-environment-clarinet
     singleThread: true,
-    setupFiles: [vitestSetupFilePath],
+    setupFiles: [
+      vitestSetupFilePath,
+      // custom setup files can be added here
+    ],
     environmentOptions: {
-      clarinet: getClarinetVitestsArgv(),
+      clarinet: {
+        ...getClarinetVitestsArgv(),
+        // add or override options
+      },
     },
   },
 });