Skip to content

Commit ea634d2

Browse files
committed
Prefix methods with x in extension
Initially I left it out because the additions were directly in protocol.md - now that the extension is in an explicit "extension" file it makes more sense to spec it with an x prefix for implementors. We can omit it when we do the official proposal in protocol.md
1 parent 1677268 commit ea634d2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

extension-files.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ interface ClientCapabilities {
2424
/* ... all fields from the base ClientCapabilities ... */
2525

2626
/**
27-
* The client provides support for workspace/files.
27+
* The client provides support for workspace/xfiles.
2828
*/
29-
filesProvider?: boolean;
29+
xfilesProvider?: boolean;
3030
/**
31-
* The client provides support for textDocument/content.
31+
* The client provides support for textDocument/xcontent.
3232
*/
33-
contentProvider?: boolean;
33+
xcontentProvider?: boolean;
3434
}
3535
```
3636

@@ -39,7 +39,7 @@ interface ClientCapabilities {
3939
The content request is sent from the server to the client to request the current content of any text document. This allows language servers to operate without accessing the file system directly.
4040

4141
_Request_:
42-
* method: 'textDocument/content'
42+
* method: 'textDocument/xcontent'
4343
* params: `ContentParams` defined as follows:
4444

4545
```typescript
@@ -62,7 +62,7 @@ The files request is sent from the server to the client to request a list of all
6262
A language server can use the result to index files by filtering and doing a content request for each text document of interest.
6363

6464
_Request_:
65-
* method: 'workspace/files'
65+
* method: 'workspace/xfiles'
6666
* params: `FilesParams` defined as follows:
6767

6868
```typescript
@@ -88,7 +88,7 @@ Relative (`rootPath` is `file:///some/project`):
8888
{
8989
"jsonrpc": "2.0",
9090
"id": 1,
91-
"method": "workspace/files"
91+
"method": "workspace/xfiles"
9292
}
9393
```
9494

@@ -111,7 +111,7 @@ Absolute:
111111
{
112112
"jsonrpc": "2.0",
113113
"id": 1,
114-
"method": "workspace/files",
114+
"method": "workspace/xfiles",
115115
"params": {
116116
"base": "file:///usr/local/go"
117117
}
@@ -136,7 +136,7 @@ Absolute:
136136

137137
* The protocol uses URIs, not file paths, to be consistent with the rest of LSP.
138138
* Matching the `base` parameter relative to the `rootPath` permits the server to request files outside the workspace even if the workspace is on a remote host and/or uses an arbitrary protocol.
139-
* Usage of `TextDocumentIdentifier` in `workspace/files` allows to easily extend the result with more properties in the future without breaking backward compatibility.
139+
* Usage of `TextDocumentIdentifier` in `workspace/xfiles` allows to easily extend the result with more properties in the future without breaking backward compatibility.
140140

141141

142142
## Known issues

0 commit comments

Comments
 (0)