Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 4.05 KB

This repository is a fork of Vetur. Vetur itself is partly adopted from VSCode's Language Features for HTML extension and incorporates VSCode Language Services extension architecture. Vetur integrates several language services next to TS (html, sass etc.). All of these have been removed, as were tests. But this is why things like languageModes.ts exists. We could simplify these parts, but there isn't much to be gained from it. Also it's neat to keep it close to upstream to simplify rebasing.

To help you getting started on contributing:

The interesting stuff happens here:

  • Compile to JS (one line)
  • javascript.ts. You can see most of what was added to it in 76b990. Mostly, positions and ranges are mapped back and forth between JS and CS
  • transpileService.ts. This is the only file that was added. It provides compiling capabilities and mapping functions. It also contains a faked coffee compilation step to enable autocomplete in syntactically incorrect coffee files, but with one erroneous line only. With more than one error line, compilation finally fails and the raw coffee code is fed into the TS service (in embeddedSupport). This can still provide useful info for global variable and imports. With some hacking, we might achieve local variable type context in that case too. --- transpileService brings its own state and cache and thus is not really integrated into the rest of the system but rather a standalone module.

Why is such a bloated structure necessary then, you might wonder. Reason being convenience and TS compiler, its usage api is complex. To pass it virtual file contents, you need to pass it a custom host service. You could use something like ts-morph but this makes achieving performance a hard task. You could use request forwarding (not lsp) but that does not support diagnostics which are server-push only, and Go To imports are impossible. You could use an existing TS LSP implementation for imports resolving. I went all of these approaches and unified them in another single extension. You can find it here. It also kind of works, but worse, and it is very slow, bulky, and cannot be used outside VSCode.

A disadvantage of the current project structure is the inability to pass dynamic content to TS service. For example, in javascript.ts#doSignatureHelp,

const signatureHelpItems = service.getSignatureHelpItems(fileFsPath, scriptDoc.offsetAt(position), undefined);

you cannot pass special file contents to the service (getSignatureHelpItems(alteredJs)), but it would be handy. In the case of signature help provider, it would be great to just replace dangling spaces with opening braces and change compilation process as we don't care for syntax correctness in this place. Instead, it is baked into the compilation step in transpileService directly which also works but is a bit annoying. Would be good to fix this some day.

Code style

Code specific to this repository follows underscore_variable naming. This greatly helps to differentiate it from Vetur/dependencies code. Also omit semicolons. Remaining formatting standards remain untouched to upstream.