doc: add mjs config example (#6)

Author: HerrCai0907

README.md

@@ -41,12 +41,22 @@ endTest();  // Don't forget it!
 
 Create a config file in project root `as-test.config.js`:
 
+for cjs:
+
 ```javascript
 module.exports = {
   include: ["source", "tests"],
 };
 ```
 
+for mjs:
+
+```javascript
+export default {
+  include: ["source", "tests"],
+};
+```
+
 Add the following section to your `package.json`
 
 ```json

as-test.config.cjs renamed to as-test.config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   /** file include in test */
   include: ["assembly", "tests-as"],
 

example/as-test.config.cjs

@@ -2,7 +2,7 @@ module.exports = {
   include: ["example"],
   exclude: ["assembly/coverageCollector.ts", "assembly/mock.ts"],
 
-  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug*/
+  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug -O0 */
   flags: "",
 
   /**

example/as-test.config.js

@@ -0,0 +1,22 @@
+export default {
+  include: ["example"],
+  exclude: ["assembly/coverageCollector.ts", "assembly/mock.ts"],
+
+  /** assemblyscript compile flag, default is --exportStart _start --sourceMap --debug -O0 */
+  flags: "",
+
+  /**
+   * import functions
+   * @param {ImportsArgument} runtime
+   * @returns
+   */
+  imports(runtime) {
+    return {};
+  },
+
+  /** template file path, default "coverage" */
+  temp: "coverage",
+
+  /** report file path, default "coverage" */
+  output: "coverage",
+};

package.json

@@ -13,10 +13,10 @@
   "prettier": "@schleifner/prettier-config",
   "scripts": {
     "build": "tsc --build ./transform/tsconfig.json && node ./build/esbuild.js",
-    "test": "node bin/as-test.js --config ./as-test.config.cjs && cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "test": "node bin/as-test.js && cross-env NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "eslint src assembly tests-ts/test --max-warnings=0 && prettier -c .",
     "lint:fix": "eslint src assembly --fix",
-    "example": "node bin/as-test.js --config example/as-test.config.cjs"
+    "example": "node bin/as-test.js --config example/as-test.config.cjs ; node bin/as-test.js --config example/as-test.config.js"
   },
   "dependencies": {
     "@assemblyscript/loader": ">=0.25.1",

src/core/precompile.ts

@@ -23,11 +23,11 @@ export async function precompile(
   const testCodePaths = testcases ?? getRelatedFiles(includes, excludes, (path: string) => path.endsWith(".test.ts"));
 
   const sourceCodePaths = getRelatedFiles(includes, excludes, (path: string) => !path.endsWith(".test.ts"));
-  const sourceCodeTransfroms: Promise<void>[] = [];
+  const sourceCodeTransforms: Promise<void>[] = [];
   for (const sourceCodePath of sourceCodePaths.values()) {
-    sourceCodeTransfroms.push(transform(sourceCodePath, transformFunction));
+    sourceCodeTransforms.push(transform(sourceCodePath, transformFunction));
   }
-  await Promise.all(sourceCodeTransfroms);
+  await Promise.all(sourceCodeTransforms);
 
   return {
     testCodePaths,
@@ -43,11 +43,11 @@ export function getRelatedFiles(includes: string[], excludes: string[], filter:
   const exc = ignore.default().add(excludes);
 
   for (const path of includeFiles) {
-    const relativedPath = relative(".", path);
-    if (relativedPath.startsWith("..")) {
+    const relativePath = relative(".", path);
+    if (relativePath.startsWith("..")) {
       throw new Error(`file ${path} out of scope (${resolve(".")})`);
     }
-    if (exc.ignores(relativedPath)) {
+    if (exc.ignores(relativePath)) {
       continue; // ab
     }
     if (filter(path)) {

tests-ts/test/core/__snapshots__/precompile.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`listFunction transfrom 1`] = `
+exports[`listFunction transform 1`] = `
 Map {
   "tests-ts/fixture/transformFunction.ts" => [
     {

tests-ts/test/core/precompile.test.ts

@@ -2,16 +2,16 @@ import { join } from "node:path";
 import { fileURLToPath, URL } from "node:url";
 import { precompile } from "../../../src/core/precompile.js";
 
-test("listFunction transfrom", async () => {
-  const transfromFunction = join(
+test("listFunction transform", async () => {
+  const transformFunction = join(
     fileURLToPath(new URL(".", import.meta.url)),
     "..",
     "..",
     "..",
     "transform",
     "listFunctions.mjs"
   );
-  const unittestPackages = await precompile(["tests-ts/fixture/transformFunction.ts"], [], [], transfromFunction);
+  const unittestPackages = await precompile(["tests-ts/fixture/transformFunction.ts"], [], [], transformFunction);
   expect(unittestPackages.testCodePaths).toEqual([]);
   expect(unittestPackages.sourceFunctions).toMatchSnapshot();
 });

tests-ts/test/core/throwError.test.ts

@@ -20,7 +20,7 @@ const { precompile } = await import("../../../src/core/precompile.js");
 const { compile } = await import("../../../src/core/compile.js");
 
 test("transform error", async () => {
-  const transfromFunction = join(
+  const transformFunction = join(
     fileURLToPath(new URL(".", import.meta.url)),
     "..",
     "..",
@@ -30,12 +30,12 @@ test("transform error", async () => {
   );
   expect(jest.isMockFunction(main)).toBeTruthy();
   await expect(async () => {
-    await precompile(["tests-ts/fixture/transformFunction.ts"], [], [], transfromFunction);
-  }).rejects.toThrowError("mock asc.main() error");
+    await precompile(["tests-ts/fixture/transformFunction.ts"], [], [], transformFunction);
+  }).rejects.toThrow("mock asc.main() error");
 });
 
 test("compile error", async () => {
   await expect(async () => {
     await compile(["non-exist.ts"], "mockFolder", "");
-  }).rejects.toThrowError("mock asc.main() error");
+  }).rejects.toThrow("mock asc.main() error");
 });