Skip to content

fix: scope postgres array suffix spacing #2780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mtibben wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: scope postgres array suffix spacing #2780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/lib-core/src/dialects/syntax.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ pub enum SyntaxKind {
IntervalExpression,
ArrayType,
SizedArrayType,
ArrayTypeSuffix,
SelectStatement,
OverlapsClause,
SelectClause,
Expand Down
26 changes: 18 additions & 8 deletions crates/lib-dialects/src/postgres.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,14 +281,7 @@ fn build_datatype_segment_grammar(pgvector: bool) -> Matchable {
])
.to_matchable(),
one_of(vec![
AnyNumberOf::new(vec![
Bracketed::new(vec![
Ref::new("ExpressionSegment").optional().to_matchable(),
])
.config(|this| this.bracket_type("square"))
.to_matchable(),
])
.to_matchable(),
Ref::new("ArrayTypeSuffixSegment").to_matchable(),
Ref::new("ArrayTypeSegment").to_matchable(),
Ref::new("SizedArrayTypeSegment").to_matchable(),
])
Expand Down Expand Up @@ -1162,6 +1155,23 @@ pub fn raw_dialect() -> Dialect {
.into(),
)]);

postgres.add([(
"ArrayTypeSuffixSegment".into(),
NodeMatcher::new(SyntaxKind::ArrayTypeSuffix, |_| {
AnyNumberOf::new(vec![
Bracketed::new(vec![
Ref::new("ExpressionSegment").optional().to_matchable(),
])
.config(|this| this.bracket_type("square"))
.to_matchable(),
])
.config(|this| this.min_times(1))
.to_matchable()
})
.to_matchable()
.into(),
)]);

postgres.replace_grammar("DatatypeSegment", build_datatype_segment_grammar(false));

postgres.replace_grammar("ArrayTypeSegment", Ref::keyword("ARRAY").to_matchable());
Expand Down
36 changes: 20 additions & 16 deletions crates/lib-dialects/test/fixtures/dialects/postgres/sqlfluff/array.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,19 @@ file:
- naked_identifier: pay_by_quarter
- data_type:
- keyword: integer
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- comma: ','
- column_reference:
- naked_identifier: schedule
- data_type:
- keyword: text
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- end_bracket: )
- statement_terminator: ;
- statement:
Expand All @@ -94,14 +96,15 @@ file:
- naked_identifier: squares
- data_type:
- keyword: integer
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- end_bracket: )
- statement_terminator: ;
- statement:
Expand Down Expand Up @@ -587,8 +590,9 @@ file:
- casting_operator: '::'
- data_type:
- keyword: int
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- alias_expression:
- keyword: AS
- naked_identifier: f1
Expand Down
9 changes: 5 additions & 4 deletions crates/lib-dialects/test/fixtures/dialects/postgres/sqlfluff/create_table.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,11 @@ file:
- naked_identifier: vector
- data_type:
- keyword: int
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- end_bracket: )
- statement_terminator: ;
- statement:
Expand Down
15 changes: 9 additions & 6 deletions crates/lib-dialects/test/fixtures/dialects/postgres/sqlfluff/create_view.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,8 +505,9 @@ file:
- casting_operator: '::'
- data_type:
- keyword: INTEGER
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- alias_expression:
- keyword: AS
- quoted_identifier: '"ancestors"'
Expand All @@ -529,8 +530,9 @@ file:
- casting_operator: '::'
- data_type:
- keyword: text
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- alias_expression:
- keyword: AS
- quoted_identifier: '"path"'
Expand All @@ -549,8 +551,9 @@ file:
- casting_operator: '::'
- data_type:
- keyword: INTEGER
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- alias_expression:
- keyword: AS
- quoted_identifier: '"path_nodes"'
Expand Down
40 changes: 22 additions & 18 deletions crates/lib-dialects/test/fixtures/dialects/postgres/sqlfluff/datatypes.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,39 +639,43 @@ file:
- naked_identifier: a
- data_type:
- keyword: integer
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- comma: ','
- column_reference:
- naked_identifier: b
- data_type:
- keyword: float
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- end_square_bracket: ']'
- start_square_bracket: '['
- end_square_bracket: ']'
- comma: ','
- column_reference:
- naked_identifier: c
- data_type:
- keyword: char
- start_square_bracket: '['
- expression:
- numeric_literal: '1'
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- expression:
- numeric_literal: '1'
- end_square_bracket: ']'
- comma: ','
- column_reference:
- naked_identifier: d
- data_type:
- keyword: jsonb
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- start_square_bracket: '['
- expression:
- numeric_literal: '5'
- end_square_bracket: ']'
- array_type_suffix:
- start_square_bracket: '['
- expression:
- numeric_literal: '3'
- end_square_bracket: ']'
- start_square_bracket: '['
- expression:
- numeric_literal: '5'
- end_square_bracket: ']'
- comma: ','
- column_reference:
- naked_identifier: e
Expand Down
4 changes: 4 additions & 0 deletions crates/lib/src/core/default_config.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ spacing_within = touch
[sqruff:layout:type:sized_array_type]
spacing_within = touch

[sqruff:layout:type:array_type_suffix]
spacing_before = touch:inline
spacing_within = touch:inline

[sqruff:layout:type:struct_type]
spacing_within = touch:inline

Expand Down
21 changes: 21 additions & 0 deletions crates/lib/test/fixtures/rules/std_rule_cases/LT01-excessive.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,20 @@ test_bigquery_datatype:
core:
dialect: bigquery

test_bigquery_array_literal_spacing:
pass_str: |
SELECT [1, 2, 3] AS arr
configs:
core:
dialect: bigquery

test_duckdb_array_literal_spacing:
pass_str: |
SELECT [1, 2, 3] AS arr
configs:
core:
dialect: duckdb

test_athena_datatype:
pass_str: |
select
Expand Down Expand Up @@ -340,6 +354,13 @@ test_sparksql_datatype:
core:
dialect: sparksql

test_sparksql_array_literal_spacing:
pass_str: |
SELECT [1, 2, 3] AS arr
configs:
core:
dialect: sparksql

test_exasol_datatype:
pass_str: |
select
Expand Down
Loading