From e1493bc6753eb6175937fa756a119be095a12570 Mon Sep 17 00:00:00 2001 From: Gerard Roche Date: Mon, 14 Aug 2023 14:09:16 +0100 Subject: [PATCH] doc: update --- CHANGELOG.md | 10 +++++----- README.md | 42 ++++++++++++++++++++++-------------------- 2 files changed, 27 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6d66c3..5cadcb0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,16 +29,16 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * [#121](https://github.com/gerardroche/sublime-phpunit/issues/121): Run tests from the side bar menu * [#122](https://github.com/gerardroche/sublime-phpunit/issues/122): Run tests from the context menu -### Removed +### Deprecated -* Removed on post save "run_test_file" event, use on post save "phpunit_test_file" event instead. +* The deprecated on-post-save "run_test_file" event, use on-post-save "phpunit_test_file" event instead. ## 3.16.0 - 2023-08-02 ### Added -* [#99](https://github.com/gerardroche/sublime-phpunit/issues/99): New support for running tests via Docker (beta) -* [#118](https://github.com/gerardroche/sublime-phpunit/issues/118): New support for running tests on a remote server via SSH (beta) +* [#99](https://github.com/gerardroche/sublime-phpunit/issues/99): New support for running tests via Docker +* [#118](https://github.com/gerardroche/sublime-phpunit/issues/118): New support for running tests on a remote server via SSH * [#120](https://github.com/gerardroche/sublime-phpunit/issues/120): New strategy: `xterm` - Sends test commands to xterm terminal. * New Command: Changelog @@ -136,7 +136,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt ### Fixed * [#113](https://github.com/gerardroche/sublime-phpunit/issues/113): Color is missing in strategies like Kitty for Artisan and Pest test runners -* [#112](https://github.com/gerardroche/sublime-phpunit/issues/112): Don't show build panel when using stategies like Kitty +* [#112](https://github.com/gerardroche/sublime-phpunit/issues/112): Don't show build panel when using strategies like Kitty ## 3.11.2 - 2023-04-15 diff --git a/README.md b/README.md index 5fc56cc..35db809 100644 --- a/README.md +++ b/README.md @@ -122,20 +122,22 @@ To add your preferred key bindings, follow these steps: ## Commands -| Command | Description -| :-------------------------------------------------------------| :---------- -| **PHPUnit: Test Nearest** | Run a test nearest to the cursor. If the current file is not a test file, it runs the tests for current file. -| **PHPUnit: Test File** | Run tests for the current file. -| **PHPUnit: Test Suite** | Run test suite of the current file. -| **PHPUnit: Test Last** | Runs the last test. -| **PHPUnit: Test Switch** | In a test file opens the file under test, otherwise opens the test file. -| **PHPUnit: Test Visit** | Open the last run test. -| **PHPUnit: Test Results** | Opens the test output panel (only applies to "basic" strategy). -| **PHPUnit: Test Cancel** | Cancel any currently running tests. -| **PHPUnit: Test Coverage** | Opens the code coverage in a browser. -| **PHPUnit: Toggle Run Test On Save** | Toggle to quickly turn the Test File auto-command on and off. -| **PHPUnit: Toggle...** | Toggle options e.g. PHPUnit CLI options. -| **Preferences: PHPUnit Settings** | Edit settings. +| Command | Description +| :----------------------------------------------- | :---------- +| **PHPUnit: Test Nearest** | Execute the test closest to the cursor. If the current file isn't a designated test file, it runs tests for the current file. +| **PHPUnit: Test File** | Run tests for the currently open file. If it's not a test file, it runs tests for the current file. +| **PHPUnit: Test Suite** | Run the test suite associated with the current file. +| **PHPUnit: Test Last** | Run the most recently executed test. +| **PHPUnit: Test Switch** | In a test file, open the file under test; otherwise, open the corresponding test file. +| **PHPUnit: Test Visit** | Quickly access the last run test. +| **PHPUnit: Test Results** | Open the test output panel (applies to "sublime" strategy). +| **PHPUnit: Test Cancel** | Halt any ongoing test executions. +| **PHPUnit: Test Coverage** | View code coverage using your default browser. +| **PHPUnit: Toggle Run Test On Save** | Toggle the Test File auto-command on/off. +| **PHPUnit: Toggle...** | Toggle options such as PHPUnit CLI settings. +| **Preferences: PHPUnit Settings** | Open the settings editor. + +Enhance your testing workflow with these commands for efficient testing directly from Sublime Text. ## Key Bindings @@ -192,18 +194,18 @@ Command Palette → Preferences: PHPUnit Settings | Setting | Type | Default | Description | :-------------------- | :------------ | :-------- | :---------- | `phpunit.ssh` | `boolean` | `false` | Enable SSH. -| `phpunit.ssh_options` | `dict` | `{}` | The options to use when running tests via SSH.
Example: `{"-p": "22", "-tt": true}`. -| `phpunit.ssh_user` | `string` | `null` | The user to use when running tests via SSH.
Example: vagrant -| `phpunit.ssh_host` | `string` | `null` | The host to use when running tests via SSH.
Example: homestead.test -| `phpunit.ssh_paths` | `dict` | `{}` | The path map to use when running tests via SSH. The keys are local paths and the values are the replacement remote paths. Environment variables and user home directory ~ placeholder are expanded. Example: `{"~/code/project1": "~/project1"}` +| `phpunit.ssh_options` | `dict` | `{}` | Options for running tests via SSH.
Example: `{"-p": "22", "-tt": true}`. +| `phpunit.ssh_user` | `string` | `null` | User for running tests via SSH.
Example: vagrant +| `phpunit.ssh_host` | `string` | `null` | Host for running tests via SSH.
Example: homestead.test +| `phpunit.ssh_paths` | `dict` | `{}` | Path map for running tests via SSH. Keys: local paths, Values: replacement remote paths. Environment variables and user home directory ~ placeholder are expanded. Example: `{"~/code/project1": "~/project1"}` **Docker settings** :rocket: | Setting | Type | Default | Description | :-------------------- | :------------ | :-------- | :---------- | `phpunit.docker` | `boolean` | `false` | Enable Docker. -| `phpunit.docker_command` | `list` | `[]` | The command to use when running tests via Docker. Example: `["docker", "exec", "-it", "my-container"]` -| `phpunit.docker_paths` | `dict` | `{}` | The path map to use when running tests via Docker. The keys are local paths and the values are the replacement remote paths. Environment variables and user home directory ~ placeholder are expanded. Example: `{"~/code/project1": "~/project1"}` +| `phpunit.docker_command` | `list` | `[]` | Command to use when running tests via Docker. Example: `["docker", "exec", "-it", "my-container"]` +| `phpunit.docker_paths` | `dict` | `{}` | Path map for running tests via Docker. Keys: local paths, Values: replacement remote paths. Environment variables and user home directory ~ placeholder are expanded. Example: `{"~/code/project1": "~/project1"}` ### CLI Options