Replacing Documentation with Automation¶
You can document how to set up your dev machine with the right version of the framework required to run the code, which extensions are useful to develop the application with your editor, or how to configure your editor to launch and debug the application. If it is possible, a better solution is to provide the means to automate tool installs, application startup, etc., instead.
Some examples are provided below:
Dev containers in Visual Studio Code¶
The Visual Studio Code Remote - Containers extension lets you use a Docker container as a full-featured development environment. It allows you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set.
Additional information: Developing inside a Container.
Launch configurations and Tasks in Visual Studio Code¶
Launch configurations allows you to configure and save debugging setup details.
Tasks can be configured to run scripts and start processes so that many of these existing tools can be used from within VS Code without having to enter a command line or write new code.