docs: add project setup instructions to README#18
Open
WaseemAldemeri wants to merge 1 commit into
Open
Conversation
- Document required `postgres-language-server.jsonc` config file at project root, since the language server stays inactive without it - Provide a sample config covering schema reference, linter rules, and database connection fields - Note that Zed must be reloaded to pick up the new configuration - Link to upstream Postgres Language Server docs for the full configuration reference
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Expands the README with project-setup instructions so new users know they need a
postgres-language-server.jsoncat the root of their project before the language server provides diagnostics, autocomplete, or hover.Why
The current README only covers installing the extension. Without a config file at the project root, the LSP loads but produces no feedback, which is a common source of confusion (e.g. #14). Adding a minimal, working
db-block example up front saves users from digging through upstream docs.What's included
Project Setupsection with the required filename and root-folder placementpostgres-language-server.jsoncexample with discretedbfields