From f002df98bb423dfba431619678f446b95f4e6c78 Mon Sep 17 00:00:00 2001 From: Jonathan Carter Date: Sat, 7 Mar 2020 12:01:44 -0800 Subject: [PATCH] Updating sample tours --- .vscode/tours/statusbar.json | 26 +++++++++++++++++++++++ .vscode/tours/tree.json | 41 ++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 .vscode/tours/statusbar.json create mode 100644 .vscode/tours/tree.json diff --git a/.vscode/tours/statusbar.json b/.vscode/tours/statusbar.json new file mode 100644 index 0000000..c33947b --- /dev/null +++ b/.vscode/tours/statusbar.json @@ -0,0 +1,26 @@ +{ + "title": "Status Bar", + "description": "Describes how we augment the status bar", + "steps": [ + { + "file": "src/extension.ts", + "line": 36, + "description": "The status bar provider is registered upon extension activiation" + }, + { + "file": "src/status.ts", + "line": 35, + "description": "If the currently opened workspace has any code tours, then we register the `Start Code Tour` status bar item." + }, + { + "file": "src/status.ts", + "line": 40, + "description": "Using MobX, we wait for the user to start and/or navigate a code tour." + }, + { + "file": "src/status.ts", + "line": 47, + "description": "When a tour is activate and/or navigated, we update the status bar item to indicate the current step and title." + } + ] +} diff --git a/.vscode/tours/tree.json b/.vscode/tours/tree.json new file mode 100644 index 0000000..ce644cc --- /dev/null +++ b/.vscode/tours/tree.json @@ -0,0 +1,41 @@ +{ + "title": "Tree View", + "description": "Describes how the Code Tours view works", + "steps": [ + { + "file": "src/extension.ts", + "line": 35, + "description": "Upon extension activation, we register the tree view provider" + }, + { + "file": "src/tree/index.ts", + "line": 50, + "description": "The tree is registered with the `codetour.tours` view ID, which is declared in the extension's `package.json` file." + }, + { + "file": "package.json", + "line": 112, + "description": "This view registration declares that the code tours tree view should be placed within the `Explorer` activity tab." + }, + { + "file": "src/tree/index.ts", + "line": 22, + "description": "Once created, the tree starts watching for changes to the store, so that it can update dyamically." + }, + { + "file": "src/tree/index.ts", + "line": 39, + "description": "The tree returns a list of nodes, one for each of the main and sub tours within the store." + }, + { + "file": "src/tree/nodes.ts", + "line": 12, + "description": "The nodes returned by the tree use the tour's title and description as it's display properties. Additionally, the node specifies the `codetour.startStart` command as its click-behavior." + }, + { + "file": "src/commands.ts", + "line": 22, + "description": "When a node is clicked in the tree view, it will pass the target tour and simply start it." + } + ] +}