fix: proper handling of situations where AS files are not invalid

Author: HerrCai0907

bin/cli.js

@@ -32,14 +32,14 @@ const configPath = resolve(".", options.config);
 if (!fs.pathExistsSync(configPath)) {
   console.error(chalk.redBright("Miss config file") + "\n");
   console.error(program.helpInformation());
-  exit(-1);
+  exit(3);
 }
 const config = (await import(pathToFileURL(configPath))).default;
 
 const includes = config.include;
 if (includes === undefined) {
   console.error(chalk.redBright("Miss include in config file") + "\n");
-  exit(-1);
+  exit(3);
 }
 const excludes = config.exclude || [];
 validateArgument(includes, excludes);
@@ -83,7 +83,7 @@ start_unit_test(testOption)
   .then((success) => {
     if (!success) {
       console.error(chalk.redBright("Test Failed") + "\n");
-      exit(255);
+      exit(1);
     }
   })
   .catch((e) => {

docs/.vitepress/config.ts

@@ -34,6 +34,7 @@ export default defineConfig({
               { text: "Matchers", link: "/api-documents/matchers" },
               { text: "Mock Function", link: "/api-documents/mock-function" },
               { text: "Report", link: "/api-documents/coverage-report" },
+              { text: "Return Code", link: "/api-documents/return-code.md" },
             ],
           },
           {

docs/api-documents/return-code.md

@@ -0,0 +1,7 @@
+## Return Code
+
+The platform indicates different error situations by returning different exit codes.
+
+- exit code 1 indicates a test failure.
+- exit code 2 indicates that the input AS file cannot be compiled.
+- exit code 3 or higher indicates an error in the configuration file.

docs/release-note.md

@@ -1,5 +1,19 @@
 # Release Note
 
+## 1.3.1
+
+🚀 Highlight Features
+
+- Defined the meanings of the return values in different situations.
+  - `0` means success.
+  - `1` means test failed.
+  - `2` means invalid AS file.
+  - `>2` means configuration error.
+
+🚀 Improvements
+
+- Proper handling of situations where AS files are not invalid.
+
 ## 1.3.0
 
 🚀 Highlight Features
@@ -13,7 +27,7 @@
   - Expose the framework's `log` function in the configuration file, and the logs redirected to this function will be appended to the final test report.
   - Support test crashes and provide good call stack information.
 
-Improvements
+🚀 Improvements
 
 - Code coverage calculation.
   - Skip type definitions.

src/core/compile.ts

@@ -28,8 +28,8 @@ export async function compile(testCodePaths: string[], outputFolder: string, com
     const { error, stderr } = await main(ascArgv);
     if (error) {
       // eslint-disable-next-line @typescript-eslint/no-base-to-string
-      console.error(stderr.toString());
-      throw error;
+      console.log(stderr.toString());
+      process.exit(2);
     }
   };
 

src/core/precompile.ts

@@ -94,8 +94,8 @@ async function transform(transformFunction: string, codePath: string, flags: str
   const { error, stderr } = await main(ascArgv);
   if (error) {
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    console.error(stderr.toString());
-    throw error;
+    console.log(stderr.toString());
+    process.exit(2);
   }
   collectCallback();
 }

tests/e2e/compilationFailed/as-test.config.js

@@ -0,0 +1,19 @@
+import path from "node:path";
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+
+export default {
+  include: [__dirname],
+  imports(runtime) {
+    return {
+      env: {
+        log: (msg) => {
+          runtime.framework.log(runtime.exports.__getString(msg));
+        },
+      },
+    };
+  },
+  temp: path.join(__dirname, "tmp"),
+  output: path.join(__dirname, "tmp"),
+  mode: [],
+};

tests/e2e/compilationFailed/incorrect.test.ts

@@ -0,0 +1,5 @@
+import { test, expect } from "../../../assembly";
+
+test("assert on test", () => {
+  f = 1;
+});

tests/e2e/compilationFailed/stdout.txt

@@ -0,0 +1,9 @@
+code analysis: OK
+ERROR TS2304: Cannot find name 'f'.
+   :
+ 4 │ f = 1;
+   │ ~
+   └─ in tests/e2e/compilationFailed/incorrect.test.ts(4,3)
+
+FAILURE 1 compile error(s)
+

tests/e2e/compilationFailed/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "assemblyscript/std/assembly.json",
+  "include": [
+    "./**/*.ts"
+  ]
+}