8000 Merge pull request #35 from ShMcK/fix/workspace-root-deprecation · dashinja/coderoad-vscode@a3c0fb0 · GitHub
[go: up one dir, main page]
Skip to content

Commit a3c0fb0

Browse files
ShMcKShMcK
authored
Merge pull request coderoad#35 from ShMcK/fix/workspace-root-deprecation
fix workspaceRoot deprecation warnings
2 parents 74159d5 + 0d6b5b5 commit a3c0fb0

File tree

8 files changed

+32
-87
lines changed

8 files changed

+32
-87
lines changed

‎src/actions/setupActions.ts

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ const runCommands = async (commands: string[], language: string) => {
3636
}
3737

3838

39-
const setupActions = async ({commands, commits, files}: G.StepActions): Promise<void> => {
39+
const setupActions = async (workspaceRoot: vscode.WorkspaceFolder, {commands, commits, files}: G.StepActions): Promise<void> => {
4040
// run commits
4141
for (const commit of commits) {
4242
await git.loadCommit(commit)
@@ -49,18 +49,7 @@ const setupActions = async ({commands, commits, files}: G.StepActions): Promise<
4949
for (const filePath of files) {
5050
console.log(`OPEN_FILE ${filePath}`)
5151
try {
52-
// TODO: re-enable after testing
53-
// const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
54-
// if (!workspaceRoots || !workspaceRoots.length) {
55-
// throw new Error('No workspace root path')
56-
// }
57-
// const rootWorkspace: vscode.WorkspaceFolder = workspaceRoots[0]
58-
// const absoluteFilePath = join(rootWorkspace.uri.path, relativeFilePath)
59-
const workspaceRoot = vscode.workspace.rootPath
60-
if (!workspaceRoot) {
61-
throw new Error('No workspace root path')
62-
}
63-
const absoluteFilePath = join(workspaceRoot, filePath)
52+
const absoluteFilePath = join(workspaceRoot.uri.path, filePath)
6453
const doc = await vscode.workspace.openTextDocument(absoluteFilePath)
6554
await vscode.window.showTextDocument(doc, vscode.ViewColumn.One)
6655
// there are times when initialization leave the panel behind any files opened

‎src/channel/index.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ interface Channel {
1717
interface ChannelProps {
1818
postMessage: (action: CR.Action) => Thenable<boolean>
1919
workspaceState: vscode.Memento
20+
workspaceRoot: vscode.WorkspaceFolder
2021
}
2122

2223

2324
class Channel implements Channel {
2425
private postMessage: (action: CR.Action) => Thenable<boolean>
2526
private workspaceState: vscode.Memento
27+
private workspaceRoot: vscode.WorkspaceFolder
2628
private context: Context
27-
constructor({postMessage, workspaceState}: ChannelProps) {
29+
constructor({postMessage, workspaceState, workspaceRoot}: ChannelProps) {
2830
// workspaceState used for local storage
2931
this.workspaceState = workspaceState
32+
this.workspaceRoot = workspaceRoot
3033
this.postMessage = postMessage
3134
this.context = new Context(workspaceState)
3235
}
@@ -96,7 +99,7 @@ class Channel implements Channel {
9699
// load step actions (git commits, commands, open files)
97100
case 'SETUP_ACTIONS':
98101
vscode.commands.executeCommand('coderoad.set_current_step', action.payload)
99-
setupActions(action.payload)
102+
setupActions(this.workspaceRoot, action.payload)
100103
return
101104
// load solution step actions (git commits, commands, open files)
102105
case 'SOLUTION_ACTIONS':

‎src/editor/ReactWebView.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const getNonce = (): string => {
1616
interface ReactWebViewProps {
1717
extensionPath: string
1818
workspaceState: vscode.Memento
19+
workspaceRoot: vscode.WorkspaceFolder
1920
}
2021

2122

@@ -30,7 +31,7 @@ class ReactWebView {
3031
private disposables: vscode.Disposable[] = []
3132
private channel: Channel
3233

33-
public constructor({extensionPath, workspaceState}: ReactWebViewProps) {
34+
public constructor({extensionPath, workspaceState, workspaceRoot}: ReactWebViewProps) {
3435
this.extensionPath = extensionPath
3536

3637
// Create and show a new webview panel
@@ -71,6 +72,7 @@ class ReactWebView {
7172
// channel connects webview to the editor
7273
this.channel = new Channel({
7374
workspaceState,
75+
workspaceRoot,
7476
postMessage: (action: Action): Thenable<boolean> => {
7577
// console.log(`postMessage ${JSON.stringify(action)}`)
7678
return this.panel.webview.postMessage(action)

‎src/editor/commands.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import * as vscode from 'vscode'
22
import ReactWebView from './ReactWebView'
33
import runTest from '../actions/runTest'
4-
import {isEmptyWorkspace} from './workspace'
54

65
const COMMANDS = {
76
START: 'coderoad.start',
@@ -13,9 +12,10 @@ const COMMANDS = {
10000 1312
interface CreateCommandProps {
1413
extensionPath: string
1514
workspaceState: vscode.Memento
15+
workspaceRoot: vscode.WorkspaceFolder
1616
}
1717

18-
export const createCommands = ({extensionPath, workspaceState}: CreateCommandProps) => {
18+
export const createCommands = ({extensionPath, workspaceState, workspaceRoot}: CreateCommandProps) => {
1919
// React panel webview
2020
let webview: any
2121
let currentStepId = ''
@@ -26,7 +26,7 @@ export const createCommands = ({extensionPath, workspaceState}: CreateCommandPro
2626
console.log('start')
2727

2828
// TODO: replace with a prompt to open a workspace
29-
await isEmptyWorkspace()
29+
// await isEmptyWorkspace()
3030

3131
let webviewState: 'INITIALIZING' | 'RESTARTING'
3232
if (!webview) {
@@ -43,6 +43,7 @@ export const createCommands = ({extensionPath, workspaceState}: CreateCommandPro
4343
webview = new ReactWebView({
4444
extensionPath,
4545
workspaceState,
46+
workspaceRoot,
4647
})
4748
},
4849
// open React webview

‎src/editor/index.ts

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,8 @@ class Editor {
66
// @ts-ignore
77
private vscodeExt: vscode.ExtensionContext
88

9-
constructor() {
10-
// set workspace root for node executions
11-
const rootPath = vscode.workspace.rootPath
12-
if (!rootPath) {
13-
throw new Error('Requires a workspace. Please open a folder')
14-
}
15-
}
169
public activate = (vscodeExt: vscode.ExtensionContext): void => {
10+
1711
console.log('ACTIVATE!')
1812
this.vscodeExt = vscodeExt
1913

@@ -31,21 +25,19 @@ class Editor {
3125
}
3226

3327
private activateCommands = (): void => {
34-
// NOTE: local storage must be bound to the vscodeExt.workspaceState
3528

36-
// store current tutorial id & version
37-
38-
39-
// store step progress for current tutorial
40-
// const stepProgress = new Storage<{[stepId: string]: boolean}>({
41-
// key: 'coderoad:progress',
42-
// storage: this.vscodeExt.workspaceState,
43-
// defaultValue: {},
44-
// })
29+
// set workspace root for node executions
30+
const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
31+
if (!workspaceRoots || !workspaceRoots.length) {
32+
throw new Error('No workspace root path')
33+
}
34+
const workspaceRoot: vscode.WorkspaceFolder = workspaceRoots[0]
4535

4636
const commands = createCommands({
4737
extensionPath: this.vscodeExt.extensionPath,
38+
// NOTE: local storage must be bound to the vscodeExt.workspaceState
4839
workspaceState: this.vscodeExt.workspaceState,
40+
workspaceRoot,
4941
})
5042

5143
// register commands

‎src/editor/workspace.ts

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎src/services/git/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import * as CR from 'typings'
21
import node from '../node'
32

43

‎src/services/node/index.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,21 @@ import * as vscode from 'vscode'
77
const asyncExec = promisify(cpExec)
88

99
class Node {
10-
private workspaceRoot: string
10+
private workspaceRootPath: string
1111
constructor() {
12-
this.workspaceRoot = vscode.workspace.rootPath || ''
13-
if (!this.workspaceRoot.length) {
14-
throw new Error('Invalid workspaceRoot')
12+
// set workspace root for node executions
13+
const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
14+
if (!workspaceRoots || !workspaceRoots.length) {
15+
throw new Error('No workspace root path')
1516
}
16-
console.log(`workspaceRoot: ${this.workspaceRoot}`)
17+
const workspaceRoot: vscode.WorkspaceFolder = workspaceRoots[0]
18+
this.workspaceRootPath = workspaceRoot.uri.path
1719
}
1820
public exec = (cmd: string): Promise<{stdout: string; stderr: string}> => asyncExec(cmd, {
19-
cwd: this.workspaceRoot,
21+
cwd: this.workspaceRootPath,
2022
})
2123

22-
public exists = (...paths: string[]): boolean => fs.existsSync(join(this.workspaceRoot, ...paths))
24+
public exists = (...paths: string[]): boolean => fs.existsSync(join(this.workspaceRootPath, ...paths))
2325
}
2426

2527
export default new Node()

0 commit comments

Comments
 (0)
0