update docs

Author: XMadrid

assembly/implement.ts

@@ -9,8 +9,8 @@ export function describeImpl(
   testsFunction();
   assertResult.removeDescription();
 }
-export function testImpl(description: string, testFunction: () => void): void {
-  assertResult.addDescription(description);
+export function testImpl(name: string, testFunction: () => void): void {
+  assertResult.addDescription(name);
   assertResult.registerTestFunction(testFunction.index);
   assertResult.removeDescription();
 }

assembly/index.ts

@@ -20,11 +20,11 @@ export function describe(description: string, testsFunction: () => void): void {
 
 /**
  *  run a test
- * @param description test description
+ * @param name test name
  * @param testFunction main function of test
  */
-export function test(description: string, testFunction: () => void): void {
-  testImpl(description, testFunction);
+export function test(name: string, testFunction: () => void): void {
+  testImpl(name, testFunction);
 }
 
 /**

bin/cli.js

@@ -12,11 +12,11 @@ import { validatArgument, start_unit_test } from "../dist/index.js";
 const program = new Command();
 program
   .option("--config <config file>", "path of config file", "as-test.config.js")
-  .option("--testcase <testcases...>", "run only specified test cases")
   .option("--temp <path>", "test template file folder")
   .option("--output <path>", "coverage report output folder")
   .option("--mode <output mode>", "coverage report output format")
   .option("--coverageLimit [error warning...]", "set warn(yellow) and error(red) upper limit in coverage report")
+  .option("--testcase <testcases...>", "run only specified test cases")
   .option("--testNamePattern <test name pattern>", "run only tests with a name that matches the regex pattern")
   .option("--collectCoverage <boolean>", "whether to collect coverage information and report");
 

docs/api-documents.md

@@ -2,4 +2,4 @@ A comprehensive AssemblyScript testing solution, offering developers a robust su
 
 - Function Mocking
 - Coverage statistics
-- Expectations
+- Matchers

docs/api-documents/mock-function.md

@@ -31,7 +31,6 @@ test("getTime error handle", () => {
   expect(getTime()).equal(false); // success
   expect(fn.calls).equal(1);      // success
 });
-endTest();
 ```
 
 mock API can temporary change the behavior of function, effective scope is each test.

docs/api-documents/options.md

@@ -33,7 +33,7 @@ There are several ways to run partial test cases:
 
 #### Partial Test Files
 
-Providing file path to `--testcase`. it can specify a certain group of files for testing.
+Providing file path to `--testcase`, it can specify a certain group of files for testing.
 
 ::: tip
 `--testcase` can accept multiple file paths.
@@ -57,20 +57,49 @@ run `as-test --testcase a.test.ts b.test.ts` will match all tests in `a.test.ts`
 
 #### Partial Tests
 
-Providing regex which can match targeted test name to `--testNamePattern`. it can specify a certain group of tests for testing.
+Providing regex which can match targeted test name to `--testNamePattern`, it can specify a certain group of tests for testing.
 
 ::: details
 
 ```
-- a.test.ts
-|- case_1
-|- case_2
-- b.test.ts
-|- case_A
-- c.test.ts
-|- case_4
+describe("groupA", () => {
+  test("case_1", () => {
+    ...
+  });
+  test("case_2", () => {
+    ...
+  });
+  test("case_3", () => {
+    ...
+  });
+});
+
+describe("groupB", () => {
+  test("case_A", () => {
+    ...
+  });
+  test("case_B", () => {
+    ...
+  });
+  test("case_C", () => {
+    ...
+  });
+});
 ```
 
-run `as-test --testNamePattern "case_\d"` will match `case 1`, `case 2`, `case 4`
+run `as-test --testNamePattern "groupA case_\d"` will run `case_1`, `case_2`, `case_3`. 
+
+::: tip
+The framework join `DescriptionName` and `TestName` with `" "` by default, e.g. `groupA case_1` is the fullTestCaseName of `case_1`.
 
 :::
+
+### Whether collect coverage information
+
+```
+  --collectCoverage <boolean>            whether to collect coverage information and report
+```
+
+The framework collects coverage and generates reports by default, but it will be disablea while running partial test cases by `--testcase` or `--testNamePattern`.
+
+You can control the coverage collection manually with `--collectCoverage` option.

docs/quick-start.md

@@ -19,14 +19,13 @@ export function add(a: i32, b: i32): i32 {
 Then, create a file named `tests/sum.test.ts`. This will contain our actual test:
 
 ```Typescript
-import { test, expect, endTest } from "assemblyscript-unittest-framework/assembly";
+import { test, expect } from "assemblyscript-unittest-framework/assembly";
 import { add } from "../source/sum";
 
 test("sum", () => {
   expect(add(1, 2)).equal(3);
   expect(add(1, 1)).equal(3);
 });
-endTest();  // Don't forget it!
 ```
 
 Create a config file in project root `as-test.config.js`:
@@ -60,16 +59,29 @@ Add the following section to your `package.json`
 Finally, run `npm run test` and as-test will print this message:
 
 ```
-transform source/sum.ts => build/source/sum.ts.cov
-transform build/source/sum.ts.cov => build/source/sum.ts
-transform tests/sum.test.ts => build/tests/sum.test.ts
-(node:489815) ExperimentalWarning: WASI is an experimental feature. This feature could change at any time
+> [email protected] test
+> as-test
+
+(node:144985) ExperimentalWarning: WASI is an experimental feature and might change at any time
+(Use `node --trace-warnings ...` to show where the warning was created)
+code analysis: OK
+compile testcases: OK
+instrument: OK
+execute testcases: OK
 
 test case: 1/2 (success/total)
 
-Error Message:
-        sum:
-                tests/sum.test.ts:6:3 (6:3, 6:29)
+Error Message: 
+  sum: 
+    tests/sum.test.ts:6:2  value: 2  expect: = 3
+---------|---------|----------|---------|--------
+File     | % Stmts | % Branch | % Funcs | % Lines
+---------|---------|----------|---------|--------
+source   | 100     | 100      | 100     | 100    
+  sum.ts | 100     | 100      | 100     | 100    
+---------|---------|----------|---------|--------
+
+Test Failed
 ```
 
 You can also use `npx as-test -h` for more information to control detail configurations

tests/as/comparison.test.ts

@@ -1,4 +1,4 @@
-import { describe, endTest, expect, test } from "../../assembly";
+import { describe, expect, test } from "../../assembly";
 
 describe("base type equal", () => {
   test("i32", () => {
@@ -177,7 +177,6 @@ describe("single level container type equal", () => {
     });
     test("nullable equal normal", () => {});
   });
-  // end test
 });
 
 describe("mutli-level container type equal", () => {
@@ -209,5 +208,3 @@ describe("mutli-level container type equal", () => {
     expect(arr).equal(arr2);
   });
 });
-
-endTest();

tests/as/expect.test.ts

@@ -1,4 +1,4 @@
-import { describe, endTest, expect, test } from "../../assembly";
+import { describe, expect, test } from "../../assembly";
 
 describe("expect", () => {
   test("< = >", () => {
@@ -14,5 +14,3 @@ describe("expect", () => {
     expect<string | null>("test").notNull();
   });
 });
-
-endTest();

tests/as/format.test.ts

@@ -1,4 +1,4 @@
-import { describe, endTest, expect, test } from "../../assembly";
+import { describe, expect, test } from "../../assembly";
 import { toJson } from "../../assembly/formatPrint";
 
 class A {}
@@ -57,5 +57,3 @@ describe("print", () => {
     expect(toJson(new A())).equal("[Object A]");
   });
 });
-
-endTest();