feat: add wallaby gadges

renandelmonico · Mar 6, 2021 · ad6394c · ad6394c
1 parent c1596c4
commit ad6394c
Showing 1 changed file with 38 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -6,51 +6,55 @@ Run your PHPUnit tests in Node using the
 ![Screenshot](img/screenshot.png)
 
 ## Features
-* Shows a Test Explorer in the Test view in VS Code's sidebar with all detected tests and suites and their state
-* Adds CodeLenses to your test files for starting and debugging tests
-* Adds Gutter decorations to your test files showing the tests' state
-* Adds line decorations to the source line where a test failed
-* Shows a failed test's log when the test is selected in the explorer
-* Lets you choose test suites or individual tests in the explorer that should be run automatically after each file change
-* Forwards the console output from PHPUnit to a VS Code output channel
+
+-   Shows a Test Explorer in the Test view in VS Code's sidebar with all detected tests and suites and their state
+-   Adds CodeLenses to your test files for starting and debugging tests
+-   Adds Gutter decorations to your test files showing the tests' state
+-   Adds line decorations to the source line where a test failed
+-   Shows a failed test's log when the test is selected in the explorer
+-   Lets you choose test suites or individual tests in the explorer that should be run automatically after each file change
+-   Forwards the console output from PHPUnit to a VS Code output channel
 
 ## Getting started
-* Install the extension
-* Restart VS Code and open the Test view
-* Run your tests using the ![Run](img/run.png) icons in the Test Explorer or the CodeLenses in your test file
-* For running phpunit on a remote system or using vagrant see Troubleshooting
+
+-   Install the extension
+-   Restart VS Code and open the Test view
+-   Run your tests using the ![Run](img/run.png) icons in the Test Explorer or the CodeLenses in your test file
+-   For running phpunit on a remote system or using vagrant see Troubleshooting
 
 ## Configuration
 
 ### Custom debugger configuration
 
 ### Other options
 
-Property                           | Description
------------------------------------|---------------------------------------------------------------
-`testExplorer.codeLens`            | Show a CodeLens above each test or suite for running or debugging the tests
-`testExplorer.gutterDecoration`    | Show the state of each test in the editor using Gutter Decorations
-`testExplorer.onStart`             | Retire or reset all test states whenever a test run is started
-`testExplorer.onReload`            | Retire or reset all test states whenever the test tree is reloaded
+| Property                        | Description                                                                 |
+| ------------------------------- | --------------------------------------------------------------------------- |
+| `testExplorer.codeLens`         | Show a CodeLens above each test or suite for running or debugging the tests |
+| `testExplorer.gutterDecoration` | Show the state of each test in the editor using Gutter Decorations          |
+| `testExplorer.onStart`          | Retire or reset all test states whenever a test run is started              |
+| `testExplorer.onReload`         | Retire or reset all test states whenever the test tree is reloaded          |
 
 ## Commands
 
 The following commands are available in VS Code's command palette, use the ID to add them to your keyboard shortcuts:
 
-ID                                 | Command
------------------------------------|--------------------------------------------
-`test-explorer.reload`             | Reload tests
-`test-explorer.run-all`            | Run all tests
-`test-explorer.run-file`           | Run tests in current file
-`test-explorer.run-test-at-cursor` | Run the test at the current cursor position
-`test-explorer.cancel`             | Cancel running tests
+| ID                                 | Command                                     |
+| ---------------------------------- | ------------------------------------------- |
+| `test-explorer.reload`             | Reload tests                                |
+| `test-explorer.run-all`            | Run all tests                               |
+| `test-explorer.run-file`           | Run tests in current file                   |
+| `test-explorer.run-test-at-cursor` | Run the test at the current cursor position |
+| `test-explorer.cancel`             | Cancel running tests                        |
 
 ## Troubleshooting
 
 ### All tests are appearing twice with "\*** duplicate ID **\*" found.
+
 You likely have a file sensitive file system. The default value of `"phpunit.files": "{test,tests,Test,Tests}/**/*Test.php",` should be changed to `"phpunit.files": "{test,tests}/**/*Test.php",`
 
 ### I'm using Vagrant / Homestead for remote execution
+
 Your tests will list in the explorer for reading locally, but you need to run your tests remotely using PHP on your vagrant machine.
 
 To do this you need to configure the following settings:
@@ -64,4 +68,14 @@ To do this you need to configure the following settings:
 You can also use the method above to execute on Docker remotely
 
 ### My `/usr/local/bin/vagrant` isn't found?
+
 Spawn likely can't find vagrant locally. You need to switch to using your regular terminal using something like `"phpunit.shell": "/bin/bash",` or `"phpunit.shell": "/bin/zsh",`
+
+## Wallaby.js
+
+[![Wallaby.js](https://img.shields.io/badge/wallaby.js-powered-blue.svg?style=for-the-badge&logo=github)](https://wallabyjs.com/oss/)
+
+This repository contributors are welcome to use
+[Wallaby.js OSS License](https://wallabyjs.com/oss/) to get
+test results immediately as you type, and see the results in
+your editor right next to your code.