Merge pull request #749 from brifly/fix-debug-instructions

Improvements to the contributing instructions

Author: msivasubramaniaan

CONTRIBUTING.md

@@ -46,27 +46,35 @@ All contributions are welcome!
             ├──── yaml-language-server/
   ```
 
-3. Run `yarn install` in both directories to initialize `node_modules` dependencies.
+3. Open the `vscode-yaml` folder in VSCode, and then add the `yaml-language-server` project to the workspace using `File -> Add Folder to Workspace...`.
 
-4. In `vscode-yaml/webpack.config.js` set the `config.entry.languageserver` property to:
+4. Run `yarn install` in both directories to initialize `node_modules` dependencies.
+
+5. In `vscode-yaml/webpack.config.js` set the `config.entry.languageserver` property to:
 
    ```js
-   languageserver: './../yaml-language-server/out/server/src/server.js',
+   languageserver: './../yaml-language-server/src/server.ts',
    ```
 
    _This will redirect which YAML LS to use._
 
-5. First run `yarn run compile` in `yaml-language-server` then in `vscode-yaml` directory
+6. In `yaml-language-server/.vscode/launch.json` set `outFiles` in the `Attach to server` configuration to:
+
+   ```js
+   "outFiles": ["${workspaceFolder}/../vscode-yaml/dist/**/*.js"],
+   ```
 
-6. To run the language server in VSCode, click `View -> Debug`, then from the drop down menu beside the green arrow select `Launch Extension (vscode-yaml)`, click the arrow, and a new VSCode window should load with the YAML LS running.
+7. To run the language server in VSCode, click `View -> Debug`, then from the drop down menu beside the green arrow select `Launch Extension (vscode-yaml)`, click the arrow, and a new VSCode window should load with the YAML LS running.
 
-7. To debug the language server in VSCode, from the same drop down menu
+8. To debug the language server in VSCode, from the same drop down menu
    select
    `Attach (yaml-language-server)`, and click the green arrow to start.
    Ensure you've opened a YAML file or else the server would have not yet
    started.
 
-**Note:** Disable or remove any existing implementations of the YAML Language server from VSCode or there will be conflicts.
+**Notes:**
+* Disable or remove any existing implementations of the YAML Language server from VSCode or there will be conflicts.
+* If you still have issues you can also try changing the debug port for the language server. To do this change the port in the `Attach to server` configuration to another value in `yaml-language-server/.vscode/launch.json`, then change update the port in `debugOptions` (`'--inspect=6009'`) to the new port in the file `vscode-yaml/src/node/yamlClientMain.ts`.
 
 ##### Developing the server side