sql-formatter-org / sql-formatter-org/sql-formatter

Feature Request: Flyway placeholder support

Open
#418 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TypeScript
Stars
2.9k
Forks
456
Avg merge
3d 4h
Merged PRs (30d)
3

Description

Describe the Feature
Flyway is a SQL migration manager and supports placeholders.

Example: ${flyway:database}

When trying to format the following string with the VS Code extension:

ALTER DATABASE ${flyway:DATABASE} CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;

It gets formatted as:

ALTER DATABASE
  $ { flyway: DATABASE } CHARACTER
SET
  = utf8mb4 COLLATE = utf8mb4_unicode_ci;

Note: The VS Code extension uses sql-formatter version 8.0.2.

Why do you want this feature?

It would be nice to be able to use placeholder variables.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported formatting of the SQL string containing ${flyway:DATABASE} and inspect the formatter's placeholder or tokenization path. No source file or test is named in the issue, so locate the relevant formatting entry point and existing tests before changing behavior. Done means the placeholder remains intact while the surrounding SQL is formatted, with regression coverage for this example.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql, typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.