quarylabs / sqruff

Fast SQL formatter/linter
https://playground.quary.dev/?secondary=Format
Apache License 2.0
353 stars 14 forks source link

Include information of default dialect and dialect configuration #745

Closed concur1 closed 1 month ago

concur1 commented 1 month ago

Added information on the dialect and dialect configuration to the readme.

related issue: #740

gvozdvmozgu commented 1 month ago

You also need to update the README.MD file located at editors/code.

benfdking commented 1 month ago
cp README.md editors/code/README.md

For the update

gvozdvmozgu commented 1 month ago

I think we should inform users that they need to use 'sqruff' as the config name and for the config key names.

concur1 commented 1 month ago

I think we should inform users that they need to use 'sqruff' as the config name and for the config key names.

So change:

[sqlfluff]
dialect = SQLite

to

[sqruff]
dialect = SQLite

?

gvozdvmozgu commented 1 month ago

Yes, and also the file name. We have case-sensitive matching for the dialect name, so SQLite won't work. It should be sqlite.

concur1 commented 1 month ago

Is Sqruff compatible with all Sqlfluff config files? Should I add a note around being able to copy over a config file from Sqlfluff?

gvozdvmozgu commented 1 month ago

We strive for backward compatibility with SQLFluff; some things might not work, but overall, yes.

benfdking commented 1 month ago

Thanks for the contribution

concur1 commented 1 month ago

np, happy to help =)