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

Prepare for extension publishing #180

Merged
merged 16 commits into from
Mar 5, 2024
Merged

Prepare for extension publishing #180

merged 16 commits into from
Mar 5, 2024

Conversation

OskarDamkjaer
Copy link
Collaborator

@OskarDamkjaer OskarDamkjaer commented Feb 29, 2024

Fixes the crash when dbschema isn't passed to the signature help and prepares our package for publishing.

Updates to our package.json based on the guidelines in the docs here:
https://code.visualstudio.com/api/references/extension-manifest

I've updated some "VSCode" to "VS Code", since that's how it's usually written in docs from microsoft.

Minimized the extension bundle, now it only includes the relevant files:
CleanShot 2024-02-29 at 11 12 59

The gif needs to be referenced via https to render in the marketplace, as noted here and here. Let me know if you prefer one of the older gifs, a static image or something completely different 😄

I've also updated some wordings & descriptions, let me know what you think.

@OskarDamkjaer OskarDamkjaer changed the title prep for vscode prep for extension publishing Feb 29, 2024
@OskarDamkjaer OskarDamkjaer changed the title prep for extension publishing prepare for extension publishing Feb 29, 2024
@OskarDamkjaer OskarDamkjaer marked this pull request as ready for review February 29, 2024 15:14
@OskarDamkjaer OskarDamkjaer changed the title prepare for extension publishing Prepare for extension publishing Feb 29, 2024
"bundle": "esbuild ./src/server.ts --bundle --format=cjs --platform=node --outfile=dist/cypher-language-server.js --minify",
"bundle-worker": "esbuild ./src/lintWorker.ts --bundle --format=cjs --platform=node --outfile=dist/lintWorker.js --minify",
Copy link
Collaborator Author

@OskarDamkjaer OskarDamkjaer Feb 29, 2024

Choose a reason for hiding this comment

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

without these changes, the worker doesn't properly bundle it's imports


The following settings are available in VSCode once the plugin is installed, which can be set either through the `Settings` menu on VSCode or by creating a `.vscode/settings.json` file in the window opened by the play button.
- Easier database connection management
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add this maybe?

  • Query execution

Comment on lines 31 to 34
- `cypherLSP.neo4j.connect`: If true it will attempt to connect to a Neo4j database to retrieve data used for completions. Defaults to `true`
- `cypherLSP.neo4j.user`: Defaults to `"neo4j"`, the default user for a local Neo4j instance
- `cypherLSP.neo4j.password`: Replace this with the password for the user above
- `cypherLSP.neo4j.URL`: Defaults to `"neo4j://localhost:7687"`, the default URL for a local Neo4j instance
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to remove the cypherLSP from here.

Maybe it would be nicer to make url lower case everywhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes I agree it'd be nicer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I also changed it to be boltUrl instead, this way we don't have to rename it if we start supporting the HTTP api as well in the future


### Debug

- `cypherLSP.trace.server`: Traces the communication between VS Code and the language server for debugging purposes.
- `cypherLSP.trace.server`: Traces the communication between VS Code and the language server for debugging purposes
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same, the cypherLSP is not there anymore, they are neo4j settings

@OskarDamkjaer OskarDamkjaer merged commit 2cd3281 into main Mar 5, 2024
4 checks passed
@OskarDamkjaer OskarDamkjaer deleted the extension_prep branch March 5, 2024 15:20
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