Add psql dialect in editor #6065
Conversation
jorg-vr
added
the
enhancement
WalkthroughThe pull request introduces PostgreSQL language support to the editor by adding a new language configuration in the Changes
Assessment against linked issues
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
app/assets/javascripts/editor.ts (1)
180-181: Consider following the naming convention.Other language configurations in the file use uppercase for language names (e.g., "R", "Prolog", "C#"). Consider using "PostgreSQL" instead of "postgresql" for consistency.
- name: "postgresql", + name: "PostgreSQL",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
app/assets/javascripts/editor.ts(1 hunks)
🔇 Additional comments (2)
app/assets/javascripts/editor.ts (2)
179-186: LGTM on the dialect implementation!The implementation correctly uses the PostgreSQL dialect from
@codemirror/lang-sql. This will provide proper syntax highlighting and language features specific to PostgreSQL.
179-186: Consider potential extension conflict with generic SQL.The configuration uses the generic
.sqlextension which might conflict with other SQL dialects. Consider if we need to handle precedence between different SQL dialects.Let's check if there's any existing SQL language support that might conflict:
✅ Verification successful
No SQL dialect conflicts found in the codebase.
The
.sqlextension is uniquely associated with the PostgreSQL configuration, and there are no other SQL dialects or conflicting language configurations present. The implementation is safe to proceed as is.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for other SQL language configurations rg -A 5 "name: .*(sql|SQL)"Length of output: 431
Script:
#!/bin/bash # Search for .sql extension usage echo "=== Searching for .sql extension usage ===" rg -B 5 'extensions: \[.*"sql".*\]' echo -e "\n=== Searching for language configuration array ===" ast-grep --pattern 'const additionalLanguages = [ $$$ ]'Length of output: 2827
| LanguageDescription.of({ | ||
| name: "postgresql", | ||
| alias: ["psql"], | ||
| extensions: ["sql"], | ||
| load() { | ||
| return import("@codemirror/lang-sql").then(m => m.sql({ dialect: m.PostgreSQL })); | ||
| } | ||
| }) |
There was a problem hiding this comment.
💡 Codebase verification
Add missing direct dependency to package.json
Add @codemirror/lang-sql to your package.json dependencies:
{
"dependencies": {
"@codemirror/lang-sql": "^6.0.0"
}
}🔗 Analysis chain
Verify package dependency.
Ensure that @codemirror/lang-sql is added as a dependency in the project's package.json.
Let's verify the dependency:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the package is listed in package.json
jq '.dependencies["@codemirror/lang-sql"] // .devDependencies["@codemirror/lang-sql"]' package.json
# Check if the package is imported elsewhere
rg "@codemirror/lang-sql"
Length of output: 482
This pull request adds support for the psql dialect in the editor.
As this comes on top of our genric sql support, we'll have to create a new programming language on dodona.be that uses psql or postgresql as key for the editor.
Closes #5948