feat: introduce entryFiles in config to remove precompile transform (#88)

Author: HerrCai0907

.gitignore

@@ -5,8 +5,6 @@
 /dist
 
 /build*
-/transform/*.mjs
-/transform/tsconfig.tsbuildinfo
 
 /coverage
 /coverage-ts

.prettierignore

@@ -2,7 +2,6 @@
 /coverage-ts
 /dist
 /node_modules
-/transform/*.mjs
 /tests/ts/fixture
 /third_party
 /tests/cpp/lit/expectInstrument**/*.json

as-test.config.js

@@ -1,30 +1,15 @@
+/**
+ * @type {import("./config.d.ts").Config}
+ */
 export default {
-  /** file include in test */
   include: ["assembly", "tests/as"],
-
-  /** optional: file exclude */
   exclude: [],
-
-  /** optional: assemblyscript compile flag, default is --exportStart _start -O0 */
   flags: "",
-
-  /**
-   * optional: import functions
-   * @param {ImportsArgument} runtime
-   * @returns
-   */
   imports(runtime) {
     return {};
   },
-
-  /** 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"],
-
   isolated: false,
 };

bin/cli.js

@@ -88,13 +88,17 @@ const getBoolean = (optionValue, configValue) => {
 const isolatedInConfig = getBoolean(options.isolated, config.isolated);
 const isolated = isolatedInConfig ?? false;
 
+const entryFiles = config.entryFiles ?? null;
+
 /**
  * @type {import("../dist/interface.d.ts").TestOption}
  */
 const testOption = {
   includes,
   excludes,
   testFiles,
+  entryFiles,
+
   testNamePattern: testNamePattern,
   collectCoverage,
   onlyFailures,

config.d.ts

@@ -1,4 +1,4 @@
-import { Imports } from "./dist/interface.d.ts";
+import type { Imports } from "./dist/interface.d.ts";
 
 export type OutputMode = "html" | "json" | "table";
 
@@ -7,14 +7,16 @@ export declare class Config {
   include: string[];
   /** Files to exclude from testing and coverage statistics, has higher priority than include */
   exclude?: string[];
+  /** entry files for the whole projects, used to collect all source code information. default value is `${include}/index.ts` */
+  entryFiles?: 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 */
+  /** assemblyscript compile flag, default is --exportStart __unit_test_start --sourceMap --debug -O0 */
   flags?: string;
   imports?: Imports;
 

docs/release-note.md

@@ -6,6 +6,10 @@
 
 - Changed the default value of `isolated` from `true` to `false`.
 
+🛠️ Improvements
+
+- Introduce new configuration `entryFiles` to reach all source code. ([#88](https://github.com/wasm-ecosystem/assemblyscript-unittest-framework/pull/88))
+
 ## 1.4.1
 
 🚀 Highlight Features

docs/technical-details/code-debug-info.md

@@ -19,22 +19,4 @@
 }
 ```
 
-```ts
-interface CodeDebugInfo {
-    debugFiles: string[];
-    debugInfos: Record<string, FunctionDebugInfo>;
-}
-
-interface FunctionDebugInfo {
-    index: number;
-    branchInfo: Branch[];
-    lineInfo: LineInfos;
-}
-
-type LineRange = [FileIndex, LineIndex, ColumnIndex][][];
-type LineInfos = LineRange[][];
-type FileIndex = number;
-type LineIndex = number;
-type ColumnIndex = number;
-type Branch = [number, number];
-```
+The schema corresponding to json can be found in interface `DebugInfo` in `src/interface.ts`.

eslint.config.mjs

@@ -10,6 +10,7 @@ export default [
   {
     rules: {
       "unicorn/no-array-for-each": "off",
+      "sonarjs/fixme-tag": "off",
     },
   },
 ];

instrumentation/BasicBlockAnalysis.hpp

@@ -15,14 +15,6 @@ namespace wasmInstrumentation {
 ///
 class BasicBlockAnalysis final {
 public:
-  ///
-  /// @brief Add include file to debug info analysis
-  ///
-  /// @param include
-  inline void addInclude(const std::string &&include) noexcept {
-    includes.emplace_back(include);
-  }
-
   ///
   /// @brief Add exclude file to debug info analysis
   ///

instrumentation/CoverageInstru.cpp

@@ -11,15 +11,6 @@ void CoverageInstru::innerAnalysis(BasicBlockAnalysis &basicBlockAnalysis) const
   Json::Reader jsonReader;
   Json::Value includesJsonValue;
   Json::Value excludesJsonValue;
-  if (!config->includes.empty()) {
-    jsonReader.parse(std::string(config->includes), includesJsonValue);
-    if (includesJsonValue.isArray()) {
-      const uint32_t includesJsonSize = includesJsonValue.size();
-      for (uint32_t i = 0U; i < includesJsonSize; ++i) {
-        basicBlockAnalysis.addInclude(includesJsonValue[i].asString());
-      }
-    }
-  }
   if (!config->excludes.empty()) {
     jsonReader.parse(std::string(config->excludes), excludesJsonValue);
     if (excludesJsonValue.isArray()) {
@@ -181,8 +172,8 @@ extern "C" EMSCRIPTEN_KEEPALIVE wasmInstrumentation::InstrumentationResponse
 wasm_instrument(char const *const fileName, char const *const targetName,
                 char const *const reportFunction, char const *const sourceMap,
                 char const *const expectInfoOutputFilePath,
-                char const *const debugInfoOutputFilePath, char const *const includes,
-                char const *const excludes, bool skipLib, bool collectCoverage) noexcept {
+                char const *const debugInfoOutputFilePath, char const *const excludes, bool skipLib,
+                bool collectCoverage) noexcept {
 
   wasmInstrumentation::InstrumentationConfig config;
   config.fileName = fileName;
@@ -191,7 +182,6 @@ wasm_instrument(char const *const fileName, char const *const targetName,
   config.sourceMap = sourceMap;
   config.expectInfoOutputFilePath = expectInfoOutputFilePath;
   config.debugInfoOutputFilePath = debugInfoOutputFilePath;
-  config.includes = includes;
   config.excludes = excludes;
   config.skipLib = skipLib;
   config.collectCoverage = collectCoverage;