@tsc-rs/typescript 0.0.0-placeholder → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (555) hide show
  1. package/LICENSE +21 -0
  2. package/NOTICE.txt +599 -0
  3. package/README.md +111 -0
  4. package/bin/tsc +2 -0
  5. package/dist/api/async/api.d.ts +1041 -0
  6. package/dist/api/async/api.d.ts.map +1 -0
  7. package/dist/api/async/api.js +3143 -0
  8. package/dist/api/async/api.js.map +1 -0
  9. package/dist/api/async/client.d.ts +52 -0
  10. package/dist/api/async/client.d.ts.map +1 -0
  11. package/dist/api/async/client.js +365 -0
  12. package/dist/api/async/client.js.map +1 -0
  13. package/dist/api/async/types.d.ts +375 -0
  14. package/dist/api/async/types.d.ts.map +1 -0
  15. package/dist/api/async/types.js +2 -0
  16. package/dist/api/async/types.js.map +1 -0
  17. package/dist/api/compilerOptions.generated.d.ts +123 -0
  18. package/dist/api/compilerOptions.generated.d.ts.map +1 -0
  19. package/dist/api/compilerOptions.generated.js +8 -0
  20. package/dist/api/compilerOptions.generated.js.map +1 -0
  21. package/dist/api/diagnosticFormatter.d.ts +9 -0
  22. package/dist/api/diagnosticFormatter.d.ts.map +1 -0
  23. package/dist/api/diagnosticFormatter.js +169 -0
  24. package/dist/api/diagnosticFormatter.js.map +1 -0
  25. package/dist/api/fs.d.ts +78 -0
  26. package/dist/api/fs.d.ts.map +1 -0
  27. package/dist/api/fs.js +70 -0
  28. package/dist/api/fs.js.map +1 -0
  29. package/dist/api/fsCallbacks.d.ts +27 -0
  30. package/dist/api/fsCallbacks.d.ts.map +1 -0
  31. package/dist/api/fsCallbacks.js +111 -0
  32. package/dist/api/fsCallbacks.js.map +1 -0
  33. package/dist/api/node/encoder.d.ts +18 -0
  34. package/dist/api/node/encoder.d.ts.map +1 -0
  35. package/dist/api/node/encoder.generated.d.ts +5 -0
  36. package/dist/api/node/encoder.generated.d.ts.map +1 -0
  37. package/dist/api/node/encoder.generated.js +74 -0
  38. package/dist/api/node/encoder.generated.js.map +1 -0
  39. package/dist/api/node/encoder.js +292 -0
  40. package/dist/api/node/encoder.js.map +1 -0
  41. package/dist/api/node/msgpack.d.ts +32 -0
  42. package/dist/api/node/msgpack.d.ts.map +1 -0
  43. package/dist/api/node/msgpack.js +212 -0
  44. package/dist/api/node/msgpack.js.map +1 -0
  45. package/dist/api/node/node.d.ts +102 -0
  46. package/dist/api/node/node.d.ts.map +1 -0
  47. package/dist/api/node/node.generated.d.ts +189 -0
  48. package/dist/api/node/node.generated.d.ts.map +1 -0
  49. package/dist/api/node/node.generated.js +884 -0
  50. package/dist/api/node/node.generated.js.map +1 -0
  51. package/dist/api/node/node.infrastructure.d.ts +64 -0
  52. package/dist/api/node/node.infrastructure.d.ts.map +1 -0
  53. package/dist/api/node/node.infrastructure.js +102 -0
  54. package/dist/api/node/node.infrastructure.js.map +1 -0
  55. package/dist/api/node/node.js +454 -0
  56. package/dist/api/node/node.js.map +1 -0
  57. package/dist/api/node/protocol.d.ts +32 -0
  58. package/dist/api/node/protocol.d.ts.map +1 -0
  59. package/dist/api/node/protocol.generated.d.ts +4 -0
  60. package/dist/api/node/protocol.generated.d.ts.map +1 -0
  61. package/dist/api/node/protocol.generated.js +241 -0
  62. package/dist/api/node/protocol.generated.js.map +1 -0
  63. package/dist/api/node/protocol.js +33 -0
  64. package/dist/api/node/protocol.js.map +1 -0
  65. package/dist/api/node/wtf8.d.ts +10 -0
  66. package/dist/api/node/wtf8.d.ts.map +1 -0
  67. package/dist/api/node/wtf8.js +130 -0
  68. package/dist/api/node/wtf8.js.map +1 -0
  69. package/dist/api/options.d.ts +41 -0
  70. package/dist/api/options.d.ts.map +1 -0
  71. package/dist/api/options.js +32 -0
  72. package/dist/api/options.js.map +1 -0
  73. package/dist/api/path.d.ts +149 -0
  74. package/dist/api/path.d.ts.map +1 -0
  75. package/dist/api/path.js +884 -0
  76. package/dist/api/path.js.map +1 -0
  77. package/dist/api/prepareCompilerOptions.generated.d.ts +5 -0
  78. package/dist/api/prepareCompilerOptions.generated.d.ts.map +1 -0
  79. package/dist/api/prepareCompilerOptions.generated.js +24 -0
  80. package/dist/api/prepareCompilerOptions.generated.js.map +1 -0
  81. package/dist/api/proto.d.ts +95 -0
  82. package/dist/api/proto.d.ts.map +1 -0
  83. package/dist/api/proto.generated.d.ts +1423 -0
  84. package/dist/api/proto.generated.d.ts.map +1 -0
  85. package/dist/api/proto.generated.js +21 -0
  86. package/dist/api/proto.generated.js.map +1 -0
  87. package/dist/api/proto.js +65 -0
  88. package/dist/api/proto.js.map +1 -0
  89. package/dist/api/sourceFileCache.d.ts +110 -0
  90. package/dist/api/sourceFileCache.d.ts.map +1 -0
  91. package/dist/api/sourceFileCache.js +300 -0
  92. package/dist/api/sourceFileCache.js.map +1 -0
  93. package/dist/api/sync/api.d.ts +1729 -0
  94. package/dist/api/sync/api.d.ts.map +1 -0
  95. package/dist/api/sync/api.js +5484 -0
  96. package/dist/api/sync/api.js.map +1 -0
  97. package/dist/api/sync/client.d.ts +34 -0
  98. package/dist/api/sync/client.d.ts.map +1 -0
  99. package/dist/api/sync/client.js +148 -0
  100. package/dist/api/sync/client.js.map +1 -0
  101. package/dist/api/sync/generatorSupport.d.ts +32 -0
  102. package/dist/api/sync/generatorSupport.d.ts.map +1 -0
  103. package/dist/api/sync/generatorSupport.js +323 -0
  104. package/dist/api/sync/generatorSupport.js.map +1 -0
  105. package/dist/api/sync/types.d.ts +502 -0
  106. package/dist/api/sync/types.d.ts.map +1 -0
  107. package/dist/api/sync/types.js +2 -0
  108. package/dist/api/sync/types.js.map +1 -0
  109. package/dist/api/syncChannel.d.ts +115 -0
  110. package/dist/api/syncChannel.d.ts.map +1 -0
  111. package/dist/api/syncChannel.js +511 -0
  112. package/dist/api/syncChannel.js.map +1 -0
  113. package/dist/api/timing.d.ts +175 -0
  114. package/dist/api/timing.d.ts.map +1 -0
  115. package/dist/api/timing.js +149 -0
  116. package/dist/api/timing.js.map +1 -0
  117. package/dist/api/typedPaths.d.ts +3 -0
  118. package/dist/api/typedPaths.d.ts.map +1 -0
  119. package/dist/api/typedPaths.js +2 -0
  120. package/dist/api/typedPaths.js.map +1 -0
  121. package/dist/api/userPreferences.generated.d.ts +195 -0
  122. package/dist/api/userPreferences.generated.d.ts.map +1 -0
  123. package/dist/api/userPreferences.generated.js +3 -0
  124. package/dist/api/userPreferences.generated.js.map +1 -0
  125. package/dist/ast/ast.d.ts +186 -0
  126. package/dist/ast/ast.d.ts.map +1 -0
  127. package/dist/ast/ast.generated.d.ts +1167 -0
  128. package/dist/ast/ast.generated.d.ts.map +1 -0
  129. package/dist/ast/ast.generated.js +4 -0
  130. package/dist/ast/ast.generated.js.map +1 -0
  131. package/dist/ast/ast.js +7 -0
  132. package/dist/ast/ast.js.map +1 -0
  133. package/dist/ast/astnav.d.ts +22 -0
  134. package/dist/ast/astnav.d.ts.map +1 -0
  135. package/dist/ast/astnav.js +741 -0
  136. package/dist/ast/astnav.js.map +1 -0
  137. package/dist/ast/clone.d.ts +16 -0
  138. package/dist/ast/clone.d.ts.map +1 -0
  139. package/dist/ast/clone.js +104 -0
  140. package/dist/ast/clone.js.map +1 -0
  141. package/dist/ast/factory.generated.d.ts +533 -0
  142. package/dist/ast/factory.generated.d.ts.map +1 -0
  143. package/dist/ast/factory.generated.js +5750 -0
  144. package/dist/ast/factory.generated.js.map +1 -0
  145. package/dist/ast/index.d.ts +25 -0
  146. package/dist/ast/index.d.ts.map +1 -0
  147. package/dist/ast/index.js +25 -0
  148. package/dist/ast/index.js.map +1 -0
  149. package/dist/ast/is.d.ts +36 -0
  150. package/dist/ast/is.d.ts.map +1 -0
  151. package/dist/ast/is.generated.d.ts +1217 -0
  152. package/dist/ast/is.generated.d.ts.map +1 -0
  153. package/dist/ast/is.generated.js +1400 -0
  154. package/dist/ast/is.generated.js.map +1 -0
  155. package/dist/ast/is.js +456 -0
  156. package/dist/ast/is.js.map +1 -0
  157. package/dist/ast/jsdoc.d.ts +12 -0
  158. package/dist/ast/jsdoc.d.ts.map +1 -0
  159. package/dist/ast/jsdoc.js +208 -0
  160. package/dist/ast/jsdoc.js.map +1 -0
  161. package/dist/ast/modifiers.d.ts +4 -0
  162. package/dist/ast/modifiers.d.ts.map +1 -0
  163. package/dist/ast/modifiers.js +41 -0
  164. package/dist/ast/modifiers.js.map +1 -0
  165. package/dist/ast/scanner.d.ts +97 -0
  166. package/dist/ast/scanner.d.ts.map +1 -0
  167. package/dist/ast/scanner.js +2231 -0
  168. package/dist/ast/scanner.js.map +1 -0
  169. package/dist/ast/spanMap.d.ts +88 -0
  170. package/dist/ast/spanMap.d.ts.map +1 -0
  171. package/dist/ast/spanMap.js +417 -0
  172. package/dist/ast/spanMap.js.map +1 -0
  173. package/dist/ast/utils.d.ts +30 -0
  174. package/dist/ast/utils.d.ts.map +1 -0
  175. package/dist/ast/utils.js +318 -0
  176. package/dist/ast/utils.js.map +1 -0
  177. package/dist/ast/visitor.d.ts +16 -0
  178. package/dist/ast/visitor.d.ts.map +1 -0
  179. package/dist/ast/visitor.generated.d.ts +50 -0
  180. package/dist/ast/visitor.generated.d.ts.map +1 -0
  181. package/dist/ast/visitor.generated.js +979 -0
  182. package/dist/ast/visitor.generated.js.map +1 -0
  183. package/dist/ast/visitor.js +87 -0
  184. package/dist/ast/visitor.js.map +1 -0
  185. package/dist/enums/caseSensitivity.d.ts +2 -0
  186. package/dist/enums/caseSensitivity.d.ts.map +1 -0
  187. package/dist/enums/caseSensitivity.enum.d.ts +5 -0
  188. package/dist/enums/caseSensitivity.enum.d.ts.map +1 -0
  189. package/dist/enums/caseSensitivity.enum.js +7 -0
  190. package/dist/enums/caseSensitivity.enum.js.map +1 -0
  191. package/dist/enums/caseSensitivity.js +7 -0
  192. package/dist/enums/caseSensitivity.js.map +1 -0
  193. package/dist/enums/characterCodes.d.ts +2 -0
  194. package/dist/enums/characterCodes.d.ts.map +1 -0
  195. package/dist/enums/characterCodes.enum.d.ts +129 -0
  196. package/dist/enums/characterCodes.enum.d.ts.map +1 -0
  197. package/dist/enums/characterCodes.enum.js +132 -0
  198. package/dist/enums/characterCodes.enum.js.map +1 -0
  199. package/dist/enums/characterCodes.js +130 -0
  200. package/dist/enums/characterCodes.js.map +1 -0
  201. package/dist/enums/checkFlags.d.ts +2 -0
  202. package/dist/enums/checkFlags.d.ts.map +1 -0
  203. package/dist/enums/checkFlags.enum.d.ts +34 -0
  204. package/dist/enums/checkFlags.enum.d.ts.map +1 -0
  205. package/dist/enums/checkFlags.enum.js +36 -0
  206. package/dist/enums/checkFlags.enum.js.map +1 -0
  207. package/dist/enums/checkFlags.js +36 -0
  208. package/dist/enums/checkFlags.js.map +1 -0
  209. package/dist/enums/commentDirectiveType.d.ts +2 -0
  210. package/dist/enums/commentDirectiveType.d.ts.map +1 -0
  211. package/dist/enums/commentDirectiveType.enum.d.ts +5 -0
  212. package/dist/enums/commentDirectiveType.enum.d.ts.map +1 -0
  213. package/dist/enums/commentDirectiveType.enum.js +6 -0
  214. package/dist/enums/commentDirectiveType.enum.js.map +1 -0
  215. package/dist/enums/commentDirectiveType.js +6 -0
  216. package/dist/enums/commentDirectiveType.js.map +1 -0
  217. package/dist/enums/completionItemKind.d.ts +2 -0
  218. package/dist/enums/completionItemKind.d.ts.map +1 -0
  219. package/dist/enums/completionItemKind.enum.d.ts +28 -0
  220. package/dist/enums/completionItemKind.enum.d.ts.map +1 -0
  221. package/dist/enums/completionItemKind.enum.js +30 -0
  222. package/dist/enums/completionItemKind.enum.js.map +1 -0
  223. package/dist/enums/completionItemKind.js +30 -0
  224. package/dist/enums/completionItemKind.js.map +1 -0
  225. package/dist/enums/diagnosticCategory.d.ts +2 -0
  226. package/dist/enums/diagnosticCategory.d.ts.map +1 -0
  227. package/dist/enums/diagnosticCategory.enum.d.ts +7 -0
  228. package/dist/enums/diagnosticCategory.enum.d.ts.map +1 -0
  229. package/dist/enums/diagnosticCategory.enum.js +9 -0
  230. package/dist/enums/diagnosticCategory.enum.js.map +1 -0
  231. package/dist/enums/diagnosticCategory.js +9 -0
  232. package/dist/enums/diagnosticCategory.js.map +1 -0
  233. package/dist/enums/diagnosticDirectivePolicy.d.ts +2 -0
  234. package/dist/enums/diagnosticDirectivePolicy.d.ts.map +1 -0
  235. package/dist/enums/diagnosticDirectivePolicy.enum.d.ts +5 -0
  236. package/dist/enums/diagnosticDirectivePolicy.enum.d.ts.map +1 -0
  237. package/dist/enums/diagnosticDirectivePolicy.enum.js +7 -0
  238. package/dist/enums/diagnosticDirectivePolicy.enum.js.map +1 -0
  239. package/dist/enums/diagnosticDirectivePolicy.js +7 -0
  240. package/dist/enums/diagnosticDirectivePolicy.js.map +1 -0
  241. package/dist/enums/elementFlags.d.ts +2 -0
  242. package/dist/enums/elementFlags.d.ts.map +1 -0
  243. package/dist/enums/elementFlags.enum.d.ts +12 -0
  244. package/dist/enums/elementFlags.enum.d.ts.map +1 -0
  245. package/dist/enums/elementFlags.enum.js +14 -0
  246. package/dist/enums/elementFlags.enum.js.map +1 -0
  247. package/dist/enums/elementFlags.js +14 -0
  248. package/dist/enums/elementFlags.js.map +1 -0
  249. package/dist/enums/emitOnly.d.ts +2 -0
  250. package/dist/enums/emitOnly.d.ts.map +1 -0
  251. package/dist/enums/emitOnly.enum.d.ts +6 -0
  252. package/dist/enums/emitOnly.enum.d.ts.map +1 -0
  253. package/dist/enums/emitOnly.enum.js +8 -0
  254. package/dist/enums/emitOnly.enum.js.map +1 -0
  255. package/dist/enums/emitOnly.js +8 -0
  256. package/dist/enums/emitOnly.js.map +1 -0
  257. package/dist/enums/indexKind.d.ts +2 -0
  258. package/dist/enums/indexKind.d.ts.map +1 -0
  259. package/dist/enums/indexKind.enum.d.ts +5 -0
  260. package/dist/enums/indexKind.enum.d.ts.map +1 -0
  261. package/dist/enums/indexKind.enum.js +7 -0
  262. package/dist/enums/indexKind.enum.js.map +1 -0
  263. package/dist/enums/indexKind.js +7 -0
  264. package/dist/enums/indexKind.js.map +1 -0
  265. package/dist/enums/internalSymbolName.d.ts +2 -0
  266. package/dist/enums/internalSymbolName.d.ts.map +1 -0
  267. package/dist/enums/internalSymbolName.enum.d.ts +23 -0
  268. package/dist/enums/internalSymbolName.enum.d.ts.map +1 -0
  269. package/dist/enums/internalSymbolName.enum.js +25 -0
  270. package/dist/enums/internalSymbolName.enum.js.map +1 -0
  271. package/dist/enums/internalSymbolName.js +25 -0
  272. package/dist/enums/internalSymbolName.js.map +1 -0
  273. package/dist/enums/jsDeclarationKind.d.ts +2 -0
  274. package/dist/enums/jsDeclarationKind.d.ts.map +1 -0
  275. package/dist/enums/jsDeclarationKind.enum.d.ts +10 -0
  276. package/dist/enums/jsDeclarationKind.enum.d.ts.map +1 -0
  277. package/dist/enums/jsDeclarationKind.enum.js +12 -0
  278. package/dist/enums/jsDeclarationKind.enum.js.map +1 -0
  279. package/dist/enums/jsDeclarationKind.js +12 -0
  280. package/dist/enums/jsDeclarationKind.js.map +1 -0
  281. package/dist/enums/jsxEmit.d.ts +2 -0
  282. package/dist/enums/jsxEmit.d.ts.map +1 -0
  283. package/dist/enums/jsxEmit.enum.d.ts +9 -0
  284. package/dist/enums/jsxEmit.enum.d.ts.map +1 -0
  285. package/dist/enums/jsxEmit.enum.js +11 -0
  286. package/dist/enums/jsxEmit.enum.js.map +1 -0
  287. package/dist/enums/jsxEmit.js +11 -0
  288. package/dist/enums/jsxEmit.js.map +1 -0
  289. package/dist/enums/languageVariant.d.ts +2 -0
  290. package/dist/enums/languageVariant.d.ts.map +1 -0
  291. package/dist/enums/languageVariant.enum.d.ts +5 -0
  292. package/dist/enums/languageVariant.enum.d.ts.map +1 -0
  293. package/dist/enums/languageVariant.enum.js +6 -0
  294. package/dist/enums/languageVariant.enum.js.map +1 -0
  295. package/dist/enums/languageVariant.js +6 -0
  296. package/dist/enums/languageVariant.js.map +1 -0
  297. package/dist/enums/modifierFlags.d.ts +2 -0
  298. package/dist/enums/modifierFlags.d.ts.map +1 -0
  299. package/dist/enums/modifierFlags.enum.d.ts +42 -0
  300. package/dist/enums/modifierFlags.enum.d.ts.map +1 -0
  301. package/dist/enums/modifierFlags.enum.js +44 -0
  302. package/dist/enums/modifierFlags.enum.js.map +1 -0
  303. package/dist/enums/modifierFlags.js +44 -0
  304. package/dist/enums/modifierFlags.js.map +1 -0
  305. package/dist/enums/moduleDetectionKind.d.ts +2 -0
  306. package/dist/enums/moduleDetectionKind.d.ts.map +1 -0
  307. package/dist/enums/moduleDetectionKind.enum.d.ts +7 -0
  308. package/dist/enums/moduleDetectionKind.enum.d.ts.map +1 -0
  309. package/dist/enums/moduleDetectionKind.enum.js +9 -0
  310. package/dist/enums/moduleDetectionKind.enum.js.map +1 -0
  311. package/dist/enums/moduleDetectionKind.js +9 -0
  312. package/dist/enums/moduleDetectionKind.js.map +1 -0
  313. package/dist/enums/moduleKind.d.ts +2 -0
  314. package/dist/enums/moduleKind.d.ts.map +1 -0
  315. package/dist/enums/moduleKind.enum.d.ts +17 -0
  316. package/dist/enums/moduleKind.enum.d.ts.map +1 -0
  317. package/dist/enums/moduleKind.enum.js +19 -0
  318. package/dist/enums/moduleKind.enum.js.map +1 -0
  319. package/dist/enums/moduleKind.js +19 -0
  320. package/dist/enums/moduleKind.js.map +1 -0
  321. package/dist/enums/moduleResolutionKind.d.ts +2 -0
  322. package/dist/enums/moduleResolutionKind.d.ts.map +1 -0
  323. package/dist/enums/moduleResolutionKind.enum.d.ts +9 -0
  324. package/dist/enums/moduleResolutionKind.enum.d.ts.map +1 -0
  325. package/dist/enums/moduleResolutionKind.enum.js +11 -0
  326. package/dist/enums/moduleResolutionKind.enum.js.map +1 -0
  327. package/dist/enums/moduleResolutionKind.js +11 -0
  328. package/dist/enums/moduleResolutionKind.js.map +1 -0
  329. package/dist/enums/newLineKind.d.ts +2 -0
  330. package/dist/enums/newLineKind.d.ts.map +1 -0
  331. package/dist/enums/newLineKind.enum.d.ts +6 -0
  332. package/dist/enums/newLineKind.enum.d.ts.map +1 -0
  333. package/dist/enums/newLineKind.enum.js +8 -0
  334. package/dist/enums/newLineKind.enum.js.map +1 -0
  335. package/dist/enums/newLineKind.js +8 -0
  336. package/dist/enums/newLineKind.js.map +1 -0
  337. package/dist/enums/nodeBuilderFlags.d.ts +2 -0
  338. package/dist/enums/nodeBuilderFlags.d.ts.map +1 -0
  339. package/dist/enums/nodeBuilderFlags.enum.d.ts +36 -0
  340. package/dist/enums/nodeBuilderFlags.enum.d.ts.map +1 -0
  341. package/dist/enums/nodeBuilderFlags.enum.js +38 -0
  342. package/dist/enums/nodeBuilderFlags.enum.js.map +1 -0
  343. package/dist/enums/nodeBuilderFlags.js +38 -0
  344. package/dist/enums/nodeBuilderFlags.js.map +1 -0
  345. package/dist/enums/nodeFlags.d.ts +2 -0
  346. package/dist/enums/nodeFlags.d.ts.map +1 -0
  347. package/dist/enums/nodeFlags.enum.d.ts +44 -0
  348. package/dist/enums/nodeFlags.enum.d.ts.map +1 -0
  349. package/dist/enums/nodeFlags.enum.js +46 -0
  350. package/dist/enums/nodeFlags.enum.js.map +1 -0
  351. package/dist/enums/nodeFlags.js +46 -0
  352. package/dist/enums/nodeFlags.js.map +1 -0
  353. package/dist/enums/objectFlags.d.ts +2 -0
  354. package/dist/enums/objectFlags.d.ts.map +1 -0
  355. package/dist/enums/objectFlags.enum.d.ts +51 -0
  356. package/dist/enums/objectFlags.enum.d.ts.map +1 -0
  357. package/dist/enums/objectFlags.enum.js +53 -0
  358. package/dist/enums/objectFlags.enum.js.map +1 -0
  359. package/dist/enums/objectFlags.js +53 -0
  360. package/dist/enums/objectFlags.js.map +1 -0
  361. package/dist/enums/outerExpressionKinds.d.ts +2 -0
  362. package/dist/enums/outerExpressionKinds.d.ts.map +1 -0
  363. package/dist/enums/outerExpressionKinds.enum.d.ts +16 -0
  364. package/dist/enums/outerExpressionKinds.enum.d.ts.map +1 -0
  365. package/dist/enums/outerExpressionKinds.enum.js +18 -0
  366. package/dist/enums/outerExpressionKinds.enum.js.map +1 -0
  367. package/dist/enums/outerExpressionKinds.js +18 -0
  368. package/dist/enums/outerExpressionKinds.js.map +1 -0
  369. package/dist/enums/regularExpressionFlags.d.ts +2 -0
  370. package/dist/enums/regularExpressionFlags.d.ts.map +1 -0
  371. package/dist/enums/regularExpressionFlags.enum.d.ts +13 -0
  372. package/dist/enums/regularExpressionFlags.enum.d.ts.map +1 -0
  373. package/dist/enums/regularExpressionFlags.enum.js +14 -0
  374. package/dist/enums/regularExpressionFlags.enum.js.map +1 -0
  375. package/dist/enums/regularExpressionFlags.js +14 -0
  376. package/dist/enums/regularExpressionFlags.js.map +1 -0
  377. package/dist/enums/scriptKind.d.ts +2 -0
  378. package/dist/enums/scriptKind.d.ts.map +1 -0
  379. package/dist/enums/scriptKind.enum.d.ts +9 -0
  380. package/dist/enums/scriptKind.enum.d.ts.map +1 -0
  381. package/dist/enums/scriptKind.enum.js +11 -0
  382. package/dist/enums/scriptKind.enum.js.map +1 -0
  383. package/dist/enums/scriptKind.js +11 -0
  384. package/dist/enums/scriptKind.js.map +1 -0
  385. package/dist/enums/scriptTarget.d.ts +2 -0
  386. package/dist/enums/scriptTarget.d.ts.map +1 -0
  387. package/dist/enums/scriptTarget.enum.d.ts +18 -0
  388. package/dist/enums/scriptTarget.enum.d.ts.map +1 -0
  389. package/dist/enums/scriptTarget.enum.js +20 -0
  390. package/dist/enums/scriptTarget.enum.js.map +1 -0
  391. package/dist/enums/scriptTarget.js +20 -0
  392. package/dist/enums/scriptTarget.js.map +1 -0
  393. package/dist/enums/signatureFlags.d.ts +2 -0
  394. package/dist/enums/signatureFlags.d.ts.map +1 -0
  395. package/dist/enums/signatureFlags.enum.d.ts +15 -0
  396. package/dist/enums/signatureFlags.enum.d.ts.map +1 -0
  397. package/dist/enums/signatureFlags.enum.js +17 -0
  398. package/dist/enums/signatureFlags.enum.js.map +1 -0
  399. package/dist/enums/signatureFlags.js +17 -0
  400. package/dist/enums/signatureFlags.js.map +1 -0
  401. package/dist/enums/signatureKind.d.ts +2 -0
  402. package/dist/enums/signatureKind.d.ts.map +1 -0
  403. package/dist/enums/signatureKind.enum.d.ts +5 -0
  404. package/dist/enums/signatureKind.enum.d.ts.map +1 -0
  405. package/dist/enums/signatureKind.enum.js +7 -0
  406. package/dist/enums/signatureKind.enum.js.map +1 -0
  407. package/dist/enums/signatureKind.js +7 -0
  408. package/dist/enums/signatureKind.js.map +1 -0
  409. package/dist/enums/spanMapFeature.d.ts +2 -0
  410. package/dist/enums/spanMapFeature.d.ts.map +1 -0
  411. package/dist/enums/spanMapFeature.enum.d.ts +25 -0
  412. package/dist/enums/spanMapFeature.enum.d.ts.map +1 -0
  413. package/dist/enums/spanMapFeature.enum.js +27 -0
  414. package/dist/enums/spanMapFeature.enum.js.map +1 -0
  415. package/dist/enums/spanMapFeature.js +27 -0
  416. package/dist/enums/spanMapFeature.js.map +1 -0
  417. package/dist/enums/spanMapFidelity.d.ts +2 -0
  418. package/dist/enums/spanMapFidelity.d.ts.map +1 -0
  419. package/dist/enums/spanMapFidelity.enum.d.ts +7 -0
  420. package/dist/enums/spanMapFidelity.enum.d.ts.map +1 -0
  421. package/dist/enums/spanMapFidelity.enum.js +9 -0
  422. package/dist/enums/spanMapFidelity.enum.js.map +1 -0
  423. package/dist/enums/spanMapFidelity.js +9 -0
  424. package/dist/enums/spanMapFidelity.js.map +1 -0
  425. package/dist/enums/spanMapKind.d.ts +2 -0
  426. package/dist/enums/spanMapKind.d.ts.map +1 -0
  427. package/dist/enums/spanMapKind.enum.d.ts +6 -0
  428. package/dist/enums/spanMapKind.enum.d.ts.map +1 -0
  429. package/dist/enums/spanMapKind.enum.js +8 -0
  430. package/dist/enums/spanMapKind.enum.js.map +1 -0
  431. package/dist/enums/spanMapKind.js +8 -0
  432. package/dist/enums/spanMapKind.js.map +1 -0
  433. package/dist/enums/symbolFlags.d.ts +2 -0
  434. package/dist/enums/symbolFlags.d.ts.map +1 -0
  435. package/dist/enums/symbolFlags.enum.d.ts +70 -0
  436. package/dist/enums/symbolFlags.enum.d.ts.map +1 -0
  437. package/dist/enums/symbolFlags.enum.js +72 -0
  438. package/dist/enums/symbolFlags.enum.js.map +1 -0
  439. package/dist/enums/symbolFlags.js +72 -0
  440. package/dist/enums/symbolFlags.js.map +1 -0
  441. package/dist/enums/symbolOwnerKind.d.ts +2 -0
  442. package/dist/enums/symbolOwnerKind.d.ts.map +1 -0
  443. package/dist/enums/symbolOwnerKind.enum.d.ts +5 -0
  444. package/dist/enums/symbolOwnerKind.enum.d.ts.map +1 -0
  445. package/dist/enums/symbolOwnerKind.enum.js +7 -0
  446. package/dist/enums/symbolOwnerKind.enum.js.map +1 -0
  447. package/dist/enums/symbolOwnerKind.js +7 -0
  448. package/dist/enums/symbolOwnerKind.js.map +1 -0
  449. package/dist/enums/syntaxKind.d.ts +2 -0
  450. package/dist/enums/syntaxKind.d.ts.map +1 -0
  451. package/dist/enums/syntaxKind.enum.d.ts +390 -0
  452. package/dist/enums/syntaxKind.enum.d.ts.map +1 -0
  453. package/dist/enums/syntaxKind.enum.js +392 -0
  454. package/dist/enums/syntaxKind.enum.js.map +1 -0
  455. package/dist/enums/syntaxKind.js +392 -0
  456. package/dist/enums/syntaxKind.js.map +1 -0
  457. package/dist/enums/tokenFlags.d.ts +2 -0
  458. package/dist/enums/tokenFlags.d.ts.map +1 -0
  459. package/dist/enums/tokenFlags.enum.d.ts +30 -0
  460. package/dist/enums/tokenFlags.enum.d.ts.map +1 -0
  461. package/dist/enums/tokenFlags.enum.js +32 -0
  462. package/dist/enums/tokenFlags.enum.js.map +1 -0
  463. package/dist/enums/tokenFlags.js +32 -0
  464. package/dist/enums/tokenFlags.js.map +1 -0
  465. package/dist/enums/typeFlags.d.ts +2 -0
  466. package/dist/enums/typeFlags.d.ts.map +1 -0
  467. package/dist/enums/typeFlags.enum.d.ts +76 -0
  468. package/dist/enums/typeFlags.enum.d.ts.map +1 -0
  469. package/dist/enums/typeFlags.enum.js +78 -0
  470. package/dist/enums/typeFlags.enum.js.map +1 -0
  471. package/dist/enums/typeFlags.js +78 -0
  472. package/dist/enums/typeFlags.js.map +1 -0
  473. package/dist/enums/typeFormatFlags.d.ts +2 -0
  474. package/dist/enums/typeFormatFlags.d.ts.map +1 -0
  475. package/dist/enums/typeFormatFlags.enum.d.ts +29 -0
  476. package/dist/enums/typeFormatFlags.enum.d.ts.map +1 -0
  477. package/dist/enums/typeFormatFlags.enum.js +31 -0
  478. package/dist/enums/typeFormatFlags.enum.js.map +1 -0
  479. package/dist/enums/typeFormatFlags.js +31 -0
  480. package/dist/enums/typeFormatFlags.js.map +1 -0
  481. package/dist/enums/typePredicateKind.d.ts +2 -0
  482. package/dist/enums/typePredicateKind.d.ts.map +1 -0
  483. package/dist/enums/typePredicateKind.enum.d.ts +7 -0
  484. package/dist/enums/typePredicateKind.enum.d.ts.map +1 -0
  485. package/dist/enums/typePredicateKind.enum.js +9 -0
  486. package/dist/enums/typePredicateKind.enum.js.map +1 -0
  487. package/dist/enums/typePredicateKind.js +9 -0
  488. package/dist/enums/typePredicateKind.js.map +1 -0
  489. package/dist/internal/utils.d.ts +23 -0
  490. package/dist/internal/utils.d.ts.map +1 -0
  491. package/dist/internal/utils.js +25 -0
  492. package/dist/internal/utils.js.map +1 -0
  493. package/dist/vscode/extensionApi.d.ts +100 -0
  494. package/dist/vscode/extensionApi.d.ts.map +1 -0
  495. package/dist/vscode/extensionApi.js +2 -0
  496. package/dist/vscode/extensionApi.js.map +1 -0
  497. package/dist/vscode/moduleLoader.d.ts +14 -0
  498. package/dist/vscode/moduleLoader.d.ts.map +1 -0
  499. package/dist/vscode/moduleLoader.js +36 -0
  500. package/dist/vscode/moduleLoader.js.map +1 -0
  501. package/dist/vscode/protocol.generated.d.ts +2886 -0
  502. package/dist/vscode/protocol.generated.d.ts.map +1 -0
  503. package/dist/vscode/protocol.generated.js +4 -0
  504. package/dist/vscode/protocol.generated.js.map +1 -0
  505. package/lib/getExePath.d.ts +2 -0
  506. package/lib/getExePath.js +70 -0
  507. package/lib/install.js +108 -0
  508. package/lib/tsc.js +28 -0
  509. package/lib/version.cjs +5 -0
  510. package/lib/version.d.cts +2 -0
  511. package/package.json +79 -6
  512. package/schemas/jsconfig.schema.json +2207 -0
  513. package/schemas/tsconfig.schema.json +2206 -0
  514. package/vendor/vscode-jsonrpc/License.txt +11 -0
  515. package/vendor/vscode-jsonrpc/README.md +54 -0
  516. package/vendor/vscode-jsonrpc/lib/browser/main.d.ts +17 -0
  517. package/vendor/vscode-jsonrpc/lib/browser/main.js +83 -0
  518. package/vendor/vscode-jsonrpc/lib/browser/ril.d.ts +22 -0
  519. package/vendor/vscode-jsonrpc/lib/browser/ril.js +210 -0
  520. package/vendor/vscode-jsonrpc/lib/common/api.d.ts +14 -0
  521. package/vendor/vscode-jsonrpc/lib/common/api.js +87 -0
  522. package/vendor/vscode-jsonrpc/lib/common/cancellation.d.ts +32 -0
  523. package/vendor/vscode-jsonrpc/lib/common/cancellation.js +132 -0
  524. package/vendor/vscode-jsonrpc/lib/common/connection.d.ts +367 -0
  525. package/vendor/vscode-jsonrpc/lib/common/connection.js +1271 -0
  526. package/vendor/vscode-jsonrpc/lib/common/disposable.d.ts +9 -0
  527. package/vendor/vscode-jsonrpc/lib/common/disposable.js +16 -0
  528. package/vendor/vscode-jsonrpc/lib/common/encoding.d.ts +52 -0
  529. package/vendor/vscode-jsonrpc/lib/common/encoding.js +70 -0
  530. package/vendor/vscode-jsonrpc/lib/common/events.d.ts +39 -0
  531. package/vendor/vscode-jsonrpc/lib/common/events.js +135 -0
  532. package/vendor/vscode-jsonrpc/lib/common/is.d.ts +7 -0
  533. package/vendor/vscode-jsonrpc/lib/common/is.js +34 -0
  534. package/vendor/vscode-jsonrpc/lib/common/linkedMap.d.ts +55 -0
  535. package/vendor/vscode-jsonrpc/lib/common/linkedMap.js +412 -0
  536. package/vendor/vscode-jsonrpc/lib/common/messageBuffer.d.ts +18 -0
  537. package/vendor/vscode-jsonrpc/lib/common/messageBuffer.js +155 -0
  538. package/vendor/vscode-jsonrpc/lib/common/messageReader.d.ts +77 -0
  539. package/vendor/vscode-jsonrpc/lib/common/messageReader.js +246 -0
  540. package/vendor/vscode-jsonrpc/lib/common/messageWriter.d.ts +60 -0
  541. package/vendor/vscode-jsonrpc/lib/common/messageWriter.js +157 -0
  542. package/vendor/vscode-jsonrpc/lib/common/messages.d.ts +369 -0
  543. package/vendor/vscode-jsonrpc/lib/common/messages.js +436 -0
  544. package/vendor/vscode-jsonrpc/lib/common/ral.d.ts +74 -0
  545. package/vendor/vscode-jsonrpc/lib/common/ral.js +23 -0
  546. package/vendor/vscode-jsonrpc/lib/common/semaphore.d.ts +10 -0
  547. package/vendor/vscode-jsonrpc/lib/common/semaphore.js +74 -0
  548. package/vendor/vscode-jsonrpc/lib/common/sharedArrayCancellation.d.ts +15 -0
  549. package/vendor/vscode-jsonrpc/lib/common/sharedArrayCancellation.js +77 -0
  550. package/vendor/vscode-jsonrpc/lib/node/main.d.ts +58 -0
  551. package/vendor/vscode-jsonrpc/lib/node/main.js +289 -0
  552. package/vendor/vscode-jsonrpc/lib/node/ril.d.ts +12 -0
  553. package/vendor/vscode-jsonrpc/lib/node/ril.js +163 -0
  554. package/vendor/vscode-jsonrpc/package.json +54 -0
  555. package/vendor/vscode-jsonrpc/typings/thenable.d.ts +5 -0
