Conflicting type definitions when using @vscode/python-extension package

[alcarney]

Apologies if I'm missing something obvious here - I've never quite managed to get my head around configuring Typescript correctly!

I am unable to get tsc to compile my VSCode extension as it complains about conflicting type definitions for the @types/vscode package.

$ npx tsc -p . 
node_modules/@types/vscode/index.d.ts:17:1 - error TS6200: Definitions of the following identifiers conflict with those in another file: 

...

Found 11 errors in 2 files.

Errors  Files
     5  node_modules/@types/vscode/index.d.ts:17
     6  node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:17

Full tsc output

$ npx tsc -p . 
node_modules/@types/vscode/index.d.ts:17:1 - error TS6200: Definitions of the following identifiers conflict with those in another file: version, Position, Range, Selection, Keyboard, Mouse, Command, Line, Block, Underline, LineThin, BlockOutline, UnderlineThin, Off, On, Relative, Default, InCenter, InCenterIfOutsideViewport, AtTop, Left, Center, Right, Full, OpenOpen, ClosedClosed, OpenClosed, ClosedOpen, ThemeColor, ThemeIcon, LF, CRLF, Uri, CancellationTokenSource, CancellationError, Disposable, EventEmitter, Separator, Info, Warning, Error, RelativePattern, GlobPattern, DocumentSelector, ProviderResult, CodeActionKind, Invoke, Automatic, CodeAction, CodeLens, DefinitionLink, Definition, Declaration, MarkdownString, MarkedString, Hover, EvaluatableExpression, InlineValueText, InlineValueVariableLookup, InlineValueEvaluatableExpression, InlineValue, Text, Read, Write, DocumentHighlight, File, Module, Namespace, Package, Class, Method, Property, Field, Constructor, Enum, Interface, Function, Variable, Constant, String, Number, Boolean, Array, Object, Key, Null, EnumMember, Struct, Event, Operator, TypeParameter, Deprecated, SymbolInformation, DocumentSymbol, TextEdit, SnippetTextEdit, NotebookEdit, WorkspaceEdit, SnippetString, SemanticTokensLegend, SemanticTokensBuilder, SemanticTokens, SemanticTokensEdits, SemanticTokensEdit, ParameterInformation, SignatureInformation, SignatureHelp, TriggerCharacter, ContentChange, Unit, Value, Keyword, Snippet, Color, Reference, Folder, User, Issue, CompletionItem, CompletionList, TriggerForIncompleteCompletions, InlineCompletionList, InlineCompletionItem, DocumentLink, ColorInformation, ColorPresentation, Type, Parameter, InlayHintLabelPart, InlayHint, FoldingRange, Comment, Imports, Region, SelectionRange, CallHierarchyItem, CallHierarchyIncomingCall, CallHierarchyOutgoingCall, TypeHierarchyItem, LinkedEditingRanges, DocumentDropEdit, CharacterPair, None, Indent, IndentOutdent, Outdent, Global, Workspace, WorkspaceFolder, Location, Information, Hint, DiagnosticRelatedInformation, Unnecessary, Diagnostic, Active, Beside, One, Two, Three, Four, Five, Six, Seven, Eight, Nine, Panel, Editor, TerminalLink, TerminalProfile, FileDecoration, UI, Production, Development, Test, Light, Dark, HighContrast, HighContrastLight, Always, Silent, Never, Shared, Dedicated, New, TaskGroup, ProcessExecution, Escape, Strong, Weak, ShellExecution, CustomExecution, Task, taskExecutions, onDidStartTask, onDidEndTask, onDidStartTaskProcess, onDidEndTaskProcess, Unknown, Directory, SymbolicLink, Readonly, FileSystemError, Changed, Created, Deleted, Desktop, Web, Trace, Debug, appName, appRoot, appHost, uriScheme, language, clipboard, machineId, sessionId, isNewAppInstall, isTelemetryEnabled, onDidChangeTelemetryEnabled, remoteName, shell, uiKind, logLevel, onDidChangeLogLevel, tabGroups, activeTextEditor, visibleTextEditors, onDidChangeActiveTextEditor, onDidChangeVisibleTextEditors, onDidChangeTextEditorSelection, onDidChangeTextEditorVisibleRanges, onDidChangeTextEditorOptions, onDidChangeTextEditorViewColumn, visibleNotebookEditors, onDidChangeVisibleNotebookEditors, activeNotebookEditor, onDidChangeActiveNotebookEditor, onDidChangeNotebookEditorSelection, onDidChangeNotebookEditorVisibleRanges, terminals, activeTerminal, onDidChangeActiveTerminal, onDidOpenTerminal, onDidCloseTerminal, onDidChangeTerminalState, state, onDidChangeWindowState, activeColorTheme, onDidChangeActiveColorTheme, DataTransferItem, DataTransfer, TreeItem, Collapsed, Expanded, Shutdown, Process, Extension, Replace, Append, Prepend, SourceControl, Window, Notification, QuickInputButtons, Undo, Redo, Manual, AfterDelay, FocusOut, fs, rootPath, workspaceFolders, name, workspaceFile, onDidChangeWorkspaceFolders, textDocuments, onDidOpenTextDocument, onDidCloseTextDocument, onDidChangeTextDocument, onWillSaveTextDocument, onDidSaveTextDocument, notebookDocuments, onDidChangeNotebookDocument, onWillSaveNotebookDocument, onDidSaveNotebookDocument, onDidOpenNotebookDocument, onDidCloseNotebookDocument, onWillCreateFiles, onDidCreateFiles, onWillDeleteFiles, onDidDeleteFiles, onWillRenameFiles, onDidRenameFiles, onDidChangeConfiguration, isTrusted, onDidGrantWorkspaceTrust, ConfigurationScope, onDidChangeDiagnostics, Markup, Code, NotebookRange, NotebookCellOutputItem, NotebookCellOutput, NotebookCellData, NotebookData, Preferred, NotebookCellStatusBarItem, inputBox, DebugAdapterExecutable, DebugAdapterServer, DebugAdapterNamedPipeServer, DebugAdapterInlineImplementation, DebugAdapterDescriptor, Breakpoint, SourceBreakpoint, FunctionBreakpoint, Separate, MergeWithParent, Initial, Dynamic, activeDebugSession, activeDebugConsole, breakpoints, onDidChangeActiveDebugSession, onDidStartDebugSession, onDidReceiveDebugSessionCustomEvent, onDidTerminateDebugSession, onDidChangeBreakpoints, all, onDidChange, Editing, Preview, Unresolved, Resolved, onDidChangeSessions, bundle, uri, Run, Coverage, TestTag, TestRunRequest, TestMessage, TabInputText, TabInputTextDiff, TabInputCustom, TabInputWebview, TabInputNotebook, TabInputNotebookDiff, TabInputTerminal, TelemetryTrustedValue
17 declare module 'vscode' {

node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:17:1
 17 declare module 'vscode' {
    ~~~~~~~
 Conflicts are in this file.

node_modules/@types/vscode/index.d.ts:4117:3 - error TS2374: Duplicate index signature for type 'string'.

4117   [key: string]: boolean | number | string;
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@types/vscode/index.d.ts:6008:3 - error TS2374: Duplicate index signature for type 'string'.

6008   readonly [key: string]: any;
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@types/vscode/index.d.ts:7524:3 - error TS2374: Duplicate index signature for type 'string'.

7524   [name: string]: any;
    ~~~~~~~~~~~~~~~~~~~~

node_modules/@types/vscode/index.d.ts:14632:3 - error TS2374: Duplicate index signature for type 'string'.

14632   [key: string]: any;
     ~~~~~~~~~~~~~~~~~~~

node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:17:1 - error TS6200: Definitions of the following identifiers conflict with those in another file: version, Position, Range, Selection, Keyboard, Mouse, Command, Line, Block, Underline, LineThin, BlockOutline, UnderlineThin, Off, On, Relative, Default, InCenter, InCenterIfOutsideViewport, AtTop, Left, Center, Right, Full, OpenOpen, ClosedClosed, OpenClosed, ClosedOpen, ThemeColor, ThemeIcon, LF, CRLF, Uri, CancellationTokenSource, CancellationError, Disposable, EventEmitter, Separator, Info, Warning, Error, RelativePattern, GlobPattern, DocumentSelector, ProviderResult, CodeActionKind, Invoke, Automatic, CodeAction, CodeLens, DefinitionLink, Definition, Declaration, MarkdownString, MarkedString, Hover, EvaluatableExpression, InlineValueText, InlineValueVariableLookup, InlineValueEvaluatableExpression, InlineValue, Text, Read, Write, DocumentHighlight, File, Module, Namespace, Package, Class, Method, Property, Field, Constructor, Enum, Interface, Function, Variable, Constant, String, Number, Boolean, Array, Object, Key, Null, EnumMember, Struct, Event, Operator, TypeParameter, Deprecated, SymbolInformation, DocumentSymbol, TextEdit, SnippetTextEdit, NotebookEdit, WorkspaceEdit, SnippetString, SemanticTokensLegend, SemanticTokensBuilder, SemanticTokens, SemanticTokensEdits, SemanticTokensEdit, ParameterInformation, SignatureInformation, SignatureHelp, TriggerCharacter, ContentChange, Unit, Value, Keyword, Snippet, Color, Reference, Folder, User, Issue, CompletionItem, CompletionList, TriggerForIncompleteCompletions, InlineCompletionList, InlineCompletionItem, DocumentLink, ColorInformation, ColorPresentation, Type, Parameter, InlayHintLabelPart, InlayHint, FoldingRange, Comment, Imports, Region, SelectionRange, CallHierarchyItem, CallHierarchyIncomingCall, CallHierarchyOutgoingCall, TypeHierarchyItem, LinkedEditingRanges, DocumentDropEdit, CharacterPair, None, Indent, IndentOutdent, Outdent, Global, Workspace, WorkspaceFolder, Location, Information, Hint, DiagnosticRelatedInformation, Unnecessary, Diagnostic, Active, Beside, One, Two, Three, Four, Five, Six, Seven, Eight, Nine, Panel, Editor, TerminalLink, TerminalProfile, FileDecoration, UI, Production, Development, Test, Light, Dark, HighContrast, HighContrastLight, Always, Silent, Never, Shared, Dedicated, New, TaskGroup, ProcessExecution, Escape, Strong, Weak, ShellExecution, CustomExecution, Task, taskExecutions, onDidStartTask, onDidEndTask, onDidStartTaskProcess, onDidEndTaskProcess, Unknown, Directory, SymbolicLink, Readonly, FileSystemError, Changed, Created, Deleted, Desktop, Web, Trace, Debug, appName, appRoot, appHost, uriScheme, language, clipboard, machineId, sessionId, isNewAppInstall, isTelemetryEnabled, onDidChangeTelemetryEnabled, remoteName, shell, uiKind, logLevel, onDidChangeLogLevel, tabGroups, activeTextEditor, visibleTextEditors, onDidChangeActiveTextEditor, onDidChangeVisibleTextEditors, onDidChangeTextEditorSelection, onDidChangeTextEditorVisibleRanges, onDidChangeTextEditorOptions, onDidChangeTextEditorViewColumn, visibleNotebookEditors, onDidChangeVisibleNotebookEditors, activeNotebookEditor, onDidChangeActiveNotebookEditor, onDidChangeNotebookEditorSelection, onDidChangeNotebookEditorVisibleRanges, terminals, activeTerminal, onDidChangeActiveTerminal, onDidOpenTerminal, onDidCloseTerminal, onDidChangeTerminalState, state, onDidChangeWindowState, activeColorTheme, onDidChangeActiveColorTheme, DataTransferItem, DataTransfer, TreeItem, Collapsed, Expanded, Shutdown, Process, Extension, Replace, Append, Prepend, SourceControl, Window, Notification, QuickInputButtons, Undo, Redo, Manual, AfterDelay, FocusOut, fs, rootPath, workspaceFolders, name, workspaceFile, onDidChangeWorkspaceFolders, textDocuments, onDidOpenTextDocument, onDidCloseTextDocument, onDidChangeTextDocument, onWillSaveTextDocument, onDidSaveTextDocument, notebookDocuments, onDidChangeNotebookDocument, onWillSaveNotebookDocument, onDidSaveNotebookDocument, onDidOpenNotebookDocument, onDidCloseNotebookDocument, onWillCreateFiles, onDidCreateFiles, onWillDeleteFiles, onDidDeleteFiles, onWillRenameFiles, onDidRenameFiles, onDidChangeConfiguration, isTrusted, onDidGrantWorkspaceTrust, ConfigurationScope, onDidChangeDiagnostics, Markup, Code, NotebookRange, NotebookCellOutputItem, NotebookCellOutput, NotebookCellData, NotebookData, Preferred, NotebookCellStatusBarItem, inputBox, DebugAdapterExecutable, DebugAdapterServer, DebugAdapterNamedPipeServer, DebugAdapterInlineImplementation, DebugAdapterDescriptor, Breakpoint, SourceBreakpoint, FunctionBreakpoint, Separate, MergeWithParent, Initial, Dynamic, activeDebugSession, activeDebugConsole, breakpoints, onDidChangeActiveDebugSession, onDidStartDebugSession, onDidReceiveDebugSessionCustomEvent, onDidTerminateDebugSession, onDidChangeBreakpoints, all, onDidChange, Editing, Preview, Unresolved, Resolved, onDidChangeSessions, bundle, uri, Run, Coverage, TestTag, TestRunRequest, TestMessage, TabInputText, TabInputTextDiff, TabInputCustom, TabInputWebview, TabInputNotebook, TabInputNotebookDiff, TabInputTerminal, TelemetryTrustedValue

17 declare module 'vscode' {

node_modules/@types/vscode/index.d.ts:17:1

17 declare module 'vscode' {

~~~~~~~

Conflicts are in this file.
node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:4117:3 - error TS2374: Duplicate index signature for type 'string'.
4117   [key: string]: boolean | number | string;

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:6008:3 - error TS2374: Duplicate index signature for type 'string'.
6008   readonly [key: string]: any;

~~~~~~~~~~~~~~~~~~~~~~~~~~~~
node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:7529:3 - error TS2374: Duplicate index signature for type 'string'.
7529   [name: string]: any;

~~~~~~~~~~~~~~~~~~~~
node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:14718:3 - error TS2374: Duplicate index signature for type 'string'.
14718   [key: string]: any;

~~~~~~~~~~~~~~~~~~~
node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:15807:3 - error TS2717: Subsequent property declarations must have the same type.  Property 'forceNewSession' must be of type 'boolean | { detail: string; } | undefined', but here has type 'boolean | AuthenticationForceNewSessionOptions | undefined'.
15807   forceNewSession?: boolean | AuthenticationForceNewSessionOptions;

~~~~~~~~~~~~~~~
node_modules/@types/vscode/index.d.ts:15711:3

15711   forceNewSession?: boolean | { detail: string };

~~~~~~~~~~~~~~~

'forceNewSession' was also declared here.
Found 11 errors in 2 files.
Errors  Files

5  node_modules/@types/vscode/index.d.ts:17

6  node_modules/@vscode/python-extension/node_modules/@types/vscode/index.d.ts:17

However when I use my webpack config everything compiles with no issue 🤷‍♂️

I assumed that my tsconfig.json must be incorrect but even after excluding node_modules/ I see the same error.

My tsconfig.json

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "ES2020",
        "lib": [
            "ES2020"
        ],
        "sourceMap": true,
        "rootDir": "src",
        "outDir": "dist",
        "strict": true,
        "noImplicitReturns": true,
        "noFallthroughCasesInSwitch": true,
        "noUnusedParameters": true
    },
    "exclude": [
        "node_modules",
    ]
}

My webpack config if that helps at all?

//@ts-check
'use strict';
const path = require('path')
//@ts-check

/** @typedef {import('webpack').Configuration} WebpackConfig **/
// Configuration for the "main" version of the VSCode extension

/**@type WebpackConfig */

const nodeConfig = {

target: 'node',

mode: 'none',

entry: './src/node/extension.ts',

output: {

path: path.resolve(__dirname, 'dist', 'node'),

filename: 'extension.js',

libraryTarget: 'commonjs2',

},

externals: {

vscode: "commonjs vscode"

},

resolve: {

extensions: ['.ts', '.js']

},

module: {

rules: [

{

test: /.ts$/,

exclude: /node_modules/,

use: [{ loader: 'ts-loader' }]

}

]

},

devtool: 'source-map',

infrastructureLogging: {

level: 'log',

},

}

module.exports = [nodeConfig]

Any advice would be greatly appreciated! :)

[alcarney]

Looking at this again, it appears that the conflicts are beacuse I have @types/vscode 1.78.0 installed, but the @vscode/python-extension package bundles @types/vscode 1.80.0.

Adding the following to my tsconfig.json appears to resolve the issue

 {
     "compilerOptions": {
         "module": "commonjs",
         "target": "ES2020",
+       "baseUrl": ".",
+       "paths": {
+            "vscode": [
+                "node_modules/@types/vscode"
+            ]
+        },
         "lib": [
             "ES2020"
         ],
         "sourceMap": true,
         "rootDir": "src",
         "outDir": "dist",
         "strict": true,
         "noImplicitReturns": true,
         "noFallthroughCasesInSwitch": true,
         "noUnusedParameters": true
     },
     "exclude": [
         "node_modules/",
     ]
 }

[brettcannon]

If there's anything you think we should change, please feel free to open an issue!

[karrtikr]

I've opened #21684 to have a closer look and make sure we document this if required.

[karrtikr]

@alcarney We've fixed the issue for you so even editing tsconfig.json is no longer needed for the latest package.

[alcarney]

Awesome thank you! 😄

[lukiszlak]

Hmm, I've had similar problem with @types/vscode ^1.87.0 and @alcarney fix still was needed 🤔