microsoft / codetour

VS Code extension that allows you to record and play back guided tours of codebases, directly within the editor.

Home Page:https://aka.ms/codetour

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature Request: Enabling multiple workspace structures via configuration

lechnerc77 opened this issue · comments

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.

  • One repository with different subfolders/subprojects that I would like to create CodeTours for. I can do that in the repository and the Tour will work in this setup
  • Due to the complexity of the project I would like to define VSCode workspaces for the different subprojects combining the folders that belong together in a different style. This changes the root of the workspace and the CodeTour File won't work as the workspace root is now a different one.
  • Now bringing dev containers in, I get a different root of the workspace due to a different mount of the directories in my container. Also in this case the CodeTours won't work,

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.