Skip to content
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

Dafny project file improvements #475

Merged

Conversation

keyboardDrummer
Copy link
Member

Changes

  • No longer let the syntax definitions for .dfy files also be applied to dfyconfig.toml files
  • Activate extension when .toml file is opened, such as a dfyconfig.toml
  • Let the language client also operate on files ending in dfyconfig.toml

Testing

  • Manually tested that only opening a dfyconfig.toml will already trigger the extension and provide diagnostics.
  • Manually tested that making changing in a dfyconfig.toml file causes diagnostics to be updated
  • Manually tested that syntax highlighting for dfyconfig.toml files works correctly.

@keyboardDrummer keyboardDrummer enabled auto-merge (squash) May 8, 2024 09:51
@keyboardDrummer keyboardDrummer enabled auto-merge (squash) May 8, 2024 09:51
@@ -11,6 +11,9 @@
"bugs": {
"url": "https://github.com/dafny-lang/ide-vscode/issues"
},
"activationEvents": [
"onLanguage:toml"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't that a bit too broad? toml is not Dafny specific. This means that the Dafny extension will start even if a toml file is run that isn't a dfyconfig. Could you please create an empty .toml file and verify that it won't crash the language server somehow?

Copy link
Member Author

@keyboardDrummer keyboardDrummer May 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is too broad. I would have preferred to set the extension to activate only when the path pattern **/*dfyconfig.toml is opened, but VSCode does not support that.

However, activating too early can not lead to bugs. Which files VSCode sends to the language server is controlled in a different location, and there the filter is more specific. Activating too early does hurt VSCode performance since the extension will run startup code even when you're just working with "*.toml" files that are unrelated to Dafny.

If I leave out this activation event, then if you open a dfyconfig.toml without opening any .dfy file, the extension does not activate and you do not get diagnostics for the Dafny project you opened. This is only a slight inconvenience, but starting the extension even when you're not doing anything with Dafny is also only slightly inconvenient.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I can live with that for now.

@@ -11,6 +11,9 @@
"bugs": {
"url": "https://github.com/dafny-lang/ide-vscode/issues"
},
"activationEvents": [
"onLanguage:toml"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I can live with that for now.

@keyboardDrummer keyboardDrummer merged commit 24f83bd into dafny-lang:master May 9, 2024
4 checks passed
@keyboardDrummer keyboardDrummer deleted the dafnyProjectLanguage branch May 9, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants