as-test 0.1.9 → 0.2.0

package/CHANGELOG.md

@@ -18,5 +18,6 @@ v0.1.6 - Fix: args should be prefixed with a space
 v0.1.7 - Fix: remove warning about wasi-shim not being included when it is included
 v0.1.8 - Feat: function mocking
 v0.1.9 - Fix: mocks were not being applied to declared functions, only property accesses
-
-v0.1.10 [UNRELEASED] - Feat: snapshotting
+v0.1.10 - Feat: support node, deno, and bun
+v0.2.0 - Fix mock -> mockFn artifacts
+[UNRELEASED] - Feat: snapshotting

package/README.md

@@ -3,17 +3,28 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.1.9
+v0.2.0
 </pre>
 </h5>
 
 ## Installation
 
-```bash
-npm install as-test
-```
+To get started, install the package from NPM or GitHub
+
+`npm i as-test --save-dev`
+
+You'll also need to install `visitor-as`
+
+`npm i visitor-as --save-dev`
+
+## Templates
+
+I provide two templates for reference
 
-Note: The transform _is_ OPTIONAL, though it is required to enable code coverage.
+[WASI](https://github.com/JairusSW/as-test/tree/template/wasi)
+[Node/Bun/Deno](https://github.com/JairusSW/as-test/tree/template/node-bun-deno)
+
+View the docs: https://docs.jairus.dev/as-test
 
 ## Usage
 
@@ -38,7 +49,7 @@ import {
   afterAll,
   beforeEach,
   afterEach,
-  mock,
+  mockFn,
   log,
   run
 } from "as-test";
@@ -52,7 +63,7 @@ afterAll(() => {
 });
 
 // Mock/override the function console.log
-mock("console.log", (data: string): void => {
+mockFn<void>("console.log", (data: string): void => {
   console.log("[MOCKED]: " + data + "\n");
 });
 
@@ -129,16 +140,6 @@ If you use this project in your codebase, consider dropping a [⭐ HERE](https:/
 This library is in the EARLY STAGES OF DEVELOPMENT!
 If you want a feature, drop an issue (and again, maybe a star). I'll likely add it in less than 7 days.
 
-## Contact
-
-Contact me at:
-
-Email: `me@jairus.dev`
-
-GitHub: `JairusSW`
-
-Discord: `jairussw`
-
 ## Issues
 
 Please submit an issue to https://github.com/JairusSW/as-test/issues if you find anything wrong with this library

package/asconfig.json

@@ -26,8 +26,6 @@
     }
   },
   "options": {
-    "transform": [],
-    "disableWarning": [226]
-  },
-  "extends": "./node_modules/@assemblyscript/wasi-shim/asconfig.json"
+    "bindings": "esm"
+  }
 }

package/assembly/__tests__/example.spec.ts

@@ -8,20 +8,10 @@ import {
   afterEach,
   log,
   run,
-  mock,
+  mockFn,
 } from "..";
 
-function hello(a: i32, b: i32, c: i32): void {
-  console.log("a: " + a.toString());
-  console.log("b: " + b.toString());
-  console.log("c: " + c.toString());
-}
-
-mock("hello", (a: i32, b: i32, c: i32): void => {
-  hello(a + 10, b + 10, c + 10);
-});
-
-mock("console.log", (data: string): void => {
+mockFn<void>("console.log", (data: string): void => {
   console.log("[MOCKED]: " + data);
 });
 
@@ -47,7 +37,6 @@ describe("Math operations", () => {
   });
 
   test("Mock", () => {
-    hello(1, 2, 3);
     console.log("hello");
   });
 

package/assembly/index.ts

@@ -175,7 +175,12 @@ export function afterEach(callback: () => void): void {
   after_each_callback = callback;
 }
 
-export function mock<returnType>(
+/**
+ * Overrides all references to an existing function to instead point to this
+ * @param {string} fn - name of function to override
+ * @param {() => returnType} callback - the function to substitute it with
+ */
+export function mockFn<returnType>(
   fn: string,
   callback: (...args: any[]) => returnType,
 ): void {}
@@ -235,7 +240,7 @@ export function run(options: RunOptions = new RunOptions()): void {
     ),
   );
   console.log(
-    rainbow.dimMk("\n------------------- v0.1.9 -------------------\n"),
+    rainbow.dimMk("\n------------------- v0.2.0 -------------------\n"),
   );
   // @ts-ignore
   if (isDefined(COVERAGE_USE)) {

package/bin/build.js

@@ -6,113 +6,140 @@ import { exec } from "child_process";
 import { formatTime } from "./util.js";
 import * as path from "path";
 export async function build(args) {
-    const CONFIG_PATH = path.join(process.cwd(), "./as-test.config.json");
-    let config;
-    if (!existsSync(CONFIG_PATH)) {
-        console.log(chalk.bgMagentaBright(" WARN ") +
-            chalk.dim(":") +
-            " Could not locate config file in the current directory! Continuing with default config." +
-            "\n");
-        config = new Config();
+  const CONFIG_PATH = path.join(process.cwd(), "./as-test.config.json");
+  let config;
+  if (!existsSync(CONFIG_PATH)) {
+    console.log(
+      chalk.bgMagentaBright(" WARN ") +
+        chalk.dim(":") +
+        " Could not locate config file in the current directory! Continuing with default config." +
+        "\n",
+    );
+    config = new Config();
+  } else {
+    config = Object.assign(
+      new Config(),
+      JSON.parse(readFileSync(CONFIG_PATH).toString()),
+    );
+    console.log(chalk.dim("Loading config from: " + CONFIG_PATH) + "\n");
+  }
+  const ASCONFIG_PATH = path.join(process.cwd(), config.config);
+  if (!existsSync(ASCONFIG_PATH)) {
+    console.log(
+      chalk.bgMagentaBright(" WARN ") +
+        chalk.dim(":") +
+        ' Could not locate asconfig.json file! If you do not want to provide a config, set "config": "none". Continuing with default config.' +
+        "\n",
+    );
+  }
+  const pkg = JSON.parse(readFileSync("./package.json").toString());
+  let buildCommands = [];
+  if (config.buildOptions.wasi) {
+    if (!existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
+      console.log(
+        chalk.bgRed(" ERROR ") +
+          chalk.dim(":") +
+          " " +
+          "could not find @assemblyscript/wasi-shim! Add it to your dependencies to run with WASI!",
+      );
+      process.exit(1);
     }
-    else {
-        config = Object.assign(new Config(), JSON.parse(readFileSync(CONFIG_PATH).toString()));
-        console.log(chalk.dim("Loading config from: " + CONFIG_PATH) + "\n");
+    if (
+      pkg.dependencies &&
+      !Object.keys(pkg.dependencies).includes("@assemblyscript/wasi-shim") &&
+      pkg.devDependencies &&
+      !Object.keys(pkg.devDependencies).includes("@assemblyscript/wasi-shim") &&
+      pkg.peerDependencies &&
+      !Object.keys(pkg.peerDependencies).includes(
+        "@assemblyscript/wasi-shim",
+      ) &&
+      existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")
+    ) {
+      console.log(
+        chalk.bold.bgMagentaBright(" WARN ") +
+          chalk.dim(": @assemblyscript/wasi-shim") +
+          " is not included in project dependencies!",
+      );
     }
-    const ASCONFIG_PATH = path.join(process.cwd(), config.config);
-    if (!existsSync(ASCONFIG_PATH)) {
-        console.log(chalk.bgMagentaBright(" WARN ") +
-            chalk.dim(":") +
-            ' Could not locate asconfig.json file! If you do not want to provide a config, set "config": "none". Continuing with default config.' +
-            "\n");
+  }
+  let packageManagerCommand = "npx";
+  if (
+    process.env.npm_config_user_agent &&
+    process.env.npm_config_user_agent.includes("pnpm")
+  ) {
+    packageManagerCommand = "pnpx";
+  } else if (
+    process.env.npm_config_user_agent &&
+    process.env.npm_config_user_agent.includes("yarn")
+  ) {
+    packageManagerCommand = "yarn run";
+  } else if (
+    process.env.npm_config_user_agent &&
+    process.env.npm_config_user_agent.includes("bun")
+  ) {
+    packageManagerCommand = "bunx";
+  }
+  console.log("");
+  const inputFiles = await glob(config.input);
+  for (const file of inputFiles) {
+    console.log(chalk.dim("Including " + file));
+    let command = `${packageManagerCommand} asc ${file}${args.length ? " " + args.join(" ") : ""}`;
+    if (config.config !== "none") {
+      command += " --config " + config.config;
     }
-    const pkg = JSON.parse(readFileSync("./package.json").toString());
-    let buildCommands = [];
     if (config.buildOptions.wasi) {
-        if (!existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
-            console.log(chalk.bgRed(" ERROR ") +
-                chalk.dim(":") +
-                " " +
-                "could not find @assemblyscript/wasi-shim! Add it to your dependencies to run with WASI!");
-            process.exit(1);
-        }
-        if (pkg.dependencies &&
-            !Object.keys(pkg.dependencies).includes("@assemblyscript/wasi-shim") &&
-            pkg.devDependencies &&
-            !Object.keys(pkg.devDependencies).includes("@assemblyscript/wasi-shim") &&
-            pkg.peerDependencies &&
-            !Object.keys(pkg.peerDependencies).includes("@assemblyscript/wasi-shim") &&
-            existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
-            console.log(chalk.bold.bgMagentaBright(" WARN ") +
-                chalk.dim(": @assemblyscript/wasi-shim") +
-                " is not included in project dependencies!");
-        }
+      command +=
+        " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
     }
-    let packageManagerCommand = "npx";
-    if (process.env.npm_config_user_agent &&
-        process.env.npm_config_user_agent.includes("pnpm")) {
-        packageManagerCommand = "pnpx";
+    const outFile =
+      config.outDir +
+      "/" +
+      file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm");
+    if (config.outDir) {
+      command += " -o " + outFile;
     }
-    else if (process.env.npm_config_user_agent &&
-        process.env.npm_config_user_agent.includes("yarn")) {
-        packageManagerCommand = "yarn run";
+    if (config.coverage.enabled) {
+      console.log(chalk.dim("Enabling coverage"));
+      command += " --use COVERAGE_USE=1 --transform as-test/transform";
+      if (config.coverage.show) command += " --use COVERAGE_SHOW=1";
     }
-    else if (process.env.npm_config_user_agent &&
-        process.env.npm_config_user_agent.includes("bun")) {
-        packageManagerCommand = "bunx";
+    if (config.buildOptions.args) {
+      command += " " + config.buildOptions.args.join(" ");
     }
-    console.log("");
-    const inputFiles = await glob(config.input);
-    for (const file of inputFiles) {
-        console.log(chalk.dim("Including " + file));
-        let command = `${packageManagerCommand} asc ${file}${args.length ? " " + args.join(" ") : ""}`;
-        if (config.buildOptions.wasi) {
-            command +=
-                " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
-        }
-        if (config.config !== "none") {
-            command += " --config " + config.config;
-        }
-        const outFile = config.outDir +
-            "/" +
-            file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm");
-        if (config.outDir) {
-            command += " -o " + outFile;
-        }
-        if (config.coverage.enabled) {
-            console.log(chalk.dim("Enabling coverage"));
-            command += " --use COVERAGE_USE=1 --transform as-test/transform";
-            if (config.coverage.show)
-                command += " --use COVERAGE_SHOW=1";
-        }
-        if (config.buildOptions.args) {
-            command += " " + config.buildOptions.args.join(" ");
-        }
-        buildCommands.push(command);
+    if (
+      ["node", "deno", "bun"].includes(
+        config.runOptions.runtime.run.split(" ")[0],
+      )
+    ) {
+      command += " --exportStart";
     }
-    const build = (command) => {
-        return new Promise((resolve, _) => {
-            console.log(chalk.dim("Building: " + command));
-            exec(command, (err, stdout, stderr) => {
-                if (config.buildOptions.verbose) {
-                    process.stdout.write(stdout);
-                }
-                if (err) {
-                    process.stderr.write(stderr + "\n");
-                    process.exit(1);
-                }
-                resolve();
-            });
-        });
-    };
-    if (config.buildOptions.parallel) {
-        console.log(chalk.dim("Building sources in parallel..."));
-        const start = performance.now();
-        let builders = [];
-        for (const command of buildCommands) {
-            builders.push(build(command));
+    buildCommands.push(command);
+  }
+  const build = (command) => {
+    return new Promise((resolve, _) => {
+      console.log(chalk.dim("Building: " + command));
+      exec(command, (err, stdout, stderr) => {
+        if (config.buildOptions.verbose) {
+          process.stdout.write(stdout);
+        }
+        if (err) {
+          process.stderr.write(stderr + "\n");
+          process.exit(1);
         }
-        await Promise.all(builders);
-        console.log(chalk.dim("Compiled in " + formatTime(performance.now() - start)) + "\n");
+        resolve();
+      });
+    });
+  };
+  if (config.buildOptions.parallel) {
+    console.log(chalk.dim("Building sources in parallel..."));
+    const start = performance.now();
+    let builders = [];
+    for (const command of buildCommands) {
+      builders.push(build(command));
     }
+    await Promise.all(builders);
+    console.log(
+      chalk.dim("Compiled in " + formatTime(performance.now() - start)) + "\n",
+    );
+  }
 }