lsp: Prefer server for formatting #148
Merged
Conversation
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
Formatting rego files using the language server is marginally faster than shelling out to the local opa binary. Since Regal can provide formatting functionality, this should be used if available. This change alters the extension to use the formatting functionality of the Regal if the user has chosen to enable Regal. If they disable Regal, then the opa fmt formatter will return. Signed-off-by: Charlie Egan <charlie@styra.com>
charlieegan3
added a commit
to StyraInc/regal
that referenced
this pull request
Apr 11, 2024
In #641 support was added to handle textDocument/formatting requests from clients. However, the functionality was disabled for fear that users would see a confusing message: #638 (comment) In open-policy-agent/vscode-opa#148 the regal formatter will be used if the user has enabled regal and opa fmt will be used if not. This means that there is only ever one formatter available for rego and the user will see no message. Signed-off-by: Charlie Egan <charlie@styra.com>
|
StyraInc/regal#643 is the related part that is needed in the server for this to work: StyraInc/regal#643 |
charlieegan3
added a commit
to StyraInc/regal
that referenced
this pull request
Apr 11, 2024
In #641 support was added to handle textDocument/formatting requests from clients. However, the functionality was disabled for fear that users would see a confusing message: #638 (comment) In open-policy-agent/vscode-opa#148 the regal formatter will be used if the user has enabled regal and opa fmt will be used if not. This means that there is only ever one formatter available for rego and the user will see no message. Signed-off-by: Charlie Egan <charlie@styra.com>
anderseknert
pushed a commit
to StyraInc/regal
that referenced
this pull request
Apr 11, 2024
In #641 support was added to handle textDocument/formatting requests from clients. However, the functionality was disabled for fear that users would see a confusing message: #638 (comment) In open-policy-agent/vscode-opa#148 the regal formatter will be used if the user has enabled regal and opa fmt will be used if not. This means that there is only ever one formatter available for rego and the user will see no message. Signed-off-by: Charlie Egan <charlie@styra.com>
anderseknert
approved these changes
Apr 11, 2024
| // opaFormatterRegistration is used to track the registration of the OPA formatter. | ||
| // The registration is disposed when the language server 'regal' is enabled so that | ||
| // the language server can handle formatting instead of shelling out to 'opa fmt'. | ||
| let opaFormatterRegistration: vscode.Disposable | undefined; |
srenatus
pushed a commit
to srenatus/regal
that referenced
this pull request
Oct 1, 2024
In StyraInc#641 support was added to handle textDocument/formatting requests from clients. However, the functionality was disabled for fear that users would see a confusing message: StyraInc#638 (comment) In open-policy-agent/vscode-opa#148 the regal formatter will be used if the user has enabled regal and opa fmt will be used if not. This means that there is only ever one formatter available for rego and the user will see no message. Signed-off-by: Charlie Egan <charlie@styra.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Formatting rego files using the language server is marginally faster than shelling out to the local opa binary.
Since Regal can provide formatting functionality, this should be used if available. This change alters the extension to use the formatting functionality of the Regal if the user has chosen to enable Regal.
If they disable Regal, then the opa fmt formatter will return.