Format .sqlx files in your Dataform project using sqlfluff

To format a file or directory run

formatdataform format <path_to_file_or_directory>

You can override the default sqlfluff config file by using the --config flag or -c (shorthand) as follows

formatdataform -c <path_to_sqlfluff_config_file> format <path_to_file_or_directory>

Or alternatively, you can directly edit the sqlfluff config file generated in .formatdataform/.sqlfluff

1. Prerequisite: Install sqlfluff

pip install sqlfluff

2. Install the Latest release of formatdataform binary

curl -sSfL https://raw.githubusercontent.com/ashish10alex/formatdataform/main/install_latest.sh | bash

OR

go install github.com/ashish10alex/formatdataform@latest

This installs the binary formatdataform to $GOBIN, which defaults to $GOPATH/bin

OR

Manually clone the repository and build the cli and add the cli to your system path

git clone https://github.com/ashish10alex/formatdataform.git
go build -o formatdataform
mv formatdataform /usr/local/bin/formatdataform

1. Install gotestsum for prettier test visualization
2. Run gotestsum --format testname

1. sqlfluff expect the table name to have backticks i.e `gcp_project_id.dataset.table` instead of gcp_project_id.dataset.table
2. Does not format sql in pre_operations block. To handle this we would need to identify if there is a javascript block inside the pre_operations block and then get the query out of that block and format it
3. Does not format config block