-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add volar-service-yaml #45
Merged
johnsoncodehk
merged 12 commits into
volarjs:master
from
remcohaszing:yaml-language-server
Sep 3, 2023
Merged
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
0579810
Add volar-service-yaml
remcohaszing b8001cb
Add yaml to readme
remcohaszing dff8d96
Pick yaml language service from nested dependency
remcohaszing f931d2b
Update packages/yaml/package.json
remcohaszing c26ba86
chore: format
johnsoncodehk 36708f0
Remove yaml formatting provider
remcohaszing de0c50e
fix: triggerCharacters missing for language server register
johnsoncodehk a8d6bd6
Merge branch 'master' into pr/45
johnsoncodehk 1d49707
chore: use export default
johnsoncodehk 51d529c
chore: format
johnsoncodehk 95c171a
chore: simplify schemaRequestService
johnsoncodehk 55f62b8
chore: unused umd path for now
johnsoncodehk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"name": "volar-service-yaml", | ||
"version": "0.0.11", | ||
"main": "out/index.js", | ||
"license": "MIT", | ||
"files": [ | ||
"out/**/*.js", | ||
"out/**/*.d.ts" | ||
], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/volarjs/services.git", | ||
"directory": "packages/yaml" | ||
}, | ||
"dependencies": { | ||
"yaml-language-server": "1.14.0" | ||
}, | ||
"devDependencies": { | ||
"vscode-languageserver-textdocument": "^1.0.8" | ||
}, | ||
"peerDependencies": { | ||
"@volar/language-service": "~1.10.0" | ||
}, | ||
"peerDependenciesMeta": { | ||
"@volar/language-service": { | ||
"optional": true | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,129 @@ | ||||||||||||||||||||||||||
import { type Service } from '@volar/language-service'; | ||||||||||||||||||||||||||
import { type TextDocument } from 'vscode-languageserver-textdocument'; | ||||||||||||||||||||||||||
import { type LanguageSettings, type LanguageService } from 'yaml-language-server'; | ||||||||||||||||||||||||||
import { getLanguageService } from 'yaml-language-server/lib/umd/languageservice/yamlLanguageService.js'; | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
export interface Provide { | ||||||||||||||||||||||||||
'yaml/languageService': () => LanguageService; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
function isYaml(document: TextDocument): boolean { | ||||||||||||||||||||||||||
return document.languageId === 'yaml'; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
function noop(): undefined { } | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
/** | ||||||||||||||||||||||||||
* Create a Volar language service for YAML documents. | ||||||||||||||||||||||||||
*/ | ||||||||||||||||||||||||||
export default (settings: LanguageSettings): Service<Provide> => { | ||||||||||||||||||||||||||
return (context): ReturnType<Service<Provide>> => { | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
if (!context) { | ||||||||||||||||||||||||||
return { triggerCharacters: [' ', ':'] } as any; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
const ls = getLanguageService({ | ||||||||||||||||||||||||||
schemaRequestService: async (uri) => await context.env.fs?.readFile(uri) ?? '', | ||||||||||||||||||||||||||
telemetry: { | ||||||||||||||||||||||||||
send: noop, | ||||||||||||||||||||||||||
sendError: noop, | ||||||||||||||||||||||||||
sendTrack: noop | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
// @ts-expect-error https://github.com/redhat-developer/yaml-language-server/pull/910 | ||||||||||||||||||||||||||
clientCapabilities: context?.env?.clientCapabilities, | ||||||||||||||||||||||||||
workspaceContext: { | ||||||||||||||||||||||||||
resolveRelativePath(relativePath, resource) { | ||||||||||||||||||||||||||
return String(new URL(relativePath, resource)); | ||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I found this is simpler than json service. The following code of json service is modified from vscode implementation. But I think your implementation also works, let's keep it. services/packages/json/src/index.ts Lines 21 to 32 in a2eee58
|
||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ls.configure({ | ||||||||||||||||||||||||||
completion: true, | ||||||||||||||||||||||||||
customTags: [], | ||||||||||||||||||||||||||
format: true, | ||||||||||||||||||||||||||
hover: true, | ||||||||||||||||||||||||||
isKubernetes: false, | ||||||||||||||||||||||||||
validate: true, | ||||||||||||||||||||||||||
yamlVersion: '1.2', | ||||||||||||||||||||||||||
...settings | ||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
return { | ||||||||||||||||||||||||||
provide: { | ||||||||||||||||||||||||||
'yaml/languageService': () => ls | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
triggerCharacters: [' ', ':'], | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideCodeActions(document, range, context) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.getCodeAction(document, { | ||||||||||||||||||||||||||
context, | ||||||||||||||||||||||||||
range, | ||||||||||||||||||||||||||
textDocument: document | ||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideCodeLenses(document) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.getCodeLens(document); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideCompletionItems(document, position) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.doComplete(document, position, false); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideDefinition(document, position) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.doDefinition(document, { position, textDocument: document }); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideDiagnostics(document) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.doValidation(document, false); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideDocumentSymbols(document) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.findDocumentSymbols2(document, {}); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideHover(document, position) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.doHover(document, position); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideDocumentLinks(document) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.findLinks(document); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideFoldingRanges(document) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.getFoldingRanges(document, {}); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
provideSelectionRanges(document, positions) { | ||||||||||||||||||||||||||
if (isYaml(document)) { | ||||||||||||||||||||||||||
return ls.getSelectionRanges(document, positions); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
resolveCodeLens(codeLens) { | ||||||||||||||||||||||||||
return ls.resolveCodeLens(codeLens); | ||||||||||||||||||||||||||
}, | ||||||||||||||||||||||||||
}; | ||||||||||||||||||||||||||
}; | ||||||||||||||||||||||||||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"extends": "../../tsconfig.json", | ||
"compilerOptions": { | ||
"noEmit": false, | ||
"outDir": "out", | ||
"rootDir": "src", | ||
}, | ||
"include": [ | ||
"src", | ||
], | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good way to avoid downstream bundling hack! But since this is inconsistent with other services, I will temporarily change it to
import from 'yaml-language-server'
and change to import from umd path for all services in a separate PR, so we can retrace the reason.