[FORMATTING] Extra tabs added to multiline comments

[munkhsambuu]

Input data

Which SQL and options did you provide as input?

Select * From TABLE_NAME Where 1=1
/*
comment line1 
comment line2 
comment line3 
*/

Expected Output

Select
  *
From
  TABLE_NAME
Where
  1 = 1
  /*
  comment line1 
  comment line2 
  comment line3 
  */

Actual Output

Select
  *
From
  TABLE_NAME
Where
  1 = 1
  /*
                      comment line1 
                      comment line2 
                      comment line3 
                      */

Usage

• How are you calling / using the library? - regular
• What SQL language(s) does this apply to? - SQL
• Which SQL Formatter version are you using? - latest

Every time format is applied to the query string a new tab is appended to each line of the multiline comment (except the first line containing start of comment)

[nene]

Thanks for reporting. Unfortunately I'm unable to reproduce the exact issue.

I did notice one problem. Given the following SQL as input:

SELECT
  1
  /*
  comment line
  */

the output will contain an extra space on the last line of the comment:

SELECT
  1
  /*
  comment line
   */

This is definitely a bug, and I think I know what's causing this. Will write a fix.

However, the problem you are describing seems to be different. Could you provide more details about your setup:

• How exactly are you invoking SQL Formatter? Through JavaScript API? From command line? Through editor plugin?
• Which configuration options are you using? For example, you talk about new tabs being appended... are you perhaps using the useTabs option?
• Which exact SQL Formatter version are you using? You say you're running the latest version, do you mean 12.1.0?
• Which operating system are you running on?
• Anything else about your environment that might be useful... (NodeJS version, the exact command you're using to call the formatter).

[nene]

One factor that might influence this issue is whether your input file uses Windows-style line endings (\r\n) or UNIX style (\n).

[nene]

Given no further info, I'm closing this as: unable to reproduce.

[cbxcbx]

I also encountered the same problem. When performing multiple formatting, spaces are added to the content of the comment each time.

before：

select
  *
from
  commonData
  /*
    comment line1
    comment line2
    comment line3
  */

after:

select
  *
from
  commonData
  /*
         comment line1
         comment line2
         comment line3
  */

version: sql-prettier: "0.1.12"
usage: sqlPrettier.format(value, { custom: this.formatRules })

[nene]

I guess you're using sql-prettier, which is a super-outdated fork of this library. I can't help with that.

[cbxcbx]

I guess you're using sql-prettier, which is a super-outdated fork of this library. I can't help with that.

OK, I tried to use the latest version of sql-formatter, and it seems that there is no such problem. However, some syntax in my editor will be recognized as illegal keywords. I would like to ask you, is there a more conservative version when upgrading from sql-prettier to sql-formatter?

[nene]

Check that you've specified the SQL dialect that you're formatting: https://github.com/sql-formatter-org/sql-formatter?tab=readme-ov-file#parse-error-unexpected--at-line-

See supported dialects.

If you're still running into problems, please open a new issue.