Add Tests for Creating a New Project

package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "lint": "svelte-check --tsconfig tsconfig.json --fail-on-hints && eslint . --ext .ts",
     "test:unit": "vitest",
+    "test:integration": "rollup --config rollup.config.js -w --environment BUILD:integrationTest",
     "dev": "rollup --config rollup.config.js -w",
     "build": "npm run lint && rollup --config rollup.config.js --environment BUILD:production"
   },

rollup.config.js

@@ -63,6 +63,11 @@ const DEV_PLUGIN_CONFIG = {
   ),
 };
 
+const INT_TEST_PLUGIN_CONFIG = {
+  ...DEV_PLUGIN_CONFIG,
+  input: "src/integration/main.ts",
+};
+
 const PROD_PLUGIN_CONFIG = {
   ...BASE_CONFIG,
   output: {
@@ -75,6 +80,10 @@ const PROD_PLUGIN_CONFIG = {
   plugins: getPlugins(),
 };
 
-const config = isProd ? PROD_PLUGIN_CONFIG : DEV_PLUGIN_CONFIG;
+const config = isProd
+  ? PROD_PLUGIN_CONFIG
+  : env.BUILD === "integrationTest"
+  ? INT_TEST_PLUGIN_CONFIG
+  : DEV_PLUGIN_CONFIG;
 
 export default config;

src/integration/ConsoleReporter.ts

@@ -0,0 +1,90 @@
+import type { TestReporter } from "./framework/report";
+
+type StructuredResults = {
+  id: string;
+  name: string;
+  parent: StructuredResults | null;
+  result: Error | void;
+};
+
+/**
+ * Reports test restuls to the console.
+ */
+export class ConsoleReporter implements TestReporter {
+  private structure: StructuredResults = {
+    id: "root",
+    name: "root",
+    parent: null,
+    result: undefined,
+  };
+
+  private readonly structures = new Map<string, StructuredResults>();
+
+  /**
+   *
+   * @param verbose If you want to see all the running tests, and all tests that pass, set to `true`.
+   * @default verbose `false`
+   */
+  constructor(private readonly verbose: boolean = false) {}
+
+  onCollectSuite(id: string, name: string): void {
+    const structure: StructuredResults = {
+      id,
+      name,
+      parent: this.structure,
+      result: undefined,
+    };
+    this.structure = structure;
+    this.structures.set(id, structure);
+  }
+
+  onSuiteCollected(id: string): void {
+    this.structure = this.structure.parent;
+  }
+
+  onCollectTest(id: string, name: string): void {
+    const structure: StructuredResults = {
+      id,
+      name,
+      parent: this.structure,
+      result: undefined,
+    };
+    this.structures.set(id, structure);
+  }
+
+  onStartSuite(id: string): void {}
+
+  onStartTest(id: string): void {
+    if (this.verbose) {
+      const structure = this.structures.get(id);
+      const fullName = buildName(structure);
+      console.log("Running", fullName);
+    }
+  }
+
+  onEndTest(
+    id: string,
+    result: unknown | void,
+    afterResult: void | Error
+  ): void {
+    const structure = this.structures.get(id);
+    const fullName = buildName(structure);
+    if (!!result) {
+      console.log("failed", fullName);
+    } else if (this.verbose) {
+      console.log("passed", fullName);
+    }
+  }
+
+  onEndSuite(id: string): void {}
+}
+
+function buildName(structure: StructuredResults): string {
+  if (structure.parent) {
+    return buildName(structure.parent) + " > " + structure.name;
+  }
+  if (structure.id === "root") {
+    return "";
+  }
+  return structure.name;
+}

src/integration/Readme.md

@@ -0,0 +1,21 @@
+# What is this?
+This folder contains potentially slow-running integration tests that require working with the obsidian API directly.
+
+## Contracts Folder
+The contracts folder provides contracts to interfaces that unit tests, and integration tests, can run against.
+
+## Framework Folder
+The framework folder is an ad-hoc testing framework that can run within obsidian.
+
+# Why is it inside the src folder?
+To make the rollup-typscript plugin not complain about typescript files being outside of the rootDir.
+
+# Will it be included in the plugin?
+No.  There is a new build configuration that targets the main.ts file located here.  It is a complete isolated build.  When the normal build process is run, the normal main.ts file with the src folder is targeted, and nothing in this folder is imported, thus, nothing in this folder is bundled.
+
+## How do I run the tests?
+run `npm run test:integration`
+Then open the test vault in obsidian.
+
+## How do I add new tests?
+The ad-hoc framework does not automatically detect tests within the tests folder, so, for now, a reference to your new test will need to be added to the list in the run.ts file.