@japa/run-failed-tests - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@japa/run-failed-tests",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Run only failed japa tests",
@@ -59,3 +59,3 @@ "main": "build/index.js",
     "services": [
-      "circleci"
+      "github-actions"
     ],
@@ -66,3 +66,4 @@ "minNodeVersion": "16.13.1",
       "lock"
-    ]
+    ],
+    "runGhActionsOnWindows": true
   },
@@ -69,0 +70,0 @@ "eslintConfig": {

README.md

 # @japa/run-failed-tests
-> Tagline
+> Japa plugin to run only failed tests
 
-[![circleci-image]][circleci-url] [![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
+[![github-actions-image]][github-actions-url] [![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
 
-A short brief
+The `@japa/run-failed-tests` plugin runs only the failed tests on subsequent runs.
 
-## Installation
+Here's how it works under the hood.
 
-## Usage
+- You ran the tests suite, and a couple of tests failed.
+- On the next run, only the failed test will run.
+- If all tests are green, the next run will execute all the tests.
 
-[circleci-image]: https://img.shields.io/circleci/project/github/japa/run-failed-tests/master.svg?style=for-the-badge&logo=circleci
-[circleci-url]: https://circleci.com/gh/japa/run-failed-tests "circleci"
+```sh
+npm i @japa/run-failed-tests 
+```
 
+```ts
+import { runFailedTests } from '@japa/run-failed-tests'
+
+configure({
+  plugins: [runFailedTests()]
+})
+```
+
+[github-actions-image]: https://img.shields.io/github/workflow/status/japa/run-failed-tests/test?style=for-the-badge
+[github-actions-url]: https://github.com/japa/run-failed-tests/actions/workflows/test.yml "github-actions"
+
 [npm-image]: https://img.shields.io/npm/v/@japa/run-failed-tests.svg?style=for-the-badge&logo=npm
@@ -16,0 +30,0 @@ [npm-url]: https://npmjs.org/package/@japa/run-failed-tests "npm"

No alert changes

Improved metrics

Total package byte prevSize

8077

increased by6.73%

Number of lines in readme file

37

increased by60.87%

No dependency changes