@tapjs/test - npm Package Compare versions

Comparing version 0.0.0-12 to 0.0.0-13

package.json

 {
   "name": "@tapjs/test",
-  "version": "0.0.0-12",
+  "version": "0.0.0-13",
   "description": "the pluggable Test class for node-tap",
@@ -44,3 +44,3 @@ "author": "Isaac Z. Schlueter <[e-mail]> (https://blog.izs.me)",
   "peerDependencies": {
-    "@tapjs/core": "0.0.0-12"
+    "@tapjs/core": "0.0.0-13"
   },
@@ -50,3 +50,3 @@ "dependencies": {
     "glob": "^10.3.3",
-    "jackspeak": "^2.2.3",
+    "jackspeak": "2.3",
     "mkdirp": "^3.0.0",
@@ -53,0 +53,0 @@ "sync-content": "^1.0.1",

scripts/test-template.ts

@@ -307,3 +307,18 @@ //{{HEADER COMMENT START}}
 > extends TTest {
+  /**
+   * Explicitly mark the test as completed, outputting the TAP plan line if
+   * needed.
+   *
+   * This is not required to be called if the test function returns a promise,
+   * or if a plan is explicitly declared and eventually fulfilled.
+   *
+   * @group Test Lifecycle Management
+   */
   end(): this
+  /**
+   * Specify the number of Test Points expected by this test.
+   * Outputs a TAP plan line.
+   *
+   * @group Test Lifecycle Management
+   */
   plan(n: number, comment?: string): void
@@ -373,2 +388,4 @@ }
    * to the entire test suite, so that it can be built up front.
+   *
+   * @group Plugin Management
    */
@@ -421,2 +438,4 @@ applyPlugin<B extends Object, O extends unknown = unknown>(
    * test object in question implements the return value of the plugin.
+   *
+   * @group Plugin Management
    */
@@ -431,2 +450,4 @@ pluginLoaded<T extends any = any>(
    * Return the set of plugins loaded by this Test
+   *
+   * @group Plugin Management
    */
@@ -438,3 +459,5 @@ get plugins(): TapPlugin<any, Opts>[] {
   /**
-   * Create a subtest
+   * Create a child Test object and parse its output as a subtest
+   *
+   * @group Subtest Methods
    */
@@ -470,2 +493,4 @@ test(
    * Create a subtest which is marked as `todo`
+   *
+   * @group Subtest Methods
    */
@@ -502,2 +527,4 @@ todo(
    * Create a subtest which is marked as `skip`
+   *
+   * @group Subtest Methods
    */
@@ -504,0 +531,0 @@ skip(

test-built/dist/cjs/index.d.ts

@@ -192,3 +192,18 @@ import { PromiseWithSubtest, TapPlugin, TestBase, TestBaseOpts } from '@tapjs/core';
 export interface Test<Ext extends BuiltPlugins = BuiltPlugins, Opts extends TestOpts = TestOpts> extends TTest {
+    /**
+     * Explicitly mark the test as completed, outputting the TAP plan line if
+     * needed.
+     *
+     * This is not required to be called if the test function returns a promise,
+     * or if a plan is explicitly declared and eventually fulfilled.
+     *
+     * @group Test Lifecycle Management
+     */
     end(): this;
+    /**
+     * Specify the number of Test Points expected by this test.
+     * Outputs a TAP plan line.
+     *
+     * @group Test Lifecycle Management
+     */
     plan(n: number, comment?: string): void;
@@ -232,2 +247,4 @@ }
      * to the entire test suite, so that it can be built up front.
+     *
+     * @group Plugin Management
      */
@@ -238,2 +255,4 @@ applyPlugin<B extends Object, O extends unknown = unknown>(plugin: TapPlugin<B, O>): Test<Ext & B, Opts & O> & Ext & B;
      * test object in question implements the return value of the plugin.
+     *
+     * @group Plugin Management
      */
@@ -243,6 +262,10 @@ pluginLoaded<T extends any = any>(plugin: (t: any, opts?: any) => T): this is TestBase & T;
      * Return the set of plugins loaded by this Test
+     *
+     * @group Plugin Management
      */
     get plugins(): TapPlugin<any, Opts>[];
     /**
-     * Create a subtest
+     * Create a child Test object and parse its output as a subtest
+     *
+     * @group Subtest Methods
      */
@@ -255,2 +278,4 @@ test(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;
      * Create a subtest which is marked as `todo`
+     *
+     * @group Subtest Methods
      */
@@ -263,2 +288,4 @@ todo(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;
      * Create a subtest which is marked as `skip`
+     *
+     * @group Subtest Methods
      */
@@ -265,0 +292,0 @@ skip(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;

test-built/dist/cjs/index.js

@@ -341,2 +341,4 @@ "use strict";
      * to the entire test suite, so that it can be built up front.
+     *
+     * @group Plugin Management
      */
@@ -375,2 +377,4 @@ applyPlugin(plugin) {
      * test object in question implements the return value of the plugin.
+     *
+     * @group Plugin Management
      */
@@ -383,2 +387,4 @@ pluginLoaded(plugin) {
      * Return the set of plugins loaded by this Test
+     *
+     * @group Plugin Management
      */
@@ -385,0 +391,0 @@ get plugins() {

test-built/dist/mjs/index.d.ts

@@ -192,3 +192,18 @@ import { PromiseWithSubtest, TapPlugin, TestBase, TestBaseOpts } from '@tapjs/core';
 export interface Test<Ext extends BuiltPlugins = BuiltPlugins, Opts extends TestOpts = TestOpts> extends TTest {
+    /**
+     * Explicitly mark the test as completed, outputting the TAP plan line if
+     * needed.
+     *
+     * This is not required to be called if the test function returns a promise,
+     * or if a plan is explicitly declared and eventually fulfilled.
+     *
+     * @group Test Lifecycle Management
+     */
     end(): this;
+    /**
+     * Specify the number of Test Points expected by this test.
+     * Outputs a TAP plan line.
+     *
+     * @group Test Lifecycle Management
+     */
     plan(n: number, comment?: string): void;
@@ -232,2 +247,4 @@ }
      * to the entire test suite, so that it can be built up front.
+     *
+     * @group Plugin Management
      */
@@ -238,2 +255,4 @@ applyPlugin<B extends Object, O extends unknown = unknown>(plugin: TapPlugin<B, O>): Test<Ext & B, Opts & O> & Ext & B;
      * test object in question implements the return value of the plugin.
+     *
+     * @group Plugin Management
      */
@@ -243,6 +262,10 @@ pluginLoaded<T extends any = any>(plugin: (t: any, opts?: any) => T): this is TestBase & T;
      * Return the set of plugins loaded by this Test
+     *
+     * @group Plugin Management
      */
     get plugins(): TapPlugin<any, Opts>[];
     /**
-     * Create a subtest
+     * Create a child Test object and parse its output as a subtest
+     *
+     * @group Subtest Methods
      */
@@ -255,2 +278,4 @@ test(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;
      * Create a subtest which is marked as `todo`
+     *
+     * @group Subtest Methods
      */
@@ -263,2 +288,4 @@ todo(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;
      * Create a subtest which is marked as `skip`
+     *
+     * @group Subtest Methods
      */
@@ -265,0 +292,0 @@ skip(name: string, extra: Opts, cb: (t: Test<Ext, Opts> & Ext) => any): PromiseWithSubtest<Test<Ext, Opts> & Ext>;

test-built/dist/mjs/index.js

@@ -314,2 +314,4 @@ //{{HEADER COMMENT START}}
      * to the entire test suite, so that it can be built up front.
+     *
+     * @group Plugin Management
      */
@@ -348,2 +350,4 @@ applyPlugin(plugin) {
      * test object in question implements the return value of the plugin.
+     *
+     * @group Plugin Management
      */
@@ -356,2 +360,4 @@ pluginLoaded(plugin) {
      * Return the set of plugins loaded by this Test
+     *
+     * @group Plugin Management
      */
@@ -358,0 +364,0 @@ get plugins() {

test-built/src/index.ts

@@ -421,3 +421,18 @@ //{{HEADER COMMENT START}}
 > extends TTest {
+  /**
+   * Explicitly mark the test as completed, outputting the TAP plan line if
+   * needed.
+   *
+   * This is not required to be called if the test function returns a promise,
+   * or if a plan is explicitly declared and eventually fulfilled.
+   *
+   * @group Test Lifecycle Management
+   */
   end(): this
+  /**
+   * Specify the number of Test Points expected by this test.
+   * Outputs a TAP plan line.
+   *
+   * @group Test Lifecycle Management
+   */
   plan(n: number, comment?: string): void
@@ -487,2 +502,4 @@ }
    * to the entire test suite, so that it can be built up front.
+   *
+   * @group Plugin Management
    */
@@ -535,2 +552,4 @@ applyPlugin<B extends Object, O extends unknown = unknown>(
    * test object in question implements the return value of the plugin.
+   *
+   * @group Plugin Management
    */
@@ -545,2 +564,4 @@ pluginLoaded<T extends any = any>(
    * Return the set of plugins loaded by this Test
+   *
+   * @group Plugin Management
    */
@@ -552,3 +573,5 @@ get plugins(): TapPlugin<any, Opts>[] {
   /**
-   * Create a subtest
+   * Create a child Test object and parse its output as a subtest
+   *
+   * @group Subtest Methods
    */
@@ -584,2 +607,4 @@ test(
    * Create a subtest which is marked as `todo`
+   *
+   * @group Subtest Methods
    */
@@ -616,2 +641,4 @@ todo(
    * Create a subtest which is marked as `skip`
+   *
+   * @group Subtest Methods
    */
@@ -618,0 +645,0 @@ skip(

No alert changes

Improved metrics

Total package byte prevSize

182013

2.61%

Lines of code

2721

4.61%

Dependency changes

• + Added

  @tapjs/core@0.0.0-13
  (transitive)

• - Removed

  @tapjs/core@0.0.0-12
  (transitive)

• Updated

  jackspeak@2.3