chore(doc): update configuration document and example

.github/workflows/ci-test.yml

@@ -42,6 +42,13 @@ jobs:
       - run: npm run lint
       - run: npm run test
 
+      - working-directory: ./example
+        run: |
+          set -e
+          npm ci
+          npm run test
+          npm run test:cjs
+
       - name: verify ccache stats
         run: |
           set -e

config.d.ts

@@ -0,0 +1,29 @@
+import { Imports } from "./dist/interface.d.ts";
+
+export type OutputMode = "html" | "json" | "table";
+
+export declare class Config {
+  /** Files to include in testing and coverage statistics */
+  include: string[];
+  /** Files to exclude from testing and coverage statistics, has higher priority than include */
+  exclude?: string[];
+
+  /** whether to collect coverage information, default is true */
+  collectCoverage?: boolean;
+
+  /** create an wasm instance for each test files. default is false (will be true in next major version) */
+  isolated?: boolean;
+
+  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug -O0 */
+  flags?: string;
+  imports?: Imports;
+
+  /** template folder path, default "./coverage" */
+  temp?: string;
+
+  /** report folder path, default "./coverage" */
+  output?: string;
+
+  /** output report mode, default is "table" */
+  mode?: OutputMode | OutputMode[];
+}

docs/api-documents/configuration.md

@@ -1,54 +1,8 @@
 ## Configuration
 
-This is the template of `as-test.config.js`:
+The [template](https://github.com/wasm-ecosystem/assemblyscript-unittest-framework/blob/main/example/as-test.config.js) of `as-test.config.js`
 
-```javascript
-module.exports = {
-  // test related code folder
-  include: ["source", "tests"],
-  exclude: [],
-
-  /** optional: assemblyscript compile flag, default is --exportStart _start -O0 */
-  flags: "",
-
-  /**
-   * optional: import functions
-   * @param {ImportsArgument} runtime
-   * @returns
-   */
-  imports(runtime) {
-    return {
-      env: {
-        logInfo(ptr, len) {
-          let buf = runtime.exports!.__getArrayBuffer(ptr);
-          let str = Buffer.from(buf).toString("utf8");
-          runtime.framework.log(str); // log to unittest framework
-          console.log(str); // log to console
-        },
-      },
-      console: {
-        log(ptr) {
-          runtime.framework.log(runtime.exports!.__getString(msg));
-        }
-      }
-      builtin: {
-        getU8FromLinkedMemory(a) {
-          return 1;
-        },
-      },
-    };
-  },
-
-  /**  optional: template file path, default "coverage" */
-  // temp: "coverage",
-
-  /**  optional: report file path, default "coverage" */
-  // output: "coverage",
-
-  /** optional: test result output format, default "table" */
-  // mode: ["html", "json", "table"],
-};
-```
+The [type declaration](https://github.com/wasm-ecosystem/assemblyscript-unittest-framework/blob/main/config.d.ts) of config.
 
 ### Imports
 

example/.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+/coverage

example/as-test.config.cjs

@@ -1,15 +1,10 @@
+/** @type {import("assemblyscript-unittest-framework/config.d.ts").Config} */
 module.exports = {
-  include: ["example"],
-  exclude: ["assembly/coverageCollector.ts", "assembly/mock.ts"],
+  include: ["tests"],
+  exclude: ["lib"],
 
-  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug -O0 */
   flags: "",
 
-  /**
-   * import functions
-   * @param {ImportsArgument} runtime
-   * @returns
-   */
   imports(runtime) {
     return {
       env: {
@@ -20,9 +15,6 @@ module.exports = {
     };
   },
 
-  /** template file path, default "coverage" */
   temp: "coverage",
-
-  /** report file path, default "coverage" */
   output: "coverage",
 };

example/as-test.config.js

@@ -1,15 +1,10 @@
+/** @type {import("assemblyscript-unittest-framework/config.d.ts").Config} */
 export default {
-  include: ["example"],
-  exclude: ["assembly/coverageCollector.ts", "assembly/mock.ts"],
+  include: ["tests"],
+  exclude: ["lib"],
 
-  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug -O0 */
   flags: "",
 
-  /**
-   * import functions
-   * @param {ImportsArgument} runtime
-   * @returns
-   */
   imports(runtime) {
     return {
       env: {
@@ -20,9 +15,8 @@ export default {
     };
   },
 
-  /** template file path, default "coverage" */
   temp: "coverage",
-
-  /** report file path, default "coverage" */
   output: "coverage",
+
+  isolated: false,
 };

example/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "example",
+  "type": "module",
+  "dependencies": {
+    "assemblyscript-unittest-framework": "file:.."
+  },
+  "scripts": {
+    "test": "! as-test",
+    "test:cjs": "! as-test --config as-test.config.js"
+  }
+}

example/source.test.ts → example/tests/source.test.ts

@@ -1,6 +1,6 @@
-import { describe, test, expect, mock } from "../assembly";
-import { log } from "./env";
-import { add, Test } from "./source";
+import { describe, test, expect, mock } from "assemblyscript-unittest-framework/assembly";
+import { log } from "../lib/env";
+import { add, Test } from "../assembly/source";
 
 describe("example 1", () => {
   test("two plus two is four", () => {

example/source2.test.ts → example/tests/source2.test.ts

@@ -1,7 +1,7 @@
-import { describe, test, expect } from "../assembly";
-import { quick_sort } from "./source2";
+import { describe, test, expect } from "assemblyscript-unittest-framework/assembly";
+import { quick_sort } from "../assembly/source2";
 
-describe("quick_sork", () => {
+describe("quick_sort", () => {
   test("1", () => {
     let d = [1, 2, 3];
     quick_sort(d);

package.json

@@ -23,7 +23,6 @@
     "lint:as": "npx eslint --config ./assembly/eslint.config.mjs assembly --max-warnings=0",
     "lint": "npm run lint:ts && prettier -c .",
     "lint:fix:ts": "eslint src transform tests/ts/test --fix && prettier --write .",
-    "example": "node bin/as-test.js --config example/as-test.config.cjs ; node bin/as-test.js --config example/as-test.config.js",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs"
   },
@@ -79,11 +78,12 @@
   "files": [
     "assembly/**/*",
     "bin/**/*",
-    "dist/**/*",
     "build_wasm/bin/wasm-instrumentation.js",
+    "config.d.ts",
+    "dist/**/*",
     "docs/**/*",
-    "transform/**/*",
     "resource/**/*",
+    "transform/**/*",
     "LICENSE",
     "README.md"
   ]