|
| 1 | +--- |
| 2 | +'graphql-language-service-server': minor |
| 3 | +'vscode-graphql': patch |
| 4 | +--- |
| 5 | + |
| 6 | +Introduce `locateCommand` based on Relay LSP `pathToLocateCommand`: |
| 7 | + |
| 8 | +Now with `<graphql config>.extensions.languageService.locateCommand`, you can specify either the [existing signature](https://marketplace.visualstudio.com/items?itemName=meta.relay#relay.pathtolocatecommand-default-null) for relay, with the same callback parameters and return signature. |
| 9 | + |
| 10 | +Relay LSP currently supports `Type` and `Type.field` for the 2nd argument. Ours also returns `Type.field(argument)` as a point of reference. It works with object types, input types, fragments, executable definitions and their fields, and should work for directive definitions as well. |
| 11 | + |
| 12 | +In the case of unnamed types such as fragment spreads, they return the name of the implemented type currently, but I'm curious what users prefer here. I assumed that some people may want to not be limited to only using this for SDL type definition lookups. Also look soon to see `locateCommand` support added for symbols, outline, and coming references and implementations. |
| 13 | + |
| 14 | +The module at the path you specify in relay LSP for `pathToLocateCommand` should work as such |
| 15 | + |
| 16 | +```ts |
| 17 | +// import it |
| 18 | +import { locateCommand } from './graphql/tooling/lsp/locate.js'; |
| 19 | +export default { |
| 20 | + languageService: { |
| 21 | + locateCommand, |
| 22 | + }, |
| 23 | + |
| 24 | + projects: { |
| 25 | + a: { |
| 26 | + schema: 'https://localhost:8000/graphql', |
| 27 | + documents: './a/**/*.{ts,tsx,jsx,js,graphql}', |
| 28 | + }, |
| 29 | + b: { |
| 30 | + schema: './schema/ascode.ts', |
| 31 | + documents: './b/**/*.{ts,tsx,jsx,js,graphql}', |
| 32 | + }, |
| 33 | + }, |
| 34 | +}; |
| 35 | +``` |
| 36 | + |
| 37 | +```ts |
| 38 | +// or define it inline |
| 39 | + |
| 40 | +import { type LocateCommand } from 'graphql-language-service-server'; |
| 41 | + |
| 42 | +// relay LSP style |
| 43 | +const languageCommand = (projectName: string, typePath: string) => { |
| 44 | + const { path, startLine, endLine } = ourLookupUtility(projectName, typePath); |
| 45 | + return `${path}:${startLine}:${endLine}`; |
| 46 | +}; |
| 47 | + |
| 48 | +// an example with our alternative return signature |
| 49 | +const languageCommand: LocateCommand = (projectName, typePath, info) => { |
| 50 | + // pass more info, such as GraphQLType with the ast node. info.project is also available if you need it |
| 51 | + const { path, range } = ourLookupUtility( |
| 52 | + projectName, |
| 53 | + typePath, |
| 54 | + info.type.node, |
| 55 | + ); |
| 56 | + return { uri: path, range }; // range.start.line/range.end.line |
| 57 | +}; |
| 58 | + |
| 59 | +export default { |
| 60 | + languageService: { |
| 61 | + locateCommand, |
| 62 | + }, |
| 63 | + schema: 'https://localhost:8000/graphql', |
| 64 | + documents: './**/*.{ts,tsx,jsx,js,graphql}', |
| 65 | +}; |
| 66 | +``` |
| 67 | + |
| 68 | +Passing a string as a module path to resolve is coming in a follow-up release. Then it can be used with `.yml`, `.toml`, `.json`, `package.json#graphql`, etc |
| 69 | + |
| 70 | +For now this was a quick baseline for a feature asked for in multiple channels! |
| 71 | + |
| 72 | +Let us know how this works, and about any other interoperability improvements between our graphql LSP and other language servers (relay, intellij, etc) used by you and colleauges in your engineering organisations. We are trying our best to keep up with the awesome innovations they have 👀! |
0 commit comments