@@ -0,0 +1,2886 @@
1
+ /**
2
+ * A special text edit with an additional change annotation.
3
+ *
4
+ * @since 3.16.0.
5
+ */
6
+ export interface AnnotatedTextEdit {
7
+ /**
8
+ * The range of the text document to be manipulated. To insert
9
+ * text into a document create a range where start === end.
10
+ */
11
+ range: Range;
12
+ /**
13
+ * The string to be inserted. For delete operations use an
14
+ * empty string.
15
+ */
16
+ newText: string;
17
+ /**
18
+ * The actual identifier of the change annotation
19
+ */
20
+ annotationId: ChangeAnnotationIdentifier;
21
+ }
22
+ /**
23
+ * Defines how values from a set of defaults and an individual item will be
24
+ * merged.
25
+ *
26
+ * @since 3.18.0
27
+ */
28
+ export type ApplyKind = 1 | 2;
29
+ /**
30
+ * Represents an incoming call, e.g. a caller of a method or constructor.
31
+ *
32
+ * @since 3.16.0
33
+ */
34
+ export interface CallHierarchyIncomingCall {
35
+ /**
36
+ * The item that makes the call.
37
+ */
38
+ from: CallHierarchyItem;
39
+ /**
40
+ * The ranges at which the calls appear. This is relative to the caller
41
+ * denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
42
+ */
43
+ fromRanges: Range[];
44
+ }
45
+ /**
46
+ * The parameter of a `callHierarchy/incomingCalls` request.
47
+ *
48
+ * @since 3.16.0
49
+ */
50
+ export interface CallHierarchyIncomingCallsParams {
51
+ /**
52
+ * An optional token that a server can use to report work done progress.
53
+ */
54
+ workDoneToken?: ProgressToken | undefined;
55
+ /**
56
+ * An optional token that a server can use to report partial results (e.g. streaming) to
57
+ * the client.
58
+ */
59
+ partialResultToken?: ProgressToken | undefined;
60
+ item: CallHierarchyItem;
61
+ }
62
+ /**
63
+ * Represents programming constructs like functions or constructors in the context
64
+ * of call hierarchy.
65
+ *
66
+ * @since 3.16.0
67
+ */
68
+ export interface CallHierarchyItem {
69
+ /**
70
+ * The name of this item.
71
+ */
72
+ name: string;
73
+ /**
74
+ * The kind of this item.
75
+ */
76
+ kind: SymbolKind;
77
+ /**
78
+ * Tags for this item.
79
+ */
80
+ tags?: SymbolTag[] | undefined;
81
+ /**
82
+ * More detail for this item, e.g. the signature of a function.
83
+ */
84
+ detail?: string | undefined;
85
+ /**
86
+ * The resource identifier of this item.
87
+ */
88
+ uri: DocumentUri;
89
+ /**
90
+ * The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
91
+ */
92
+ range: Range;
93
+ /**
94
+ * The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
95
+ * Must be contained by the {@link CallHierarchyItem.range `range`}.
96
+ */
97
+ selectionRange: Range;
98
+ /**
99
+ * A data entry field that is preserved between a call hierarchy prepare and
100
+ * incoming calls or outgoing calls requests.
101
+ */
102
+ data?: LSPAny | undefined;
103
+ }
104
+ /**
105
+ * Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
106
+ *
107
+ * @since 3.16.0
108
+ */
109
+ export interface CallHierarchyOutgoingCall {
110
+ /**
111
+ * The item that is called.
112
+ */
113
+ to: CallHierarchyItem;
114
+ /**
115
+ * The range at which this item is called. This is the range relative to the caller, e.g the item
116
+ * passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
117
+ * and not {@link CallHierarchyOutgoingCall.to `this.to`}.
118
+ */
119
+ fromRanges: Range[];
120
+ }
121
+ /**
122
+ * The parameter of a `callHierarchy/outgoingCalls` request.
123
+ *
124
+ * @since 3.16.0
125
+ */
126
+ export interface CallHierarchyOutgoingCallsParams {
127
+ /**
128
+ * An optional token that a server can use to report work done progress.
129
+ */
130
+ workDoneToken?: ProgressToken | undefined;
131
+ /**
132
+ * An optional token that a server can use to report partial results (e.g. streaming) to
133
+ * the client.
134
+ */
135
+ partialResultToken?: ProgressToken | undefined;
136
+ item: CallHierarchyItem;
137
+ }
138
+ /**
139
+ * The parameter of a `textDocument/prepareCallHierarchy` request.
140
+ *
141
+ * @since 3.16.0
142
+ */
143
+ export interface CallHierarchyPrepareParams {
144
+ /**
145
+ * The text document.
146
+ */
147
+ textDocument: TextDocumentIdentifier;
148
+ /**
149
+ * The position inside the text document.
150
+ */
151
+ position: Position;
152
+ /**
153
+ * An optional token that a server can use to report work done progress.
154
+ */
155
+ workDoneToken?: ProgressToken | undefined;
156
+ }
157
+ /**
158
+ * Additional information that describes document changes.
159
+ *
160
+ * @since 3.16.0
161
+ */
162
+ export interface ChangeAnnotation {
163
+ /**
164
+ * A human-readable string describing the actual change. The string
165
+ * is rendered prominent in the user interface.
166
+ */
167
+ label: string;
168
+ /**
169
+ * A flag which indicates that user confirmation is needed
170
+ * before applying the change.
171
+ */
172
+ needsConfirmation?: boolean | undefined;
173
+ /**
174
+ * A human-readable string which is rendered less prominent in
175
+ * the user interface.
176
+ */
177
+ description?: string | undefined;
178
+ }
179
+ /**
180
+ * An identifier to refer to a change annotation stored with a workspace edit.
181
+ */
182
+ export type ChangeAnnotationIdentifier = string;
183
+ /**
184
+ * A code action represents a change that can be performed in code, e.g. to fix a problem or
185
+ * to refactor code.
186
+ *
187
+ * A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
188
+ */
189
+ export interface CodeAction {
190
+ /**
191
+ * A short, human-readable, title for this code action.
192
+ */
193
+ title: string;
194
+ /**
195
+ * The kind of the code action.
196
+ *
197
+ * Used to filter code actions.
198
+ */
199
+ kind?: CodeActionKind | undefined;
200
+ /**
201
+ * The diagnostics that this code action resolves.
202
+ */
203
+ diagnostics?: Diagnostic[] | undefined;
204
+ /**
205
+ * Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
206
+ * by keybindings.
207
+ *
208
+ * A quick fix should be marked preferred if it properly addresses the underlying error.
209
+ * A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
210
+ *
211
+ * @since 3.15.0
212
+ */
213
+ isPreferred?: boolean | undefined;
214
+ /**
215
+ * Marks that the code action cannot currently be applied.
216
+ *
217
+ * Clients should follow the following guidelines regarding disabled code actions:
218
+ *
219
+ * - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
220
+ * code action menus.
221
+ *
222
+ * - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
223
+ * of code action, such as refactorings.
224
+ *
225
+ * - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
226
+ * that auto applies a code action and only disabled code actions are returned, the client should show the user an
227
+ * error message with `reason` in the editor.
228
+ *
229
+ * @since 3.16.0
230
+ */
231
+ disabled?: CodeActionDisabled | undefined;
232
+ /**
233
+ * The workspace edit this code action performs.
234
+ */
235
+ edit?: WorkspaceEdit | undefined;
236
+ /**
237
+ * A command this code action executes. If a code action
238
+ * provides an edit and a command, first the edit is
239
+ * executed and then the command.
240
+ */
241
+ command?: Command | undefined;
242
+ /**
243
+ * A data entry field that is preserved on a code action between
244
+ * a `textDocument/codeAction` and a `codeAction/resolve` request.
245
+ *
246
+ * @since 3.16.0
247
+ */
248
+ data?: LSPAny | undefined;
249
+ /**
250
+ * Tags for this code action.
251
+ *
252
+ * @since 3.18.0
253
+ */
254
+ tags?: CodeActionTag[] | undefined;
255
+ }
256
+ /**
257
+ * Contains additional diagnostic information about the context in which
258
+ * a {@link CodeActionProvider.provideCodeActions code action} is run.
259
+ */
260
+ export interface CodeActionContext {
261
+ /**
262
+ * An array of diagnostics known on the client side overlapping the range provided to the
263
+ * `textDocument/codeAction` request. They are provided so that the server knows which
264
+ * errors are currently presented to the user for the given range. There is no guarantee
265
+ * that these accurately reflect the error state of the resource. The primary parameter
266
+ * to compute code actions is the provided range.
267
+ */
268
+ diagnostics: Diagnostic[];
269
+ /**
270
+ * Requested kind of actions to return.
271
+ *
272
+ * Actions not of this kind are filtered out by the client before being shown. So servers
273
+ * can omit computing them.
274
+ */
275
+ only?: CodeActionKind[] | undefined;
276
+ /**
277
+ * The reason why code actions were requested.
278
+ *
279
+ * @since 3.17.0
280
+ */
281
+ triggerKind?: CodeActionTriggerKind | undefined;
282
+ }
283
+ /**
284
+ * Captures why the code action is currently disabled.
285
+ *
286
+ * @since 3.18.0
287
+ */
288
+ export interface CodeActionDisabled {
289
+ /**
290
+ * Human readable description of why the code action is currently disabled.
291
+ *
292
+ * This is displayed in the code actions UI.
293
+ */
294
+ reason: string;
295
+ }
296
+ /**
297
+ * A set of predefined code action kinds
298
+ */
299
+ export type CodeActionKind = "" | "quickfix" | "refactor" | "refactor.extract" | "refactor.inline" | "refactor.move" | "refactor.rewrite" | "source" | "source.organizeImports" | "source.fixAll" | "notebook" | string;
300
+ /**
301
+ * The parameters of a {@link CodeActionRequest}.
302
+ */
303
+ export interface CodeActionParams {
304
+ /**
305
+ * An optional token that a server can use to report work done progress.
306
+ */
307
+ workDoneToken?: ProgressToken | undefined;
308
+ /**
309
+ * An optional token that a server can use to report partial results (e.g. streaming) to
310
+ * the client.
311
+ */
312
+ partialResultToken?: ProgressToken | undefined;
313
+ /**
314
+ * The document in which the command was invoked.
315
+ */
316
+ textDocument: TextDocumentIdentifier;
317
+ /**
318
+ * The range for which the command was invoked.
319
+ */
320
+ range: Range;
321
+ /**
322
+ * Context carrying additional information.
323
+ */
324
+ context: CodeActionContext;
325
+ }
326
+ /**
327
+ * Code action tags are extra annotations that tweak the behavior of a code action.
328
+ *
329
+ * @since 3.18.0
330
+ */
331
+ export type CodeActionTag = 1;
332
+ /**
333
+ * The reason why code actions were requested.
334
+ *
335
+ * @since 3.17.0
336
+ */
337
+ export type CodeActionTriggerKind = 1 | 2;
338
+ /**
339
+ * Structure to capture a description for an error code.
340
+ *
341
+ * @since 3.16.0
342
+ */
343
+ export interface CodeDescription {
344
+ /**
345
+ * An URI to open with more information about the diagnostic error.
346
+ */
347
+ href: URI;
348
+ }
349
+ /**
350
+ * A code lens represents a {@link Command command} that should be shown along with
351
+ * source text, like the number of references, a way to run tests, etc.
352
+ *
353
+ * A code lens is _unresolved_ when no command is associated to it. For performance
354
+ * reasons the creation of a code lens and resolving should be done in two stages.
355
+ */
356
+ export interface CodeLens {
357
+ /**
358
+ * The range in which this code lens is valid. Should only span a single line.
359
+ */
360
+ range: Range;
361
+ /**
362
+ * The command this code lens represents.
363
+ */
364
+ command?: Command | undefined;
365
+ /**
366
+ * A data entry field that is preserved on a code lens item between
367
+ * a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
368
+ */
369
+ data?: LSPAny | undefined;
370
+ }
371
+ /**
372
+ * The parameters of a {@link CodeLensRequest}.
373
+ */
374
+ export interface CodeLensParams {
375
+ /**
376
+ * An optional token that a server can use to report work done progress.
377
+ */
378
+ workDoneToken?: ProgressToken | undefined;
379
+ /**
380
+ * An optional token that a server can use to report partial results (e.g. streaming) to
381
+ * the client.
382
+ */
383
+ partialResultToken?: ProgressToken | undefined;
384
+ /**
385
+ * The document to request code lens for.
386
+ */
387
+ textDocument: TextDocumentIdentifier;
388
+ }
389
+ /**
390
+ * Represents a reference to a command. Provides a title which
391
+ * will be used to represent a command in the UI and, optionally,
392
+ * an array of arguments which will be passed to the command handler
393
+ * function when invoked.
394
+ */
395
+ export interface Command {
396
+ /**
397
+ * Title of the command, like `save`.
398
+ */
399
+ title: string;
400
+ /**
401
+ * An optional tooltip.
402
+ *
403
+ * @since 3.18.0
404
+ */
405
+ tooltip?: string | undefined;
406
+ /**
407
+ * The identifier of the actual command handler.
408
+ */
409
+ command: string;
410
+ /**
411
+ * Arguments that the command handler should be
412
+ * invoked with.
413
+ */
414
+ arguments?: LSPAny[] | undefined;
415
+ }
416
+ /**
417
+ * Contains additional information about the context in which a completion request is triggered.
418
+ */
419
+ export interface CompletionContext {
420
+ /**
421
+ * How the completion was triggered.
422
+ */
423
+ triggerKind: CompletionTriggerKind;
424
+ /**
425
+ * The trigger character (a single character) that has trigger code complete.
426
+ * Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
427
+ */
428
+ triggerCharacter?: string | undefined;
429
+ }
430
+ /**
431
+ * A completion item represents a text snippet that is
432
+ * proposed to complete text that is being typed.
433
+ */
434
+ export interface CompletionItem {
435
+ /**
436
+ * The label of this completion item.
437
+ *
438
+ * The label property is also by default the text that
439
+ * is inserted when selecting this completion.
440
+ *
441
+ * If label details are provided the label itself should
442
+ * be an unqualified name of the completion item.
443
+ */
444
+ label: string;
445
+ /**
446
+ * Additional details for the label
447
+ *
448
+ * @since 3.17.0
449
+ */
450
+ labelDetails?: CompletionItemLabelDetails | undefined;
451
+ /**
452
+ * The kind of this completion item. Based of the kind
453
+ * an icon is chosen by the editor.
454
+ */
455
+ kind?: CompletionItemKind | undefined;
456
+ /**
457
+ * Tags for this completion item.
458
+ *
459
+ * @since 3.15.0
460
+ */
461
+ tags?: CompletionItemTag[] | undefined;
462
+ /**
463
+ * A human-readable string with additional information
464
+ * about this item, like type or symbol information.
465
+ */
466
+ detail?: string | undefined;
467
+ /**
468
+ * A human-readable string that represents a doc-comment.
469
+ */
470
+ documentation?: string | MarkupContent | undefined;
471
+ /**
472
+ * Indicates if this item is deprecated.
473
+ * @deprecated Use `tags` instead.
474
+ */
475
+ deprecated?: boolean | undefined;
476
+ /**
477
+ * Select this item when showing.
478
+ *
479
+ * *Note* that only one completion item can be selected and that the
480
+ * tool / client decides which item that is. The rule is that the *first*
481
+ * item of those that match best is selected.
482
+ */
483
+ preselect?: boolean | undefined;
484
+ /**
485
+ * A string that should be used when comparing this item
486
+ * with other items. When `falsy` the {@link CompletionItem.label label}
487
+ * is used.
488
+ */
489
+ sortText?: string | undefined;
490
+ /**
491
+ * A string that should be used when filtering a set of
492
+ * completion items. When `falsy` the {@link CompletionItem.label label}
493
+ * is used.
494
+ */
495
+ filterText?: string | undefined;
496
+ /**
497
+ * A string that should be inserted into a document when selecting
498
+ * this completion. When `falsy` the {@link CompletionItem.label label}
499
+ * is used.
500
+ *
501
+ * The `insertText` is subject to interpretation by the client side.
502
+ * Some tools might not take the string literally. For example
503
+ * VS Code when code complete is requested in this example
504
+ * `con<cursor position>` and a completion item with an `insertText` of
505
+ * `console` is provided it will only insert `sole`. Therefore it is
506
+ * recommended to use `textEdit` instead since it avoids additional client
507
+ * side interpretation.
508
+ */
509
+ insertText?: string | undefined;
510
+ /**
511
+ * The format of the insert text. The format applies to both the
512
+ * `insertText` property and the `newText` property of a provided
513
+ * `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
514
+ *
515
+ * Please note that the insertTextFormat doesn't apply to
516
+ * `additionalTextEdits`.
517
+ */
518
+ insertTextFormat?: InsertTextFormat | undefined;
519
+ /**
520
+ * How whitespace and indentation is handled during completion
521
+ * item insertion. If not provided the clients default value depends on
522
+ * the `textDocument.completion.insertTextMode` client capability.
523
+ *
524
+ * @since 3.16.0
525
+ */
526
+ insertTextMode?: InsertTextMode | undefined;
527
+ /**
528
+ * An {@link TextEdit edit} which is applied to a document when selecting
529
+ * this completion. When an edit is provided the value of
530
+ * {@link CompletionItem.insertText insertText} is ignored.
531
+ *
532
+ * Most editors support two different operations when accepting a completion
533
+ * item. One is to insert a completion text and the other is to replace an
534
+ * existing text with a completion text. Since this can usually not be
535
+ * predetermined by a server it can report both ranges. Clients need to
536
+ * signal support for `InsertReplaceEdits` via the
537
+ * `textDocument.completion.insertReplaceSupport` client capability
538
+ * property.
539
+ *
540
+ * *Note 1:* The text edit's range as well as both ranges from an insert
541
+ * replace edit must be a [single line] and they must contain the position
542
+ * at which completion has been requested.
543
+ * *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
544
+ * must be a prefix of the edit's replace range, that means it must be
545
+ * contained and starting at the same position.
546
+ *
547
+ * @since 3.16.0 additional type `InsertReplaceEdit`
548
+ */
549
+ textEdit?: TextEdit | InsertReplaceEdit | undefined;
550
+ /**
551
+ * The edit text used if the completion item is part of a CompletionList and
552
+ * CompletionList defines an item default for the text edit range.
553
+ *
554
+ * Clients will only honor this property if they opt into completion list
555
+ * item defaults using the capability `completionList.itemDefaults`.
556
+ *
557
+ * If not provided and a list's default range is provided the label
558
+ * property is used as a text.
559
+ *
560
+ * @since 3.17.0
561
+ */
562
+ textEditText?: string | undefined;
563
+ /**
564
+ * An optional array of additional {@link TextEdit text edits} that are applied when
565
+ * selecting this completion. Edits must not overlap (including the same insert position)
566
+ * with the main {@link CompletionItem.textEdit edit} nor with themselves.
567
+ *
568
+ * Additional text edits should be used to change text unrelated to the current cursor position
569
+ * (for example adding an import statement at the top of the file if the completion item will
570
+ * insert an unqualified type).
571
+ */
572
+ additionalTextEdits?: TextEdit[] | undefined;
573
+ /**
574
+ * An optional set of characters that when pressed while this completion is active will accept it first and
575
+ * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
576
+ * characters will be ignored.
577
+ */
578
+ commitCharacters?: string[] | undefined;
579
+ /**
580
+ * An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
581
+ * additional modifications to the current document should be described with the
582
+ * {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
583
+ */
584
+ command?: Command | undefined;
585
+ /**
586
+ * A data entry field that is preserved on a completion item between a
587
+ * {@link CompletionRequest} and a {@link CompletionResolveRequest}.
588
+ */
589
+ data?: LSPAny | undefined;
590
+ }
591
+ /**
592
+ * Specifies how fields from a completion item should be combined with those
593
+ * from `completionList.itemDefaults`.
594
+ *
595
+ * If unspecified, all fields will be treated as ApplyKind.Replace.
596
+ *
597
+ * If a field's value is ApplyKind.Replace, the value from a completion item (if
598
+ * provided and not `null`) will always be used instead of the value from
599
+ * `completionItem.itemDefaults`.
600
+ *
601
+ * If a field's value is ApplyKind.Merge, the values will be merged using the rules
602
+ * defined against each field below.
603
+ *
604
+ * Servers are only allowed to return `applyKind` if the client
605
+ * signals support for this via the `completionList.applyKindSupport`
606
+ * capability.
607
+ *
608
+ * @since 3.18.0
609
+ */
610
+ export interface CompletionItemApplyKinds {
611
+ /**
612
+ * Specifies whether commitCharacters on a completion will replace or be
613
+ * merged with those in `completionList.itemDefaults.commitCharacters`.
614
+ *
615
+ * If ApplyKind.Replace, the commit characters from the completion item will
616
+ * always be used unless not provided, in which case those from
617
+ * `completionList.itemDefaults.commitCharacters` will be used. An
618
+ * empty list can be used if a completion item does not have any commit
619
+ * characters and also should not use those from
620
+ * `completionList.itemDefaults.commitCharacters`.
621
+ *
622
+ * If ApplyKind.Merge the commitCharacters for the completion will be the
623
+ * union of all values in both `completionList.itemDefaults.commitCharacters`
624
+ * and the completion's own `commitCharacters`.
625
+ *
626
+ * @since 3.18.0
627
+ */
628
+ commitCharacters?: ApplyKind | undefined;
629
+ /**
630
+ * Specifies whether the `data` field on a completion will replace or
631
+ * be merged with data from `completionList.itemDefaults.data`.
632
+ *
633
+ * If ApplyKind.Replace, the data from the completion item will be used if
634
+ * provided (and not `null`), otherwise
635
+ * `completionList.itemDefaults.data` will be used. An empty object can
636
+ * be used if a completion item does not have any data but also should
637
+ * not use the value from `completionList.itemDefaults.data`.
638
+ *
639
+ * If ApplyKind.Merge, a shallow merge will be performed between
640
+ * `completionList.itemDefaults.data` and the completion's own data
641
+ * using the following rules:
642
+ *
643
+ * - If a completion's `data` field is not provided (or `null`), the
644
+ * entire `data` field from `completionList.itemDefaults.data` will be
645
+ * used as-is.
646
+ * - If a completion's `data` field is provided, each field will
647
+ * overwrite the field of the same name in
648
+ * `completionList.itemDefaults.data` but no merging of nested fields
649
+ * within that value will occur.
650
+ *
651
+ * @since 3.18.0
652
+ */
653
+ data?: ApplyKind | undefined;
654
+ }
655
+ /**
656
+ * In many cases the items of an actual completion result share the same
657
+ * value for properties like `commitCharacters` or the range of a text
658
+ * edit. A completion list can therefore define item defaults which will
659
+ * be used if a completion item itself doesn't specify the value.
660
+ *
661
+ * If a completion list specifies a default value and a completion item
662
+ * also specifies a corresponding value, the rules for combining these are
663
+ * defined by `applyKinds` (if the client supports it), defaulting to
664
+ * ApplyKind.Replace.
665
+ *
666
+ * Servers are only allowed to return default values if the client
667
+ * signals support for this via the `completionList.itemDefaults`
668
+ * capability.
669
+ *
670
+ * @since 3.17.0
671
+ */
672
+ export interface CompletionItemDefaults {
673
+ /**
674
+ * A default commit character set.
675
+ *
676
+ * @since 3.17.0
677
+ */
678
+ commitCharacters?: string[] | undefined;
679
+ /**
680
+ * A default edit range.
681
+ *
682
+ * @since 3.17.0
683
+ */
684
+ editRange?: Range | EditRangeWithInsertReplace | undefined;
685
+ /**
686
+ * A default insert text format.
687
+ *
688
+ * @since 3.17.0
689
+ */
690
+ insertTextFormat?: InsertTextFormat | undefined;
691
+ /**
692
+ * A default insert text mode.
693
+ *
694
+ * @since 3.17.0
695
+ */
696
+ insertTextMode?: InsertTextMode | undefined;
697
+ /**
698
+ * A default data value.
699
+ *
700
+ * @since 3.17.0
701
+ */
702
+ data?: LSPAny | undefined;
703
+ }
704
+ /**
705
+ * The kind of a completion entry.
706
+ */
707
+ export type CompletionItemKind = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25;
708
+ /**
709
+ * Additional details for a completion item label.
710
+ *
711
+ * @since 3.17.0
712
+ */
713
+ export interface CompletionItemLabelDetails {
714
+ /**
715
+ * An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
716
+ * without any spacing. Should be used for function signatures and type annotations.
717
+ */
718
+ detail?: string | undefined;
719
+ /**
720
+ * An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
721
+ * for fully qualified names and file paths.
722
+ */
723
+ description?: string | undefined;
724
+ }
725
+ /**
726
+ * Completion item tags are extra annotations that tweak the rendering of a completion
727
+ * item.
728
+ *
729
+ * @since 3.15.0
730
+ */
731
+ export type CompletionItemTag = 1;
732
+ /**
733
+ * Represents a collection of {@link CompletionItem completion items} to be presented
734
+ * in the editor.
735
+ */
736
+ export interface CompletionList {
737
+ /**
738
+ * This list it not complete. Further typing results in recomputing this list.
739
+ *
740
+ * Recomputed lists have all their items replaced (not appended) in the
741
+ * incomplete completion sessions.
742
+ */
743
+ isIncomplete: boolean;
744
+ /**
745
+ * In many cases the items of an actual completion result share the same
746
+ * value for properties like `commitCharacters` or the range of a text
747
+ * edit. A completion list can therefore define item defaults which will
748
+ * be used if a completion item itself doesn't specify the value.
749
+ *
750
+ * If a completion list specifies a default value and a completion item
751
+ * also specifies a corresponding value, the rules for combining these are
752
+ * defined by `applyKinds` (if the client supports it), defaulting to
753
+ * ApplyKind.Replace.
754
+ *
755
+ * Servers are only allowed to return default values if the client
756
+ * signals support for this via the `completionList.itemDefaults`
757
+ * capability.
758
+ *
759
+ * @since 3.17.0
760
+ */
761
+ itemDefaults?: CompletionItemDefaults | undefined;
762
+ /**
763
+ * Specifies how fields from a completion item should be combined with those
764
+ * from `completionList.itemDefaults`.
765
+ *
766
+ * If unspecified, all fields will be treated as ApplyKind.Replace.
767
+ *
768
+ * If a field's value is ApplyKind.Replace, the value from a completion item
769
+ * (if provided and not `null`) will always be used instead of the value
770
+ * from `completionItem.itemDefaults`.
771
+ *
772
+ * If a field's value is ApplyKind.Merge, the values will be merged using
773
+ * the rules defined against each field below.
774
+ *
775
+ * Servers are only allowed to return `applyKind` if the client
776
+ * signals support for this via the `completionList.applyKindSupport`
777
+ * capability.
778
+ *
779
+ * @since 3.18.0
780
+ */
781
+ applyKind?: CompletionItemApplyKinds | undefined;
782
+ /**
783
+ * The completion items.
784
+ */
785
+ items: CompletionItem[];
786
+ }
787
+ /**
788
+ * Completion parameters
789
+ */
790
+ export interface CompletionParams {
791
+ /**
792
+ * The text document.
793
+ */
794
+ textDocument: TextDocumentIdentifier;
795
+ /**
796
+ * The position inside the text document.
797
+ */
798
+ position: Position;
799
+ /**
800
+ * An optional token that a server can use to report work done progress.
801
+ */
802
+ workDoneToken?: ProgressToken | undefined;
803
+ /**
804
+ * An optional token that a server can use to report partial results (e.g. streaming) to
805
+ * the client.
806
+ */
807
+ partialResultToken?: ProgressToken | undefined;
808
+ /**
809
+ * The completion context. This is only available it the client specifies
810
+ * to send this using the client capability `textDocument.completion.contextSupport === true`
811
+ */
812
+ context?: CompletionContext | undefined;
813
+ }
814
+ /**
815
+ * How a completion was triggered
816
+ */
817
+ export type CompletionTriggerKind = 1 | 2 | 3;
818
+ /**
819
+ * Create file operation.
820
+ */
821
+ export interface CreateFile {
822
+ /**
823
+ * A create
824
+ */
825
+ kind: "create";
826
+ /**
827
+ * An optional annotation identifier describing the operation.
828
+ *
829
+ * @since 3.16.0
830
+ */
831
+ annotationId?: ChangeAnnotationIdentifier | undefined;
832
+ /**
833
+ * The resource to create.
834
+ */
835
+ uri: DocumentUri;
836
+ /**
837
+ * Additional options
838
+ */
839
+ options?: CreateFileOptions | undefined;
840
+ }
841
+ /**
842
+ * Options to create a file.
843
+ */
844
+ export interface CreateFileOptions {
845
+ /**
846
+ * Overwrite existing file. Overwrite wins over `ignoreIfExists`
847
+ */
848
+ overwrite?: boolean | undefined;
849
+ /**
850
+ * Ignore if exists.
851
+ */
852
+ ignoreIfExists?: boolean | undefined;
853
+ }
854
+ /**
855
+ * The definition of a symbol represented as one or many {@link Location locations}.
856
+ * For most programming languages there is only one location at which a symbol is
857
+ * defined.
858
+ *
859
+ * Servers should prefer returning `DefinitionLink` over `Definition` if supported
860
+ * by the client.
861
+ */
862
+ export type Definition = Location | Location[];
863
+ /**
864
+ * Information about where a symbol is defined.
865
+ *
866
+ * Provides additional metadata over normal {@link Location location} definitions, including the range of
867
+ * the defining symbol
868
+ */
869
+ export type DefinitionLink = LocationLink;
870
+ /**
871
+ * Parameters for a {@link DefinitionRequest}.
872
+ */
873
+ export interface DefinitionParams {
874
+ /**
875
+ * The text document.
876
+ */
877
+ textDocument: TextDocumentIdentifier;
878
+ /**
879
+ * The position inside the text document.
880
+ */
881
+ position: Position;
882
+ /**
883
+ * An optional token that a server can use to report work done progress.
884
+ */
885
+ workDoneToken?: ProgressToken | undefined;
886
+ /**
887
+ * An optional token that a server can use to report partial results (e.g. streaming) to
888
+ * the client.
889
+ */
890
+ partialResultToken?: ProgressToken | undefined;
891
+ }
892
+ /**
893
+ * Delete file operation
894
+ */
895
+ export interface DeleteFile {
896
+ /**
897
+ * A delete
898
+ */
899
+ kind: "delete";
900
+ /**
901
+ * An optional annotation identifier describing the operation.
902
+ *
903
+ * @since 3.16.0
904
+ */
905
+ annotationId?: ChangeAnnotationIdentifier | undefined;
906
+ /**
907
+ * The file to delete.
908
+ */
909
+ uri: DocumentUri;
910
+ /**
911
+ * Delete options.
912
+ */
913
+ options?: DeleteFileOptions | undefined;
914
+ }
915
+ /**
916
+ * Delete file options
917
+ */
918
+ export interface DeleteFileOptions {
919
+ /**
920
+ * Delete the content recursively if a folder is denoted.
921
+ */
922
+ recursive?: boolean | undefined;
923
+ /**
924
+ * Ignore the operation if the file doesn't exist.
925
+ */
926
+ ignoreIfNotExists?: boolean | undefined;
927
+ }
928
+ /**
929
+ * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
930
+ * are only valid in the scope of a resource.
931
+ */
932
+ export interface Diagnostic {
933
+ /**
934
+ * The range at which the message applies
935
+ */
936
+ range: Range;
937
+ /**
938
+ * The diagnostic's severity. To avoid interpretation mismatches when a
939
+ * server is used with different clients it is highly recommended that servers
940
+ * always provide a severity value.
941
+ */
942
+ severity?: DiagnosticSeverity | undefined;
943
+ /**
944
+ * The diagnostic's code, which usually appear in the user interface.
945
+ */
946
+ code?: number | string | undefined;
947
+ /**
948
+ * An optional property to describe the error code.
949
+ * Requires the code field (above) to be present/not null.
950
+ *
951
+ * @since 3.16.0
952
+ */
953
+ codeDescription?: CodeDescription | undefined;
954
+ /**
955
+ * A human-readable string describing the source of this
956
+ * diagnostic, e.g. 'typescript' or 'super lint'. It usually
957
+ * appears in the user interface.
958
+ */
959
+ source?: string | undefined;
960
+ /**
961
+ * The diagnostic's message. It usually appears in the user interface.
962
+ *
963
+ * @since 3.18.0 - support for MarkupContent. This is guarded by the client
964
+ * capability `textDocument.diagnostic.markupMessageSupport`.
965
+ */
966
+ message: string | MarkupContent;
967
+ /**
968
+ * Additional metadata about the diagnostic.
969
+ *
970
+ * @since 3.15.0
971
+ */
972
+ tags?: DiagnosticTag[] | undefined;
973
+ /**
974
+ * An array of related diagnostic information, e.g. when symbol-names within
975
+ * a scope collide all definitions can be marked via this property.
976
+ */
977
+ relatedInformation?: DiagnosticRelatedInformation[] | undefined;
978
+ /**
979
+ * A data entry field that is preserved between a `textDocument/publishDiagnostics`
980
+ * notification and `textDocument/codeAction` request.
981
+ *
982
+ * @since 3.16.0
983
+ */
984
+ data?: LSPAny | undefined;
985
+ }
986
+ /**
987
+ * Represents a related message and source code location for a diagnostic. This should be
988
+ * used to point to code locations that cause or related to a diagnostics, e.g when duplicating
989
+ * a symbol in a scope.
990
+ */
991
+ export interface DiagnosticRelatedInformation {
992
+ /**
993
+ * The location of this related diagnostic information.
994
+ */
995
+ location: Location;
996
+ /**
997
+ * The message of this related diagnostic information.
998
+ */
999
+ message: string;
1000
+ }
1001
+ /**
1002
+ * The diagnostic's severity.
1003
+ */
1004
+ export type DiagnosticSeverity = 1 | 2 | 3 | 4;
1005
+ /**
1006
+ * The diagnostic tags.
1007
+ *
1008
+ * @since 3.15.0
1009
+ */
1010
+ export type DiagnosticTag = 1 | 2;
1011
+ /**
1012
+ * Parameters of the document diagnostic request.
1013
+ *
1014
+ * @since 3.17.0
1015
+ */
1016
+ export interface DocumentDiagnosticParams {
1017
+ /**
1018
+ * An optional token that a server can use to report work done progress.
1019
+ */
1020
+ workDoneToken?: ProgressToken | undefined;
1021
+ /**
1022
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1023
+ * the client.
1024
+ */
1025
+ partialResultToken?: ProgressToken | undefined;
1026
+ /**
1027
+ * The text document.
1028
+ */
1029
+ textDocument: TextDocumentIdentifier;
1030
+ /**
1031
+ * The additional identifier provided during registration.
1032
+ */
1033
+ identifier?: string | undefined;
1034
+ /**
1035
+ * The result id of a previous response if provided.
1036
+ */
1037
+ previousResultId?: string | undefined;
1038
+ }
1039
+ /**
1040
+ * The result of a document diagnostic pull request. A report can
1041
+ * either be a full report containing all diagnostics for the
1042
+ * requested document or an unchanged report indicating that nothing
1043
+ * has changed in terms of diagnostics in comparison to the last
1044
+ * pull request.
1045
+ *
1046
+ * @since 3.17.0
1047
+ */
1048
+ export type DocumentDiagnosticReport = RelatedFullDocumentDiagnosticReport | RelatedUnchangedDocumentDiagnosticReport;
1049
+ /**
1050
+ * The parameters of a {@link DocumentFormattingRequest}.
1051
+ */
1052
+ export interface DocumentFormattingParams {
1053
+ /**
1054
+ * An optional token that a server can use to report work done progress.
1055
+ */
1056
+ workDoneToken?: ProgressToken | undefined;
1057
+ /**
1058
+ * The document to format.
1059
+ */
1060
+ textDocument: TextDocumentIdentifier;
1061
+ /**
1062
+ * The format options.
1063
+ */
1064
+ options: FormattingOptions;
1065
+ }
1066
+ /**
1067
+ * A document highlight is a range inside a text document which deserves
1068
+ * special attention. Usually a document highlight is visualized by changing
1069
+ * the background color of its range.
1070
+ */
1071
+ export interface DocumentHighlight {
1072
+ /**
1073
+ * The range this highlight applies to.
1074
+ */
1075
+ range: Range;
1076
+ /**
1077
+ * The highlight kind, default is {@link DocumentHighlightKind.Text text}.
1078
+ */
1079
+ kind?: DocumentHighlightKind | undefined;
1080
+ }
1081
+ /**
1082
+ * A document highlight kind.
1083
+ */
1084
+ export type DocumentHighlightKind = 1 | 2 | 3;
1085
+ /**
1086
+ * Parameters for a {@link DocumentHighlightRequest}.
1087
+ */
1088
+ export interface DocumentHighlightParams {
1089
+ /**
1090
+ * The text document.
1091
+ */
1092
+ textDocument: TextDocumentIdentifier;
1093
+ /**
1094
+ * The position inside the text document.
1095
+ */
1096
+ position: Position;
1097
+ /**
1098
+ * An optional token that a server can use to report work done progress.
1099
+ */
1100
+ workDoneToken?: ProgressToken | undefined;
1101
+ /**
1102
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1103
+ * the client.
1104
+ */
1105
+ partialResultToken?: ProgressToken | undefined;
1106
+ }
1107
+ /**
1108
+ * The parameters of a {@link DocumentOnTypeFormattingRequest}.
1109
+ */
1110
+ export interface DocumentOnTypeFormattingParams {
1111
+ /**
1112
+ * The document to format.
1113
+ */
1114
+ textDocument: TextDocumentIdentifier;
1115
+ /**
1116
+ * The position around which the on type formatting should happen.
1117
+ * This is not necessarily the exact position where the character denoted
1118
+ * by the property `ch` got typed.
1119
+ */
1120
+ position: Position;
1121
+ /**
1122
+ * The character that has been typed that triggered the formatting
1123
+ * on type request. That is not necessarily the last character that
1124
+ * got inserted into the document since the client could auto insert
1125
+ * characters as well (e.g. like automatic brace completion).
1126
+ */
1127
+ ch: string;
1128
+ /**
1129
+ * The formatting options.
1130
+ */
1131
+ options: FormattingOptions;
1132
+ }
1133
+ /**
1134
+ * The parameters of a {@link DocumentRangeFormattingRequest}.
1135
+ */
1136
+ export interface DocumentRangeFormattingParams {
1137
+ /**
1138
+ * An optional token that a server can use to report work done progress.
1139
+ */
1140
+ workDoneToken?: ProgressToken | undefined;
1141
+ /**
1142
+ * The document to format.
1143
+ */
1144
+ textDocument: TextDocumentIdentifier;
1145
+ /**
1146
+ * The range to format
1147
+ */
1148
+ range: Range;
1149
+ /**
1150
+ * The format options
1151
+ */
1152
+ options: FormattingOptions;
1153
+ }
1154
+ /**
1155
+ * Represents programming constructs like variables, classes, interfaces etc.
1156
+ * that appear in a document. Document symbols can be hierarchical and they
1157
+ * have two ranges: one that encloses its definition and one that points to
1158
+ * its most interesting range, e.g. the range of an identifier.
1159
+ */
1160
+ export interface DocumentSymbol {
1161
+ /**
1162
+ * The name of this symbol. Will be displayed in the user interface and therefore must not be
1163
+ * an empty string or a string only consisting of white spaces.
1164
+ */
1165
+ name: string;
1166
+ /**
1167
+ * More detail for this symbol, e.g the signature of a function.
1168
+ */
1169
+ detail?: string | undefined;
1170
+ /**
1171
+ * The kind of this symbol.
1172
+ */
1173
+ kind: SymbolKind;
1174
+ /**
1175
+ * Tags for this document symbol.
1176
+ *
1177
+ * @since 3.16.0
1178
+ */
1179
+ tags?: SymbolTag[] | undefined;
1180
+ /**
1181
+ * Indicates if this symbol is deprecated.
1182
+ *
1183
+ * @deprecated Use tags instead
1184
+ */
1185
+ deprecated?: boolean | undefined;
1186
+ /**
1187
+ * The range enclosing this symbol not including leading/trailing whitespace but everything else
1188
+ * like comments. This information is typically used to determine if the clients cursor is
1189
+ * inside the symbol to reveal in the symbol in the UI.
1190
+ */
1191
+ range: Range;
1192
+ /**
1193
+ * The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
1194
+ * Must be contained by the `range`.
1195
+ */
1196
+ selectionRange: Range;
1197
+ /**
1198
+ * Children of this symbol, e.g. properties of a class.
1199
+ */
1200
+ children?: DocumentSymbol[] | undefined;
1201
+ }
1202
+ /**
1203
+ * Parameters for a {@link DocumentSymbolRequest}.
1204
+ */
1205
+ export interface DocumentSymbolParams {
1206
+ /**
1207
+ * An optional token that a server can use to report work done progress.
1208
+ */
1209
+ workDoneToken?: ProgressToken | undefined;
1210
+ /**
1211
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1212
+ * the client.
1213
+ */
1214
+ partialResultToken?: ProgressToken | undefined;
1215
+ /**
1216
+ * The text document.
1217
+ */
1218
+ textDocument: TextDocumentIdentifier;
1219
+ }
1220
+ export type DocumentUri = string;
1221
+ /**
1222
+ * Edit range variant that includes ranges for insert and replace operations.
1223
+ *
1224
+ * @since 3.18.0
1225
+ */
1226
+ export interface EditRangeWithInsertReplace {
1227
+ insert: Range;
1228
+ replace: Range;
1229
+ }
1230
+ /**
1231
+ * Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
1232
+ * than the number of lines in the document. Clients are free to ignore invalid ranges.
1233
+ */
1234
+ export interface FoldingRange {
1235
+ /**
1236
+ * The zero-based start line of the range to fold. The folded area starts after the line's last character.
1237
+ * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
1238
+ */
1239
+ startLine: number;
1240
+ /**
1241
+ * The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
1242
+ */
1243
+ startCharacter?: number | undefined;
1244
+ /**
1245
+ * The zero-based end line of the range to fold. The folded area ends with the line's last character.
1246
+ * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
1247
+ */
1248
+ endLine: number;
1249
+ /**
1250
+ * The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
1251
+ */
1252
+ endCharacter?: number | undefined;
1253
+ /**
1254
+ * Describes the kind of the folding range such as 'comment' or 'region'. The kind
1255
+ * is used to categorize folding ranges and used by commands like 'Fold all comments'.
1256
+ * See {@link FoldingRangeKind} for an enumeration of standardized kinds.
1257
+ */
1258
+ kind?: FoldingRangeKind | undefined;
1259
+ /**
1260
+ * The text that the client should show when the specified range is
1261
+ * collapsed. If not defined or not supported by the client, a default
1262
+ * will be chosen by the client.
1263
+ *
1264
+ * @since 3.17.0
1265
+ */
1266
+ collapsedText?: string | undefined;
1267
+ }
1268
+ /**
1269
+ * A set of predefined range kinds.
1270
+ */
1271
+ export type FoldingRangeKind = "comment" | "imports" | "region" | string;
1272
+ /**
1273
+ * Parameters for a {@link FoldingRangeRequest}.
1274
+ */
1275
+ export interface FoldingRangeParams {
1276
+ /**
1277
+ * An optional token that a server can use to report work done progress.
1278
+ */
1279
+ workDoneToken?: ProgressToken | undefined;
1280
+ /**
1281
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1282
+ * the client.
1283
+ */
1284
+ partialResultToken?: ProgressToken | undefined;
1285
+ /**
1286
+ * The text document.
1287
+ */
1288
+ textDocument: TextDocumentIdentifier;
1289
+ }
1290
+ /**
1291
+ * Value-object describing what options formatting should use.
1292
+ */
1293
+ export interface FormattingOptions {
1294
+ /**
1295
+ * Size of a tab in spaces.
1296
+ */
1297
+ tabSize: number;
1298
+ /**
1299
+ * Prefer spaces over tabs.
1300
+ */
1301
+ insertSpaces: boolean;
1302
+ /**
1303
+ * Trim trailing whitespace on a line.
1304
+ *
1305
+ * @since 3.15.0
1306
+ */
1307
+ trimTrailingWhitespace?: boolean | undefined;
1308
+ /**
1309
+ * Insert a newline character at the end of the file if one does not exist.
1310
+ *
1311
+ * @since 3.15.0
1312
+ */
1313
+ insertFinalNewline?: boolean | undefined;
1314
+ /**
1315
+ * Trim all newlines after the final newline at the end of the file.
1316
+ *
1317
+ * @since 3.15.0
1318
+ */
1319
+ trimFinalNewlines?: boolean | undefined;
1320
+ [key: string]: boolean | number | string | undefined;
1321
+ }
1322
+ /**
1323
+ * A diagnostic report with a full set of problems.
1324
+ *
1325
+ * @since 3.17.0
1326
+ */
1327
+ export interface FullDocumentDiagnosticReport {
1328
+ /**
1329
+ * A full document diagnostic report.
1330
+ */
1331
+ kind: "full";
1332
+ /**
1333
+ * An optional result id. If provided it will
1334
+ * be sent on the next diagnostic request for the
1335
+ * same document.
1336
+ */
1337
+ resultId?: string | undefined;
1338
+ /**
1339
+ * The actual items.
1340
+ */
1341
+ items: Diagnostic[];
1342
+ }
1343
+ /**
1344
+ * The result of a hover request.
1345
+ */
1346
+ export interface Hover {
1347
+ /**
1348
+ * The hover's content
1349
+ */
1350
+ contents: MarkupContent | MarkedString | MarkedString[];
1351
+ /**
1352
+ * An optional range inside the text document that is used to
1353
+ * visualize the hover, e.g. by changing the background color.
1354
+ */
1355
+ range?: Range | undefined;
1356
+ /**
1357
+ * Whether the verbosity level can be increased for this hover.
1358
+ */
1359
+ canIncreaseVerbosity?: boolean | undefined;
1360
+ /**
1361
+ * VS-specific rich content (symbol icon + colorized/classified text) rendered by clients that support Visual Studio extensions, in place of `contents`.
1362
+ */
1363
+ _vs_rawContent?: VSContainerElement | undefined;
1364
+ }
1365
+ /**
1366
+ * Parameters for a {@link HoverRequest}.
1367
+ */
1368
+ export interface HoverParams {
1369
+ /**
1370
+ * The text document.
1371
+ */
1372
+ textDocument: TextDocumentIdentifier;
1373
+ /**
1374
+ * The position inside the text document.
1375
+ */
1376
+ position: Position;
1377
+ /**
1378
+ * An optional token that a server can use to report work done progress.
1379
+ */
1380
+ workDoneToken?: ProgressToken | undefined;
1381
+ /**
1382
+ * Controls how many levels of type definitions will be expanded. Default is 0.
1383
+ */
1384
+ verbosityLevel?: number | undefined;
1385
+ }
1386
+ export interface ImplementationParams {
1387
+ /**
1388
+ * The text document.
1389
+ */
1390
+ textDocument: TextDocumentIdentifier;
1391
+ /**
1392
+ * The position inside the text document.
1393
+ */
1394
+ position: Position;
1395
+ /**
1396
+ * An optional token that a server can use to report work done progress.
1397
+ */
1398
+ workDoneToken?: ProgressToken | undefined;
1399
+ /**
1400
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1401
+ * the client.
1402
+ */
1403
+ partialResultToken?: ProgressToken | undefined;
1404
+ }
1405
+ /**
1406
+ * Inlay hint information.
1407
+ *
1408
+ * @since 3.17.0
1409
+ */
1410
+ export interface InlayHint {
1411
+ /**
1412
+ * The position of this hint.
1413
+ *
1414
+ * If multiple hints have the same position, they will be shown in the order
1415
+ * they appear in the response.
1416
+ */
1417
+ position: Position;
1418
+ /**
1419
+ * The label of this hint. A human readable string or an array of
1420
+ * InlayHintLabelPart label parts.
1421
+ *
1422
+ * *Note* that neither the string nor the label part can be empty.
1423
+ */
1424
+ label: string | InlayHintLabelPart[];
1425
+ /**
1426
+ * The kind of this hint. Can be omitted in which case the client
1427
+ * should fall back to a reasonable default.
1428
+ */
1429
+ kind?: InlayHintKind | undefined;
1430
+ /**
1431
+ * Optional text edits that are performed when accepting this inlay hint.
1432
+ *
1433
+ * *Note* that edits are expected to change the document so that the inlay
1434
+ * hint (or its nearest variant) is now part of the document and the inlay
1435
+ * hint itself is now obsolete.
1436
+ */
1437
+ textEdits?: TextEdit[] | undefined;
1438
+ /**
1439
+ * The tooltip text when you hover over this item.
1440
+ */
1441
+ tooltip?: string | MarkupContent | undefined;
1442
+ /**
1443
+ * Render padding before the hint.
1444
+ *
1445
+ * Note: Padding should use the editor's background color, not the
1446
+ * background color of the hint itself. That means padding can be used
1447
+ * to visually align/separate an inlay hint.
1448
+ */
1449
+ paddingLeft?: boolean | undefined;
1450
+ /**
1451
+ * Render padding after the hint.
1452
+ *
1453
+ * Note: Padding should use the editor's background color, not the
1454
+ * background color of the hint itself. That means padding can be used
1455
+ * to visually align/separate an inlay hint.
1456
+ */
1457
+ paddingRight?: boolean | undefined;
1458
+ /**
1459
+ * A data entry field that is preserved on an inlay hint between
1460
+ * a `textDocument/inlayHint` and a `inlayHint/resolve` request.
1461
+ */
1462
+ data?: LSPAny | undefined;
1463
+ }
1464
+ /**
1465
+ * Inlay hint kinds.
1466
+ *
1467
+ * @since 3.17.0
1468
+ */
1469
+ export type InlayHintKind = 1 | 2;
1470
+ /**
1471
+ * An inlay hint label part allows for interactive and composite labels
1472
+ * of inlay hints.
1473
+ *
1474
+ * @since 3.17.0
1475
+ */
1476
+ export interface InlayHintLabelPart {
1477
+ /**
1478
+ * The value of this label part.
1479
+ */
1480
+ value: string;
1481
+ /**
1482
+ * The tooltip text when you hover over this label part. Depending on
1483
+ * the client capability `inlayHint.resolveSupport` clients might resolve
1484
+ * this property late using the resolve request.
1485
+ */
1486
+ tooltip?: string | MarkupContent | undefined;
1487
+ /**
1488
+ * An optional source code location that represents this
1489
+ * label part.
1490
+ *
1491
+ * The editor will use this location for the hover and for code navigation
1492
+ * features: This part will become a clickable link that resolves to the
1493
+ * definition of the symbol at the given location (not necessarily the
1494
+ * location itself), it shows the hover that shows at the given location,
1495
+ * and it shows a context menu with further code navigation commands.
1496
+ *
1497
+ * Depending on the client capability `inlayHint.resolveSupport` clients
1498
+ * might resolve this property late using the resolve request.
1499
+ */
1500
+ location?: Location | undefined;
1501
+ /**
1502
+ * An optional command for this label part.
1503
+ *
1504
+ * Depending on the client capability `inlayHint.resolveSupport` clients
1505
+ * might resolve this property late using the resolve request.
1506
+ */
1507
+ command?: Command | undefined;
1508
+ }
1509
+ /**
1510
+ * A parameter literal used in inlay hint requests.
1511
+ *
1512
+ * @since 3.17.0
1513
+ */
1514
+ export interface InlayHintParams {
1515
+ /**
1516
+ * An optional token that a server can use to report work done progress.
1517
+ */
1518
+ workDoneToken?: ProgressToken | undefined;
1519
+ /**
1520
+ * The text document.
1521
+ */
1522
+ textDocument: TextDocumentIdentifier;
1523
+ /**
1524
+ * The document range for which inlay hints should be computed.
1525
+ */
1526
+ range: Range;
1527
+ }
1528
+ /**
1529
+ * A special text edit to provide an insert and a replace operation.
1530
+ *
1531
+ * @since 3.16.0
1532
+ */
1533
+ export interface InsertReplaceEdit {
1534
+ /**
1535
+ * The string to be inserted.
1536
+ */
1537
+ newText: string;
1538
+ /**
1539
+ * The range if the insert is requested
1540
+ */
1541
+ insert: Range;
1542
+ /**
1543
+ * The range if the replace is requested.
1544
+ */
1545
+ replace: Range;
1546
+ }
1547
+ /**
1548
+ * Defines whether the insert text in a completion item should be interpreted as
1549
+ * plain text or a snippet.
1550
+ */
1551
+ export type InsertTextFormat = 1 | 2;
1552
+ /**
1553
+ * How whitespace and indentation is handled during completion
1554
+ * item insertion.
1555
+ *
1556
+ * @since 3.16.0
1557
+ */
1558
+ export type InsertTextMode = 1 | 2;
1559
+ /**
1560
+ * The LSP any type.
1561
+ * Please note that strictly speaking a property with the value `undefined`
1562
+ * can't be converted into JSON preserving the property name. However for
1563
+ * convenience it is allowed and assumed that all these properties are
1564
+ * optional as well.
1565
+ * @since 3.17.0
1566
+ */
1567
+ export type LSPAny = LSPObject | LSPArray | string | number | boolean | null;
1568
+ /**
1569
+ * LSP arrays.
1570
+ * @since 3.17.0
1571
+ */
1572
+ export type LSPArray = LSPAny[];
1573
+ /**
1574
+ * LSP object definition.
1575
+ * @since 3.17.0
1576
+ */
1577
+ export type LSPObject = {
1578
+ [key: string]: LSPAny;
1579
+ };
1580
+ export interface LinkedEditingRangeParams {
1581
+ /**
1582
+ * The text document.
1583
+ */
1584
+ textDocument: TextDocumentIdentifier;
1585
+ /**
1586
+ * The position inside the text document.
1587
+ */
1588
+ position: Position;
1589
+ /**
1590
+ * An optional token that a server can use to report work done progress.
1591
+ */
1592
+ workDoneToken?: ProgressToken | undefined;
1593
+ }
1594
+ /**
1595
+ * The result of a linked editing range request.
1596
+ *
1597
+ * @since 3.16.0
1598
+ */
1599
+ export interface LinkedEditingRanges {
1600
+ /**
1601
+ * A list of ranges that can be edited together. The ranges must have
1602
+ * identical length and contain identical text content. The ranges cannot overlap.
1603
+ */
1604
+ ranges: Range[];
1605
+ /**
1606
+ * An optional word pattern (regular expression) that describes valid contents for
1607
+ * the given ranges. If no pattern is provided, the client configuration's word
1608
+ * pattern will be used.
1609
+ */
1610
+ wordPattern?: string | undefined;
1611
+ }
1612
+ /**
1613
+ * Represents a location inside a resource, such as a line
1614
+ * inside a text file.
1615
+ */
1616
+ export interface Location {
1617
+ uri: DocumentUri;
1618
+ range: Range;
1619
+ }
1620
+ /**
1621
+ * Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
1622
+ * including an origin range.
1623
+ */
1624
+ export interface LocationLink {
1625
+ /**
1626
+ * Span of the origin of this link.
1627
+ *
1628
+ * Used as the underlined span for mouse interaction. Defaults to the word range at
1629
+ * the definition position.
1630
+ */
1631
+ originSelectionRange?: Range | undefined;
1632
+ /**
1633
+ * The target resource identifier of this link.
1634
+ */
1635
+ targetUri: DocumentUri;
1636
+ /**
1637
+ * The full target range of this link. If the target for example is a symbol then target range is the
1638
+ * range enclosing this symbol not including leading/trailing whitespace but everything else
1639
+ * like comments. This information is typically used to highlight the range in the editor.
1640
+ */
1641
+ targetRange: Range;
1642
+ /**
1643
+ * The range that should be selected and revealed when this link is being followed, e.g the name of a function.
1644
+ * Must be contained by the `targetRange`. See also `DocumentSymbol#range`
1645
+ */
1646
+ targetSelectionRange: Range;
1647
+ }
1648
+ /**
1649
+ * Location with only uri and does not include range.
1650
+ *
1651
+ * @since 3.18.0
1652
+ */
1653
+ export interface LocationUriOnly {
1654
+ uri: DocumentUri;
1655
+ }
1656
+ /**
1657
+ * MarkedString can be used to render human readable text. It is either a markdown string
1658
+ * or a code-block that provides a language and a code snippet. The language identifier
1659
+ * is semantically equal to the optional language identifier in fenced code blocks in GitHub
1660
+ * issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
1661
+ *
1662
+ * The pair of a language and a value is an equivalent to markdown:
1663
+ * ```${language}
1664
+ * ${value}
1665
+ * ```
1666
+ *
1667
+ * Note that markdown strings will be sanitized - that means html will be escaped.
1668
+ * @deprecated use MarkupContent instead.
1669
+ */
1670
+ export type MarkedString = string | MarkedStringWithLanguage;
1671
+ /**
1672
+ * @since 3.18.0
1673
+ * @deprecated use MarkupContent instead.
1674
+ */
1675
+ export interface MarkedStringWithLanguage {
1676
+ language: string;
1677
+ value: string;
1678
+ }
1679
+ /**
1680
+ * A `MarkupContent` literal represents a string value which content is interpreted base on its
1681
+ * kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
1682
+ *
1683
+ * If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
1684
+ * See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
1685
+ *
1686
+ * Here is an example how such a string can be constructed using JavaScript / TypeScript:
1687
+ * ```ts
1688
+ * let markdown: MarkdownContent = {
1689
+ * kind: MarkupKind.Markdown,
1690
+ * value: [
1691
+ * '# Header',
1692
+ * 'Some text',
1693
+ * '```typescript',
1694
+ * 'someCode();',
1695
+ * '```'
1696
+ * ].join('\n')
1697
+ * };
1698
+ * ```
1699
+ *
1700
+ * *Please Note* that clients might sanitize the return markdown. A client could decide to
1701
+ * remove HTML from the markdown to avoid script execution.
1702
+ */
1703
+ export interface MarkupContent {
1704
+ /**
1705
+ * The type of the Markup
1706
+ */
1707
+ kind: MarkupKind;
1708
+ /**
1709
+ * The content itself
1710
+ */
1711
+ value: string;
1712
+ }
1713
+ /**
1714
+ * Describes the content type that a client supports in various
1715
+ * result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
1716
+ *
1717
+ * Please note that `MarkupKinds` must not start with a `$`. This kinds
1718
+ * are reserved for internal usage.
1719
+ */
1720
+ export type MarkupKind = "plaintext" | "markdown";
1721
+ /**
1722
+ * Represents a collection of document highlights from a single document, used in multi-document highlight responses.
1723
+ */
1724
+ export interface MultiDocumentHighlight {
1725
+ /**
1726
+ * The URI of the document containing the highlights.
1727
+ */
1728
+ uri: DocumentUri;
1729
+ /**
1730
+ * The highlights for the document.
1731
+ */
1732
+ highlights: DocumentHighlight[];
1733
+ }
1734
+ /**
1735
+ * Parameters for the custom/textDocument/multiDocumentHighlight request.
1736
+ */
1737
+ export interface MultiDocumentHighlightParams {
1738
+ /**
1739
+ * The text document.
1740
+ */
1741
+ textDocument: TextDocumentIdentifier;
1742
+ /**
1743
+ * The position inside the text document.
1744
+ */
1745
+ position: Position;
1746
+ /**
1747
+ * The list of file URIs to search for highlights across.
1748
+ */
1749
+ filesToSearch: DocumentUri[];
1750
+ }
1751
+ /**
1752
+ * A text document identifier to optionally denote a specific version of a text document.
1753
+ */
1754
+ export interface OptionalVersionedTextDocumentIdentifier {
1755
+ /**
1756
+ * The text document's uri.
1757
+ */
1758
+ uri: DocumentUri;
1759
+ /**
1760
+ * The version number of this document. If a versioned text document identifier
1761
+ * is sent from the server to the client and the file is not open in the editor
1762
+ * (the server has not received an open notification before) the server can send
1763
+ * `null` to indicate that the version is unknown and the content on disk is the
1764
+ * truth (as specified with document content ownership).
1765
+ */
1766
+ version: number | null;
1767
+ }
1768
+ /**
1769
+ * Represents a parameter of a callable-signature. A parameter can
1770
+ * have a label and a doc-comment.
1771
+ */
1772
+ export interface ParameterInformation {
1773
+ /**
1774
+ * The label of this parameter information.
1775
+ *
1776
+ * Either a string or an inclusive start and exclusive end offsets within its containing
1777
+ * signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
1778
+ * string representation as `Position` and `Range` does.
1779
+ *
1780
+ * To avoid ambiguities a server should use the [start, end] offset value instead of using
1781
+ * a substring. Whether a client support this is controlled via `labelOffsetSupport` client
1782
+ * capability.
1783
+ *
1784
+ * *Note*: a label of type string should be a substring of its containing signature label.
1785
+ * Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
1786
+ */
1787
+ label: string | [number, number];
1788
+ /**
1789
+ * The human-readable doc-comment of this parameter. Will be shown
1790
+ * in the UI but can be omitted.
1791
+ */
1792
+ documentation?: string | MarkupContent | undefined;
1793
+ }
1794
+ /**
1795
+ * Position in a text document expressed as zero-based line and character
1796
+ * offset. Prior to 3.17 the offsets were always based on a UTF-16 string
1797
+ * representation. So a string of the form `a𐐀b` the character offset of the
1798
+ * character `a` is 0, the character offset of `𐐀` is 1 and the character
1799
+ * offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
1800
+ * Since 3.17 clients and servers can agree on a different string encoding
1801
+ * representation (e.g. UTF-8). The client announces it's supported encoding
1802
+ * via the client capability [`general.positionEncodings`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#clientCapabilities).
1803
+ * The value is an array of position encodings the client supports, with
1804
+ * decreasing preference (e.g. the encoding at index `0` is the most preferred
1805
+ * one). To stay backwards compatible the only mandatory encoding is UTF-16
1806
+ * represented via the string `utf-16`. The server can pick one of the
1807
+ * encodings offered by the client and signals that encoding back to the
1808
+ * client via the initialize result's property
1809
+ * [`capabilities.positionEncoding`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#serverCapabilities). If the string value
1810
+ * `utf-16` is missing from the client's capability `general.positionEncodings`
1811
+ * servers can safely assume that the client supports UTF-16. If the server
1812
+ * omits the position encoding in its initialize result the encoding defaults
1813
+ * to the string value `utf-16`. Implementation considerations: since the
1814
+ * conversion from one encoding into another requires the content of the
1815
+ * file / line the conversion is best done where the file is read which is
1816
+ * usually on the server side.
1817
+ *
1818
+ * Positions are line end character agnostic. So you can not specify a position
1819
+ * that denotes `\r|\n` or `\n|` where `|` represents the character offset.
1820
+ *
1821
+ * @since 3.17.0 - support for negotiated position encoding.
1822
+ */
1823
+ export interface Position {
1824
+ /**
1825
+ * Line position in a document (zero-based).
1826
+ */
1827
+ line: number;
1828
+ /**
1829
+ * Character offset on a line in a document (zero-based).
1830
+ *
1831
+ * The meaning of this offset is determined by the negotiated
1832
+ * `PositionEncodingKind`.
1833
+ */
1834
+ character: number;
1835
+ }
1836
+ /**
1837
+ * @since 3.18.0
1838
+ */
1839
+ export interface PrepareRenameDefaultBehavior {
1840
+ defaultBehavior: boolean;
1841
+ }
1842
+ export interface PrepareRenameParams {
1843
+ /**
1844
+ * The text document.
1845
+ */
1846
+ textDocument: TextDocumentIdentifier;
1847
+ /**
1848
+ * The position inside the text document.
1849
+ */
1850
+ position: Position;
1851
+ /**
1852
+ * An optional token that a server can use to report work done progress.
1853
+ */
1854
+ workDoneToken?: ProgressToken | undefined;
1855
+ }
1856
+ /**
1857
+ * @since 3.18.0
1858
+ */
1859
+ export interface PrepareRenamePlaceholder {
1860
+ range: Range;
1861
+ placeholder: string;
1862
+ }
1863
+ export type PrepareRenameResult = Range | PrepareRenamePlaceholder | PrepareRenameDefaultBehavior;
1864
+ export type ProgressToken = number | string;
1865
+ /**
1866
+ * A range in a text document expressed as (zero-based) start and end positions.
1867
+ *
1868
+ * If you want to specify a range that contains a line including the line ending
1869
+ * character(s) then use an end position denoting the start of the next line.
1870
+ * For example:
1871
+ * ```ts
1872
+ * {
1873
+ * start: { line: 5, character: 23 }
1874
+ * end : { line 6, character : 0 }
1875
+ * }
1876
+ * ```
1877
+ */
1878
+ export interface Range {
1879
+ /**
1880
+ * The range's start position.
1881
+ */
1882
+ start: Position;
1883
+ /**
1884
+ * The range's end position.
1885
+ */
1886
+ end: Position;
1887
+ }
1888
+ /**
1889
+ * Value-object that contains additional information when
1890
+ * requesting references.
1891
+ */
1892
+ export interface ReferenceContext {
1893
+ /**
1894
+ * Include the declaration of the current symbol.
1895
+ */
1896
+ includeDeclaration: boolean;
1897
+ }
1898
+ /**
1899
+ * Parameters for a {@link ReferencesRequest}.
1900
+ */
1901
+ export interface ReferenceParams {
1902
+ /**
1903
+ * The text document.
1904
+ */
1905
+ textDocument: TextDocumentIdentifier;
1906
+ /**
1907
+ * The position inside the text document.
1908
+ */
1909
+ position: Position;
1910
+ /**
1911
+ * An optional token that a server can use to report work done progress.
1912
+ */
1913
+ workDoneToken?: ProgressToken | undefined;
1914
+ /**
1915
+ * An optional token that a server can use to report partial results (e.g. streaming) to
1916
+ * the client.
1917
+ */
1918
+ partialResultToken?: ProgressToken | undefined;
1919
+ context: ReferenceContext;
1920
+ }
1921
+ /**
1922
+ * A full diagnostic report with a set of related documents.
1923
+ *
1924
+ * @since 3.17.0
1925
+ */
1926
+ export interface RelatedFullDocumentDiagnosticReport {
1927
+ /**
1928
+ * A full document diagnostic report.
1929
+ */
1930
+ kind: "full";
1931
+ /**
1932
+ * An optional result id. If provided it will
1933
+ * be sent on the next diagnostic request for the
1934
+ * same document.
1935
+ */
1936
+ resultId?: string | undefined;
1937
+ /**
1938
+ * The actual items.
1939
+ */
1940
+ items: Diagnostic[];
1941
+ /**
1942
+ * Diagnostics of related documents. This information is useful
1943
+ * in programming languages where code in a file A can generate
1944
+ * diagnostics in a file B which A depends on. An example of
1945
+ * such a language is C/C++ where marco definitions in a file
1946
+ * a.cpp and result in errors in a header file b.hpp.
1947
+ *
1948
+ * @since 3.17.0
1949
+ */
1950
+ relatedDocuments?: {
1951
+ [key: DocumentUri]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
1952
+ } | undefined;
1953
+ }
1954
+ /**
1955
+ * An unchanged diagnostic report with a set of related documents.
1956
+ *
1957
+ * @since 3.17.0
1958
+ */
1959
+ export interface RelatedUnchangedDocumentDiagnosticReport {
1960
+ /**
1961
+ * A document diagnostic report indicating
1962
+ * no changes to the last result. A server can
1963
+ * only return `unchanged` if result ids are
1964
+ * provided.
1965
+ */
1966
+ kind: "unchanged";
1967
+ /**
1968
+ * A result id which will be sent on the next
1969
+ * diagnostic request for the same document.
1970
+ */
1971
+ resultId: string;
1972
+ /**
1973
+ * Diagnostics of related documents. This information is useful
1974
+ * in programming languages where code in a file A can generate
1975
+ * diagnostics in a file B which A depends on. An example of
1976
+ * such a language is C/C++ where marco definitions in a file
1977
+ * a.cpp and result in errors in a header file b.hpp.
1978
+ *
1979
+ * @since 3.17.0
1980
+ */
1981
+ relatedDocuments?: {
1982
+ [key: DocumentUri]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
1983
+ } | undefined;
1984
+ }
1985
+ /**
1986
+ * Rename file operation
1987
+ */
1988
+ export interface RenameFile {
1989
+ /**
1990
+ * A rename
1991
+ */
1992
+ kind: "rename";
1993
+ /**
1994
+ * An optional annotation identifier describing the operation.
1995
+ *
1996
+ * @since 3.16.0
1997
+ */
1998
+ annotationId?: ChangeAnnotationIdentifier | undefined;
1999
+ /**
2000
+ * The old (existing) location.
2001
+ */
2002
+ oldUri: DocumentUri;
2003
+ /**
2004
+ * The new location.
2005
+ */
2006
+ newUri: DocumentUri;
2007
+ /**
2008
+ * Rename options.
2009
+ */
2010
+ options?: RenameFileOptions | undefined;
2011
+ }
2012
+ /**
2013
+ * Rename file options
2014
+ */
2015
+ export interface RenameFileOptions {
2016
+ /**
2017
+ * Overwrite target if existing. Overwrite wins over `ignoreIfExists`
2018
+ */
2019
+ overwrite?: boolean | undefined;
2020
+ /**
2021
+ * Ignores if target exists.
2022
+ */
2023
+ ignoreIfExists?: boolean | undefined;
2024
+ }
2025
+ /**
2026
+ * The parameters of a {@link RenameRequest}.
2027
+ */
2028
+ export interface RenameParams {
2029
+ /**
2030
+ * The text document.
2031
+ */
2032
+ textDocument: TextDocumentIdentifier;
2033
+ /**
2034
+ * The position inside the text document.
2035
+ */
2036
+ position: Position;
2037
+ /**
2038
+ * An optional token that a server can use to report work done progress.
2039
+ */
2040
+ workDoneToken?: ProgressToken | undefined;
2041
+ /**
2042
+ * The new name of the symbol. If the given name is not valid the
2043
+ * request must return a {@link ResponseError} with an
2044
+ * appropriate message set.
2045
+ */
2046
+ newName: string;
2047
+ }
2048
+ /**
2049
+ * A selection range represents a part of a selection hierarchy. A selection range
2050
+ * may have a parent selection range that contains it.
2051
+ */
2052
+ export interface SelectionRange {
2053
+ /**
2054
+ * The {@link Range range} of this selection range.
2055
+ */
2056
+ range: Range;
2057
+ /**
2058
+ * The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
2059
+ */
2060
+ parent?: SelectionRange | undefined;
2061
+ }
2062
+ /**
2063
+ * A parameter literal used in selection range requests.
2064
+ */
2065
+ export interface SelectionRangeParams {
2066
+ /**
2067
+ * An optional token that a server can use to report work done progress.
2068
+ */
2069
+ workDoneToken?: ProgressToken | undefined;
2070
+ /**
2071
+ * An optional token that a server can use to report partial results (e.g. streaming) to
2072
+ * the client.
2073
+ */
2074
+ partialResultToken?: ProgressToken | undefined;
2075
+ /**
2076
+ * The text document.
2077
+ */
2078
+ textDocument: TextDocumentIdentifier;
2079
+ /**
2080
+ * The positions inside the text document.
2081
+ */
2082
+ positions: Position[];
2083
+ }
2084
+ /**
2085
+ * @since 3.16.0
2086
+ */
2087
+ export interface SemanticTokens {
2088
+ /**
2089
+ * An optional result id. If provided and clients support delta updating
2090
+ * the client will include the result id in the next semantic token request.
2091
+ * A server can then instead of computing all semantic tokens again simply
2092
+ * send a delta.
2093
+ */
2094
+ resultId?: string | undefined;
2095
+ /**
2096
+ * The actual tokens.
2097
+ */
2098
+ data: number[];
2099
+ }
2100
+ /**
2101
+ * @since 3.16.0
2102
+ */
2103
+ export interface SemanticTokensParams {
2104
+ /**
2105
+ * An optional token that a server can use to report work done progress.
2106
+ */
2107
+ workDoneToken?: ProgressToken | undefined;
2108
+ /**
2109
+ * An optional token that a server can use to report partial results (e.g. streaming) to
2110
+ * the client.
2111
+ */
2112
+ partialResultToken?: ProgressToken | undefined;
2113
+ /**
2114
+ * The text document.
2115
+ */
2116
+ textDocument: TextDocumentIdentifier;
2117
+ }
2118
+ /**
2119
+ * @since 3.16.0
2120
+ */
2121
+ export interface SemanticTokensRangeParams {
2122
+ /**
2123
+ * An optional token that a server can use to report work done progress.
2124
+ */
2125
+ workDoneToken?: ProgressToken | undefined;
2126
+ /**
2127
+ * An optional token that a server can use to report partial results (e.g. streaming) to
2128
+ * the client.
2129
+ */
2130
+ partialResultToken?: ProgressToken | undefined;
2131
+ /**
2132
+ * The text document.
2133
+ */
2134
+ textDocument: TextDocumentIdentifier;
2135
+ /**
2136
+ * The range the semantic tokens are requested for.
2137
+ */
2138
+ range: Range;
2139
+ }
2140
+ /**
2141
+ * Signature help represents the signature of something
2142
+ * callable. There can be multiple signature but only one
2143
+ * active and only one active parameter.
2144
+ */
2145
+ export interface SignatureHelp {
2146
+ /**
2147
+ * One or more signatures.
2148
+ */
2149
+ signatures: SignatureInformation[];
2150
+ /**
2151
+ * The active signature. If omitted or the value lies outside the
2152
+ * range of `signatures` the value defaults to zero or is ignored if
2153
+ * the `SignatureHelp` has no signatures.
2154
+ *
2155
+ * Whenever possible implementors should make an active decision about
2156
+ * the active signature and shouldn't rely on a default value.
2157
+ *
2158
+ * In future version of the protocol this property might become
2159
+ * mandatory to better express this.
2160
+ */
2161
+ activeSignature?: number | undefined;
2162
+ /**
2163
+ * The active parameter of the active signature.
2164
+ *
2165
+ * If `null`, no parameter of the signature is active (for example a named
2166
+ * argument that does not match any declared parameters). This is only valid
2167
+ * if the client specifies the client capability
2168
+ * `textDocument.signatureHelp.noActiveParameterSupport === true`
2169
+ *
2170
+ * If omitted or the value lies outside the range of
2171
+ * `signatures[activeSignature].parameters` defaults to 0 if the active
2172
+ * signature has parameters.
2173
+ *
2174
+ * If the active signature has no parameters it is ignored.
2175
+ *
2176
+ * In future version of the protocol this property might become
2177
+ * mandatory (but still nullable) to better express the active parameter if
2178
+ * the active signature does have any.
2179
+ *
2180
+ * Since version 3.16.0 the `SignatureInformation` itself provides a
2181
+ * `activeParameter` property and it should be used instead of this one.
2182
+ */
2183
+ activeParameter?: number | null | undefined;
2184
+ }
2185
+ /**
2186
+ * Additional information about the context in which a signature help request was triggered.
2187
+ *
2188
+ * @since 3.15.0
2189
+ */
2190
+ export interface SignatureHelpContext {
2191
+ /**
2192
+ * Action that caused signature help to be triggered.
2193
+ */
2194
+ triggerKind: SignatureHelpTriggerKind;
2195
+ /**
2196
+ * Character that caused signature help to be triggered.
2197
+ *
2198
+ * This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
2199
+ */
2200
+ triggerCharacter?: string | undefined;
2201
+ /**
2202
+ * `true` if signature help was already showing when it was triggered.
2203
+ *
2204
+ * Retriggers occurs when the signature help is already active and can be caused by actions such as
2205
+ * typing a trigger character, a cursor move, or document content changes.
2206
+ */
2207
+ isRetrigger: boolean;
2208
+ /**
2209
+ * The currently active `SignatureHelp`.
2210
+ *
2211
+ * The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
2212
+ * the user navigating through available signatures.
2213
+ */
2214
+ activeSignatureHelp?: SignatureHelp | undefined;
2215
+ }
2216
+ /**
2217
+ * Parameters for a {@link SignatureHelpRequest}.
2218
+ */
2219
+ export interface SignatureHelpParams {
2220
+ /**
2221
+ * The text document.
2222
+ */
2223
+ textDocument: TextDocumentIdentifier;
2224
+ /**
2225
+ * The position inside the text document.
2226
+ */
2227
+ position: Position;
2228
+ /**
2229
+ * An optional token that a server can use to report work done progress.
2230
+ */
2231
+ workDoneToken?: ProgressToken | undefined;
2232
+ /**
2233
+ * The signature help context. This is only available if the client specifies
2234
+ * to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
2235
+ *
2236
+ * @since 3.15.0
2237
+ */
2238
+ context?: SignatureHelpContext | undefined;
2239
+ }
2240
+ /**
2241
+ * How a signature help was triggered.
2242
+ *
2243
+ * @since 3.15.0
2244
+ */
2245
+ export type SignatureHelpTriggerKind = 1 | 2 | 3;
2246
+ /**
2247
+ * Represents the signature of something callable. A signature
2248
+ * can have a label, like a function-name, a doc-comment, and
2249
+ * a set of parameters.
2250
+ */
2251
+ export interface SignatureInformation {
2252
+ /**
2253
+ * The label of this signature. Will be shown in
2254
+ * the UI.
2255
+ */
2256
+ label: string;
2257
+ /**
2258
+ * The human-readable doc-comment of this signature. Will be shown
2259
+ * in the UI but can be omitted.
2260
+ */
2261
+ documentation?: string | MarkupContent | undefined;
2262
+ /**
2263
+ * The parameters of this signature.
2264
+ */
2265
+ parameters?: ParameterInformation[] | undefined;
2266
+ /**
2267
+ * The index of the active parameter.
2268
+ *
2269
+ * If `null`, no parameter of the signature is active (for example a named
2270
+ * argument that does not match any declared parameters). This is only valid
2271
+ * if the client specifies the client capability
2272
+ * `textDocument.signatureHelp.noActiveParameterSupport === true`
2273
+ *
2274
+ * If provided (or `null`), this is used in place of
2275
+ * `SignatureHelp.activeParameter`.
2276
+ *
2277
+ * @since 3.16.0
2278
+ */
2279
+ activeParameter?: number | null | undefined;
2280
+ /**
2281
+ * A colorized label for the signature, providing classified text runs for VS syntax coloring.
2282
+ */
2283
+ _vs_colorizedLabel?: VSClassifiedTextElement | undefined;
2284
+ }
2285
+ /**
2286
+ * An interactive text edit.
2287
+ *
2288
+ * @since 3.18.0
2289
+ */
2290
+ export interface SnippetTextEdit {
2291
+ /**
2292
+ * The range of the text document to be manipulated.
2293
+ */
2294
+ range: Range;
2295
+ /**
2296
+ * The snippet to be inserted.
2297
+ */
2298
+ snippet: StringValue;
2299
+ /**
2300
+ * The actual identifier of the snippet edit.
2301
+ */
2302
+ annotationId?: ChangeAnnotationIdentifier | undefined;
2303
+ }
2304
+ /**
2305
+ * A string value used as a snippet is a template which allows to insert text
2306
+ * and to control the editor cursor when insertion happens.
2307
+ *
2308
+ * A snippet can define tab stops and placeholders with `$1`, `$2`
2309
+ * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
2310
+ * the end of the snippet. Variables are defined with `$name` and
2311
+ * `${name:default value}`.
2312
+ *
2313
+ * @since 3.18.0
2314
+ */
2315
+ export interface StringValue {
2316
+ /**
2317
+ * The kind of string value.
2318
+ */
2319
+ kind: "snippet";
2320
+ /**
2321
+ * The snippet string.
2322
+ */
2323
+ value: string;
2324
+ }
2325
+ /**
2326
+ * Represents information about programming constructs like variables, classes,
2327
+ * interfaces etc.
2328
+ */
2329
+ export interface SymbolInformation {
2330
+ /**
2331
+ * The name of this symbol.
2332
+ */
2333
+ name: string;
2334
+ /**
2335
+ * The kind of this symbol.
2336
+ */
2337
+ kind: SymbolKind;
2338
+ /**
2339
+ * Tags for this symbol.
2340
+ *
2341
+ * @since 3.16.0
2342
+ */
2343
+ tags?: SymbolTag[] | undefined;
2344
+ /**
2345
+ * The name of the symbol containing this symbol. This information is for
2346
+ * user interface purposes (e.g. to render a qualifier in the user interface
2347
+ * if necessary). It can't be used to re-infer a hierarchy for the document
2348
+ * symbols.
2349
+ */
2350
+ containerName?: string | undefined;
2351
+ /**
2352
+ * Indicates if this symbol is deprecated.
2353
+ *
2354
+ * @deprecated Use tags instead
2355
+ */
2356
+ deprecated?: boolean | undefined;
2357
+ /**
2358
+ * The location of this symbol. The location's range is used by a tool
2359
+ * to reveal the location in the editor. If the symbol is selected in the
2360
+ * tool the range's start information is used to position the cursor. So
2361
+ * the range usually spans more than the actual symbol's name and does
2362
+ * normally include things like visibility modifiers.
2363
+ *
2364
+ * The range doesn't have to denote a node range in the sense of an abstract
2365
+ * syntax tree. It can therefore not be used to re-construct a hierarchy of
2366
+ * the symbols.
2367
+ */
2368
+ location: Location;
2369
+ }
2370
+ /**
2371
+ * A symbol kind.
2372
+ */
2373
+ export type SymbolKind = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26;
2374
+ /**
2375
+ * Symbol tags are extra annotations that tweak the rendering of a symbol.
2376
+ *
2377
+ * @since 3.16
2378
+ */
2379
+ export type SymbolTag = 1;
2380
+ /**
2381
+ * Describes textual changes on a text document. A TextDocumentEdit describes all changes
2382
+ * on a document version Si and after they are applied move the document to version Si+1.
2383
+ * So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
2384
+ * kind of ordering. However the edits must be non overlapping.
2385
+ */
2386
+ export interface TextDocumentEdit {
2387
+ /**
2388
+ * The text document to change.
2389
+ */
2390
+ textDocument: OptionalVersionedTextDocumentIdentifier;
2391
+ /**
2392
+ * The edits to be applied.
2393
+ *
2394
+ * @since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
2395
+ * client capability.
2396
+ *
2397
+ * @since 3.18.0 - support for SnippetTextEdit. This is guarded using a
2398
+ * client capability.
2399
+ */
2400
+ edits: (TextEdit | AnnotatedTextEdit | SnippetTextEdit)[];
2401
+ }
2402
+ /**
2403
+ * A literal to identify a text document in the client.
2404
+ */
2405
+ export interface TextDocumentIdentifier {
2406
+ /**
2407
+ * The text document's uri.
2408
+ */
2409
+ uri: DocumentUri;
2410
+ }
2411
+ /**
2412
+ * A parameter literal used in requests to pass a text document and a position inside that
2413
+ * document.
2414
+ */
2415
+ export interface TextDocumentPositionParams {
2416
+ /**
2417
+ * The text document.
2418
+ */
2419
+ textDocument: TextDocumentIdentifier;
2420
+ /**
2421
+ * The position inside the text document.
2422
+ */
2423
+ position: Position;
2424
+ }
2425
+ /**
2426
+ * A text edit applicable to a text document.
2427
+ */
2428
+ export interface TextEdit {
2429
+ /**
2430
+ * The range of the text document to be manipulated. To insert
2431
+ * text into a document create a range where start === end.
2432
+ */
2433
+ range: Range;
2434
+ /**
2435
+ * The string to be inserted. For delete operations use an
2436
+ * empty string.
2437
+ */
2438
+ newText: string;
2439
+ }
2440
+ export interface TypeDefinitionParams {
2441
+ /**
2442
+ * The text document.
2443
+ */
2444
+ textDocument: TextDocumentIdentifier;
2445
+ /**
2446
+ * The position inside the text document.
2447
+ */
2448
+ position: Position;
2449
+ /**
2450
+ * An optional token that a server can use to report work done progress.
2451
+ */
2452
+ workDoneToken?: ProgressToken | undefined;
2453
+ /**
2454
+ * An optional token that a server can use to report partial results (e.g. streaming) to
2455
+ * the client.
2456
+ */
2457
+ partialResultToken?: ProgressToken | undefined;
2458
+ }
2459
+ export type URI = string;
2460
+ /**
2461
+ * A diagnostic report indicating that the last returned
2462
+ * report is still accurate.
2463
+ *
2464
+ * @since 3.17.0
2465
+ */
2466
+ export interface UnchangedDocumentDiagnosticReport {
2467
+ /**
2468
+ * A document diagnostic report indicating
2469
+ * no changes to the last result. A server can
2470
+ * only return `unchanged` if result ids are
2471
+ * provided.
2472
+ */
2473
+ kind: "unchanged";
2474
+ /**
2475
+ * A result id which will be sent on the next
2476
+ * diagnostic request for the same document.
2477
+ */
2478
+ resultId: string;
2479
+ }
2480
+ /**
2481
+ * A classified text element containing an array of classified text runs, used for colorized labels in VS.
2482
+ */
2483
+ export interface VSClassifiedTextElement {
2484
+ /**
2485
+ * The classified text runs that make up this element.
2486
+ */
2487
+ Runs: VSClassifiedTextRun[];
2488
+ /**
2489
+ * VS type discriminator required by ObjectContentConverter for deserialization.
2490
+ */
2491
+ _vs_type: "ClassifiedTextElement";
2492
+ }
2493
+ /**
2494
+ * A classified text run with text and classification type, used for colorized display in VS.
2495
+ */
2496
+ export interface VSClassifiedTextRun {
2497
+ /**
2498
+ * The classification type name (e.g. 'keyword', 'class name', 'parameter name').
2499
+ */
2500
+ ClassificationTypeName: string;
2501
+ /**
2502
+ * The text content of this run.
2503
+ */
2504
+ Text: string;
2505
+ /**
2506
+ * Optional marker tag type.
2507
+ */
2508
+ MarkerTagType?: string | undefined;
2509
+ /**
2510
+ * The style of this text run.
2511
+ */
2512
+ Style?: number | undefined;
2513
+ /**
2514
+ * VS type discriminator required by ObjectContentConverter for deserialization.
2515
+ */
2516
+ _vs_type: "ClassifiedTextRun";
2517
+ }
2518
+ /**
2519
+ * A container element that groups other VS rich-content elements (images, classified text, or nested containers). Used to build the VS hover raw content that combines a symbol icon with colorized text.
2520
+ */
2521
+ export interface VSContainerElement {
2522
+ /**
2523
+ * Layout style for the child elements.
2524
+ */
2525
+ Style: VSContainerElementStyle;
2526
+ /**
2527
+ * The child elements contained within this container.
2528
+ */
2529
+ Elements: (VSImageElement | VSClassifiedTextElement | VSContainerElement)[];
2530
+ /**
2531
+ * VS type discriminator required by ObjectContentConverter for deserialization.
2532
+ */
2533
+ _vs_type: "ContainerElement";
2534
+ }
2535
+ /**
2536
+ * Layout style for a VSContainerElement's children, mirroring VS's Microsoft.VisualStudio.Text.Adornments.ContainerElementStyle.
2537
+ */
2538
+ export type VSContainerElementStyle = 0 | 1;
2539
+ /**
2540
+ * An image element (e.g. a symbol-kind icon) for use in VS rich content such as hover tooltips.
2541
+ */
2542
+ export interface VSImageElement {
2543
+ /**
2544
+ * The image to display.
2545
+ */
2546
+ ImageId: VSImageId;
2547
+ /**
2548
+ * VS type discriminator required by ObjectContentConverter for deserialization.
2549
+ */
2550
+ _vs_type: "ImageElement";
2551
+ }
2552
+ /**
2553
+ * Identifies an image in a VS image catalog. Used to render symbol-kind icons (e.g. in hover tooltips).
2554
+ */
2555
+ export interface VSImageId {
2556
+ /**
2557
+ * The GUID of the image catalog containing this image.
2558
+ */
2559
+ Guid: string;
2560
+ /**
2561
+ * The numeric identifier of the image within its catalog.
2562
+ */
2563
+ Id: number;
2564
+ /**
2565
+ * VS type discriminator required by ObjectContentConverter for deserialization.
2566
+ */
2567
+ _vs_type: "ImageId";
2568
+ }
2569
+ /**
2570
+ * Parameters for the textDocument/_vs_onAutoInsert request.
2571
+ */
2572
+ export interface VSOnAutoInsertParams {
2573
+ /**
2574
+ * The text document.
2575
+ */
2576
+ _vs_textDocument: TextDocumentIdentifier;
2577
+ /**
2578
+ * The position inside the text document.
2579
+ */
2580
+ _vs_position: Position;
2581
+ /**
2582
+ * The character that triggered the auto-insert.
2583
+ */
2584
+ _vs_ch: string;
2585
+ }
2586
+ /**
2587
+ * Response item for the textDocument/_vs_onAutoInsert request.
2588
+ */
2589
+ export interface VSOnAutoInsertResponseItem {
2590
+ /**
2591
+ * The format of the text edit (plaintext or snippet).
2592
+ */
2593
+ _vs_textEditFormat: InsertTextFormat;
2594
+ /**
2595
+ * The text edit to apply for the auto-insertion.
2596
+ */
2597
+ _vs_textEdit: TextEdit;
2598
+ }
2599
+ /**
2600
+ * A VS-specific reference item with grouping support for Find All References.
2601
+ */
2602
+ export interface VSReferenceItem {
2603
+ /**
2604
+ * Unique identifier for this reference item.
2605
+ */
2606
+ _vs_id: number;
2607
+ /**
2608
+ * The ID of the definition item this reference belongs to. Absent for definition items themselves.
2609
+ */
2610
+ _vs_definitionId?: number | undefined;
2611
+ /**
2612
+ * The kind(s) of this reference (read, write, etc.).
2613
+ */
2614
+ _vs_kind?: VSReferenceKind[] | undefined;
2615
+ /**
2616
+ * The location of this reference.
2617
+ */
2618
+ _vs_location: Location;
2619
+ /**
2620
+ * Classified display text for the definition (used for grouping headers in the UI).
2621
+ */
2622
+ _vs_definitionText?: VSClassifiedTextElement | undefined;
2623
+ /**
2624
+ * The project name for this reference.
2625
+ */
2626
+ _vs_projectName?: string | undefined;
2627
+ /**
2628
+ * The containing type for this reference.
2629
+ */
2630
+ _vs_containingType?: string | undefined;
2631
+ }
2632
+ export type VSReferenceKind = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
2633
+ /**
2634
+ * A workspace edit represents changes to many resources managed in the workspace. The edit
2635
+ * should either provide `changes` or `documentChanges`. If documentChanges are present
2636
+ * they are preferred over `changes` if the client can handle versioned document edits.
2637
+ *
2638
+ * Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
2639
+ * operations are present clients need to execute the operations in the order in which they
2640
+ * are provided. So a workspace edit for example can consist of the following two changes:
2641
+ * (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
2642
+ *
2643
+ * An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
2644
+ * cause failure of the operation. How the client recovers from the failure is described by
2645
+ * the client capability: `workspace.workspaceEdit.failureHandling`
2646
+ */
2647
+ export interface WorkspaceEdit {
2648
+ /**
2649
+ * Holds changes to existing resources.
2650
+ */
2651
+ changes?: {
2652
+ [key: DocumentUri]: TextEdit[];
2653
+ } | undefined;
2654
+ /**
2655
+ * Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
2656
+ * are either an array of `TextDocumentEdit`s to express changes to n different text documents
2657
+ * where each text document edit addresses a specific version of a text document. Or it can contain
2658
+ * above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
2659
+ *
2660
+ * Whether a client supports versioned document edits is expressed via
2661
+ * `workspace.workspaceEdit.documentChanges` client capability.
2662
+ *
2663
+ * If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
2664
+ * only plain `TextEdit`s using the `changes` property are supported.
2665
+ */
2666
+ documentChanges?: (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[] | undefined;
2667
+ /**
2668
+ * A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
2669
+ * delete file / folder operations.
2670
+ *
2671
+ * Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
2672
+ *
2673
+ * @since 3.16.0
2674
+ */
2675
+ changeAnnotations?: {
2676
+ [key: ChangeAnnotationIdentifier]: ChangeAnnotation;
2677
+ } | undefined;
2678
+ }
2679
+ /**
2680
+ * A special workspace symbol that supports locations without a range.
2681
+ *
2682
+ * See also SymbolInformation.
2683
+ *
2684
+ * @since 3.17.0
2685
+ */
2686
+ export interface WorkspaceSymbol {
2687
+ /**
2688
+ * The name of this symbol.
2689
+ */
2690
+ name: string;
2691
+ /**
2692
+ * The kind of this symbol.
2693
+ */
2694
+ kind: SymbolKind;
2695
+ /**
2696
+ * Tags for this symbol.
2697
+ *
2698
+ * @since 3.16.0
2699
+ */
2700
+ tags?: SymbolTag[] | undefined;
2701
+ /**
2702
+ * The name of the symbol containing this symbol. This information is for
2703
+ * user interface purposes (e.g. to render a qualifier in the user interface
2704
+ * if necessary). It can't be used to re-infer a hierarchy for the document
2705
+ * symbols.
2706
+ */
2707
+ containerName?: string | undefined;
2708
+ /**
2709
+ * The location of the symbol. Whether a server is allowed to
2710
+ * return a location without a range depends on the client
2711
+ * capability `workspace.symbol.resolveSupport`.
2712
+ *
2713
+ * See SymbolInformation#location for more details.
2714
+ */
2715
+ location: Location | LocationUriOnly;
2716
+ /**
2717
+ * A data entry field that is preserved on a workspace symbol between a
2718
+ * workspace symbol request and a workspace symbol resolve request.
2719
+ */
2720
+ data?: LSPAny | undefined;
2721
+ }
2722
+ /**
2723
+ * The parameters of a {@link WorkspaceSymbolRequest}.
2724
+ */
2725
+ export interface WorkspaceSymbolParams {
2726
+ /**
2727
+ * An optional token that a server can use to report work done progress.
2728
+ */
2729
+ workDoneToken?: ProgressToken | undefined;
2730
+ /**
2731
+ * An optional token that a server can use to report partial results (e.g. streaming) to
2732
+ * the client.
2733
+ */
2734
+ partialResultToken?: ProgressToken | undefined;
2735
+ /**
2736
+ * A query string to filter symbols by. Clients may send an empty
2737
+ * string here to request all symbols.
2738
+ *
2739
+ * The `query`-parameter should be interpreted in a *relaxed way* as editors
2740
+ * will apply their own highlighting and scoring on the results. A good rule
2741
+ * of thumb is to match case-insensitive and to simply check that the
2742
+ * characters of *query* appear in their order in a candidate symbol.
2743
+ * Servers shouldn't use prefix, substring, or similar strict matching.
2744
+ */
2745
+ query: string;
2746
+ /**
2747
+ * Scopes the workspace symbol search to projects containing this document.
2748
+ */
2749
+ textDocument?: TextDocumentIdentifier | undefined;
2750
+ }
2751
+ /** Language-feature requests supported by the extension middleware API. */
2752
+ export interface LspMiddlewareRequests {
2753
+ "textDocument/hover": {
2754
+ params: HoverParams;
2755
+ result: Hover | null;
2756
+ };
2757
+ "textDocument/completion": {
2758
+ params: CompletionParams;
2759
+ result: CompletionItem[] | CompletionList | null;
2760
+ };
2761
+ "completionItem/resolve": {
2762
+ params: CompletionItem;
2763
+ result: CompletionItem;
2764
+ };
2765
+ "textDocument/signatureHelp": {
2766
+ params: SignatureHelpParams;
2767
+ result: SignatureHelp | null;
2768
+ };
2769
+ "textDocument/definition": {
2770
+ params: DefinitionParams;
2771
+ result: Definition | DefinitionLink[] | null;
2772
+ };
2773
+ "textDocument/typeDefinition": {
2774
+ params: TypeDefinitionParams;
2775
+ result: Definition | DefinitionLink[] | null;
2776
+ };
2777
+ "textDocument/implementation": {
2778
+ params: ImplementationParams;
2779
+ result: Definition | DefinitionLink[] | null;
2780
+ };
2781
+ "textDocument/references": {
2782
+ params: ReferenceParams;
2783
+ result: Location[] | null;
2784
+ };
2785
+ "textDocument/documentHighlight": {
2786
+ params: DocumentHighlightParams;
2787
+ result: DocumentHighlight[] | null;
2788
+ };
2789
+ "textDocument/documentSymbol": {
2790
+ params: DocumentSymbolParams;
2791
+ result: SymbolInformation[] | DocumentSymbol[] | null;
2792
+ };
2793
+ "workspace/symbol": {
2794
+ params: WorkspaceSymbolParams;
2795
+ result: SymbolInformation[] | WorkspaceSymbol[] | null;
2796
+ };
2797
+ "textDocument/rename": {
2798
+ params: RenameParams;
2799
+ result: WorkspaceEdit | null;
2800
+ };
2801
+ "textDocument/prepareRename": {
2802
+ params: PrepareRenameParams;
2803
+ result: PrepareRenameResult | null;
2804
+ };
2805
+ "textDocument/formatting": {
2806
+ params: DocumentFormattingParams;
2807
+ result: TextEdit[] | null;
2808
+ };
2809
+ "textDocument/rangeFormatting": {
2810
+ params: DocumentRangeFormattingParams;
2811
+ result: TextEdit[] | null;
2812
+ };
2813
+ "textDocument/onTypeFormatting": {
2814
+ params: DocumentOnTypeFormattingParams;
2815
+ result: TextEdit[] | null;
2816
+ };
2817
+ "textDocument/selectionRange": {
2818
+ params: SelectionRangeParams;
2819
+ result: SelectionRange[] | null;
2820
+ };
2821
+ "textDocument/foldingRange": {
2822
+ params: FoldingRangeParams;
2823
+ result: FoldingRange[] | null;
2824
+ };
2825
+ "textDocument/inlayHint": {
2826
+ params: InlayHintParams;
2827
+ result: InlayHint[] | null;
2828
+ };
2829
+ "textDocument/codeAction": {
2830
+ params: CodeActionParams;
2831
+ result: (Command | CodeAction)[] | null;
2832
+ };
2833
+ "textDocument/codeLens": {
2834
+ params: CodeLensParams;
2835
+ result: CodeLens[] | null;
2836
+ };
2837
+ "codeLens/resolve": {
2838
+ params: CodeLens;
2839
+ result: CodeLens;
2840
+ };
2841
+ "textDocument/prepareCallHierarchy": {
2842
+ params: CallHierarchyPrepareParams;
2843
+ result: CallHierarchyItem[] | null;
2844
+ };
2845
+ "callHierarchy/incomingCalls": {
2846
+ params: CallHierarchyIncomingCallsParams;
2847
+ result: CallHierarchyIncomingCall[] | null;
2848
+ };
2849
+ "callHierarchy/outgoingCalls": {
2850
+ params: CallHierarchyOutgoingCallsParams;
2851
+ result: CallHierarchyOutgoingCall[] | null;
2852
+ };
2853
+ "textDocument/linkedEditingRange": {
2854
+ params: LinkedEditingRangeParams;
2855
+ result: LinkedEditingRanges | null;
2856
+ };
2857
+ "textDocument/semanticTokens/full": {
2858
+ params: SemanticTokensParams;
2859
+ result: SemanticTokens | null;
2860
+ };
2861
+ "textDocument/semanticTokens/range": {
2862
+ params: SemanticTokensRangeParams;
2863
+ result: SemanticTokens | null;
2864
+ };
2865
+ "textDocument/diagnostic": {
2866
+ params: DocumentDiagnosticParams;
2867
+ result: DocumentDiagnosticReport;
2868
+ };
2869
+ "custom/textDocument/sourceDefinition": {
2870
+ params: TextDocumentPositionParams;
2871
+ result: Definition | DefinitionLink[] | null;
2872
+ };
2873
+ "custom/textDocument/multiDocumentHighlight": {
2874
+ params: MultiDocumentHighlightParams;
2875
+ result: MultiDocumentHighlight[] | null;
2876
+ };
2877
+ "textDocument/_vs_onAutoInsert": {
2878
+ params: VSOnAutoInsertParams;
2879
+ result: VSOnAutoInsertResponseItem | null;
2880
+ };
2881
+ "textDocument/_vs_references": {
2882
+ params: ReferenceParams;
2883
+ result: VSReferenceItem[] | null;
2884
+ };
2885
+ }
2886
+ //# sourceMappingURL=protocol.generated.d.ts.map