Incorrect comment in vscode.d.ts related to registerDebugConfigurationProvider

[atian25]

• VSCode Version: 1.17.1
• OS Version: mac

Steps to Reproduce:

1. write a extension
2. call vscode.workspace.registerDebugConfigurationProvider

BTW, https://code.visualstudio.com/docs/extensions/example-debuggers need updated also.

Reproduces without extensions: Yes/No

[egamma]

@atian25 In your package.json do you set the engine version to 1.17 and did you run postInstall?

[atian25]

  "engines": {
    "vscode": "^1.17.0"
  },

and just run postinstall:

➜  vscode-eggjs git:(master) npm run postinstall

> eggjs@0.0.6 postinstall /Users/tz/Workspaces/github/vscode-eggjs
> node ./node_modules/vscode/bin/install

Detected VS Code engine version: ^1.17.0
Found minimal version that qualifies engine range: 1.17.0
Fetching vscode.d.ts from: https://raw.githubusercontent.com/Microsoft/vscode/be377c0faf7574a59f84940f593a6849f12e4de7/src/vs/vscode.d.ts
vscode.d.ts successfully installed!

see the image above, in DEBUG CONSOLE, log vscode.version is 1.17.1

[egamma]

You are using the wrong name space. It is vscode.debug.registerConfigurationProvider.

[atian25]

oh, sorry.

so it seems to be a doc bug at vscode.d.ts

[atian25]

and also https://code.visualstudio.com/docs/extensions/example-debuggers need update.

[egamma]

@atian25 this explains things, thanks. Reopening.

[weinand]

For updating the documentation (https://code.visualstudio.com/docs/extensions/example-debuggers) I've created microsoft/vscode-docs#1216.

[atian25]

hi, @weinand

had register, but the provideDebugConfigurations don't trigger when click add Configuration, did I miss some config?
should I need to provide contributes.debugger ? how?

  context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider('node', {
    provideDebugConfigurations(folder: WorkspaceFolder, token?: CancellationToken): DebugConfiguration[] {
      return [
        {
          name: 'Egg Debug',
          type: 'node',
          request: 'launch',
          port: '9999',
        }
      ];
    }
  }));

[weinand]

@atian25 make sure that your debugger extension activates correctly by contributing this in package.json:

	"activationEvents": [
		"onDebug",

                // ... and all commands that need to activate this extension 
        ]

Please note that provideDebugConfigurations is only called for projects that do not have a launch.json. And you need to press debug's gear icon.

[atian25]

provideDebugConfigurations don't support add Configuration?

Only had to config configurationSnippets?

[atian25]

as #34668 DebugConfigurationProvider should support configurationSnippets now

[weinand]

I was wrong in closing #34668. Please see my comment there.