Skip to content

Commit 657515a

Browse files
committed
Add note about installing ESLint globally for VS Code extension
And do some documentation clean up while we're at it.
1 parent f1eadc0 commit 657515a

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

docs/development.md

+14-23
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,45 @@
22

33
## Development Setup
44

5-
You'll need to clone two repositories and set up your development environment
6-
to before you can proceed.
5+
1. [Fork and clone][fork] the [vscode-powershell repository](https://github.com/PowerShell/vscode-powershell).
76

8-
1. [Fork and clone][fork] the [vscode-powershell repository](https://github.com/PowerShell/vscode-powershell)
9-
10-
2. [Fork and clone][fork] the [PowerShell Editor Services (PSES) repository](https://github.com/PowerShell/PowerShellEditorServices)
7+
2. [Fork and clone][fork] the [PowerShell Editor Services (PSES) repository](https://github.com/PowerShell/PowerShellEditorServices).
118
> The `vscode-powershell` folder and the `PowerShellEditorServices` folder should be next to each other on the file
129
> system. Code in `vscode-powershell` looks for PSES at `../PowerShellEditorServices` if you're building locally so
1310
> PSES must be in that location.
1411
1512
3. Follow the [development instructions](https://github.com/PowerShell/PowerShellEditorServices#development) for
1613
PowerShell Editor Services. **You will need to complete this step before proceeding**.
1714

18-
4. Install the latest [Visual Studio Code Insiders release](https://code.visualstudio.com/insiders)
19-
> You can also use the [standard Visual Studio Code release](https://code.visualstudio.com/). Both will work, but
20-
> using VSCode Insiders means the extension can be developed ready for new features and changes in the next VSCode
21-
> release.
15+
4. Install [Node.js](https://nodejs.org/en/) 16.x or higher.
2216

23-
5. Install [Node.js](https://nodejs.org/en/) 16.x or higher.
17+
5. Install [Visual Studio Code](https://code.visualstudio.com).
18+
Open the multi-root workspace file in this repo, `extension-dev.code-workspace`.
19+
> This has a set of recommended extensions to install and provides tasks.
20+
> The ESLint formatter will require you to install ESLint globally, using `npm install -g eslint`.
21+
> Otherwise VS Code will erroneously complain that it isn't able to use it to format TypeScript files.
2422
2523
[fork]: https://help.github.com/articles/fork-a-repo/
2624

2725
### Building the Code
2826

2927
#### From Visual Studio Code
3028

31-
> Press <kbd>Ctrl</kbd>+<kbd>P</kbd> and type `task build`
32-
33-
This will compile the TypeScript files in the project to JavaScript files.
29+
Press <kbd>Ctrl+P</kbd> and type `task build`. Explore the other provided tasks for helpful commands.
3430

3531
#### From a PowerShell prompt
3632

3733
```powershell
3834
Invoke-Build Build
3935
```
4036

41-
### Launching the extension
42-
43-
#### From Visual Studio Code
44-
45-
> To debug the extension, press <kbd>F5</kbd>. To run the extension without debugging, press
46-
> <kbd>Ctrl</kbd>+<kbd>F5</kbd> or <kbd>Cmd</kbd>+<kbd>F5</kbd> on macOS.
37+
Explore the `vscode-powershell.build.ps1` file for other build targets.
4738

48-
#### From a command prompt
39+
### Launching the extension
4940

50-
```cmd
51-
code --extensionDevelopmentPath="c:\path\to\vscode-powershell" .
52-
```
41+
To debug the extension use one of the provided `Launch Extension` debug configurations (remember to rebuild first).
42+
You can simultaneously use the `Attach to Editor Services` configuration to attach the .NET debugger to the PowerShell process running the server.
43+
Try the `powershell.developer.editorServicesWaitForDebugger` setting to attach before startup.
5344

5445
## Contributing Snippets
5546

0 commit comments

Comments
 (0)