@tapjs/before-each - npm Package Compare versions

Comparing version 0.0.0-15 to 0.0.0-16

package.json

 {
   "name": "@tapjs/before-each",
-  "version": "0.0.0-15",
+  "version": "0.0.0-16",
   "description": "a built-in tap extension for t.beforeEach()",
@@ -46,3 +46,3 @@ "type": "module",
   "peerDependencies": {
-    "@tapjs/core": "0.0.0-15"
+    "@tapjs/core": "0.0.0-16"
   },
@@ -53,3 +53,3 @@ "dependencies": {
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+    "node": ">=16"
   },
@@ -56,0 +56,0 @@ "repository": {

README.md

 # `@tapjs/before-each`
 
-A default tap plugin providing `t.beforeEach()`
+A default tap plugin providing `t.beforeEach()`.
+
+## USAGE
+
+This plugin is installed with tap by default. If you had
+previously removed it, you can `tap plugin add @tapjs/before-each` to
+bring it back.
+
+```ts
+import t from 'tap'
+t.beforeEach((t) => {
+  // this will run before each child test, all of their child
+  // tests, and so on
+  // the parameter is the child test that is about to start.
+})
+```
+
+If the method returns a promise, it will be awaited before moving
+on to the next test.
+
+The `beforeEach` method is called for _all_ child tests, not just
+direct children. "Closer" ancestor `beforeEach` methods are called
+after further ancestors.
+
+For example, this test:
+
+```js
+import t from 'tap'
+t.beforeEach(t => {
+  console.error('root before each', t.name)
+})
+
+t.test('parent test', t => {
+  t.beforeEach(t => {
+    console.error('parent before each', t.name)
+  })
+  t.test('child test', t => t.end())
+  t.end()
+})
+```
+
+will print:
+
+```
+root before each parent test
+root before each child test
+parent before each child test
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18046

increased by5.62%

Number of lines in readme file

51

increased by1175%

No dependency changes