microsoft / codetour

VS Code extension that allows you to record and play back guided tours of codebases, directly within the editor.
https://aka.ms/codetour
MIT License
4.34k stars 109 forks source link

Feature Request: Enabling multiple workspace structures via configuration #229

Open lechnerc77 opened 2 years ago

lechnerc77 commented 2 years ago

This is a feature request for enabling more flexibility concerning the configuration of the workspace root.

In the current implementation the workspace root is "hard-coded" in the tours file. The steps navigate to the location in the source code based on the relative path defined in the .tour file combined with the information of the workspace root file. There are situations where this needs more flexibility e.g.

You find an example for this problem in the GitHub repository: https://github.com/lechnerc77/azure-functions-university/tree/dev-container (be aware of the branch): The Code Tours work if opened in one of the workspaces, but will not work in e.g. the dev container defined in https://github.com/lechnerc77/azure-functions-university/tree/dev-container/src/typescript/durable-functions/advanced-patterns/.devcontainer

The current solution (at least to the best of my knowledge) would be three different CodeTours mathcing the workspace structure although the code per se and the directory structure remains the same.

My feature request therefore is to enable an explicit configuration of the workspace to give the degree of flexibility to record a CodeTour once and if necessary adjust the configuration of the workspace root.