Add Testing user guide outline #7310
Conversation
|
@isidorn I created an outline for the Testing user guide. I'll continue to further complete the doc. Welcome your feedback. |
|
Sorry for the slow response. I just checked this out and I like this outline! And I suggest to share with Connor when possible to also get his feedback. |
@isidorn I plan to have the high-level getting started experience as part of the intro. The actual details are extension/language specific. If this information becomes too long, I might move it into a separate section. I'll start adding some more details, and will also include Connor in the next review cycle. |
|
Sounds good. Thank you very much 🙏 |
|
@connor4312 I've started working on a user guide about Testing. Appreciate your perspectives on the current article - it's about 80% ready. Is the outline and structure ok, are there things missing or incorrect? Thanks! |
docs/editor/testing.md
Outdated
|
|
||
| The Test Explorer view provides a centralized place to manage and run your tests. You can access the Test Explorer view by selecting the beaker icon in the Activity Bar or by using the **Testing: Focus on Test Explorer View** command in the Command Palette (`kb(workbench.action.showCommands)`). | ||
|
|
||
| If you have a project with tests, the Test Explorer view automatically discovers and lists the tests in your workspace. By default, the discovered tests are displayed in a tree view in the Test Explorer. The tree view matches the hierarchical structure of your tests, making it easy to navigate and run your tests. |
There was a problem hiding this comment.
There's also a little bit of "it depends" here, for example the Python extension requires users to run a configure command before it shows tests. (A button to do so is shown in the welcome view if there are no tests in the workspace yet.) The user might need to consult the readme of their extension to set up tests.
There was a problem hiding this comment.
Added a note at the end of this section.
|
|
||
| ## Task integration | ||
|
|
||
| Tasks in VS Code can be configured to run scripts and start processes within VS Code, without having to enter a command line or write new code. In VS Code, you can define a default test task that runs your tests, and optionally create keyboard shortcuts to run the tests. |
There was a problem hiding this comment.
Currently tasks don't have special integration into VS Code's testing functionality, so running tests in a task won't update VS Code's UI.
There was a problem hiding this comment.
Included this in the note that extension can implement integrated test automation features.
Fixes #7208