search

forcedotcom / lightning-language-server

LWC and Aura Language Servers - shipped as part of the Salesforce VSCode Extensions
https://forcedotcom.github.io/salesforcedx-vscode/
BSD 3-Clause "New" or "Revised" License
33 stars 48 forks source link
aura language-server lwc vscode

readme

License
npm (scoped) npm (scoped) npm (scoped) Commitizen friendly

Lightning Language Servers

Mono repo for the LWC and Aura Language Services that are used in the Salesforce Extensions for VS Code.

Issues & Features

Open issues and feature requests on the Salesforce VSCode Extensions Repository.

Setup Development Environment

Pre-requisites

Follow the pre-requisites here: https://github.com/forcedotcom/salesforcedx-vscode/blob/develop/CONTRIBUTING.md

Clone this repository and Salesforce VSCode Extensions

git clone git@github.com:forcedotcom/lightning-language-server.git
git clone git@github.com:forcedotcom/salesforcedx-vscode.git

Note: These projects need to be cloned into the same parent directory

Setup lightning-language-server repository

cd lightning-language-server
yarn install
yarn link-lsp

Setup Salesforce VSCode Extensions repository

cd ../salesforcedx-vscode
npm install
npm run link-lsp
npm run compile

Open both repositories in a vscode workspace

Note: complete the install process before this step, or you may receive errors about "Property ‘objType’ does not exist on type ‘Node’." from the Tern Server. This is due to the node_modules being improperly installed at a level above the lightning-language-server. If this does happen to you, simply remove the extra node_modules directory.

cd ../lightning-language-server
code ./vscode-workspaces/multiroot-simple.code-workspace # or
code ./vscode-workspaces/multiroot-flat.code-workspace

The "simple" workspace will effectively show two main nodes in the Explorer, while "flat" will show each package separately.

Simple:

Flat:

Debugging with VSCode

Run 'Launch DX - Aura & LWC' from the VSCode debug view (its the last one in that long list).

Recompile on change

cd ../lightning-language-server
yarn watch
cd ../salesforcedx-vscode
npm run watch

Note: You need to restart vscode each time you make changes to the language server or the lightning vscode extensions. Easiest way to do this is to kill the vscode client and hit F5 to relaunch your debugger.

Publishing to NPM

When a commit is merged to main, we will automatically create the github release, and then publish the changes to npm using our Github Actions

On-Demand publish to NPM

Navigate to the Actions tab in the repository

  1. Under Workflows on the left side, select Manual Release.
  2. Select Run Workflow, and ensure the newest version is published to npm once the workflow completes.
  3. Any failures will notify the pdt release channel internally.