Skip to content
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.

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

Add support for sqlfluff 3.0.0 #4743

Merged
merged 1 commit into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 42 additions & 14 deletions ale_linters/sql/sqlfluff.vim
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ function! ale_linters#sql#sqlfluff#Executable(buffer) abort
return ale#Var(a:buffer, 'sql_sqlfluff_executable')
endfunction

function! ale_linters#sql#sqlfluff#Command(buffer) abort
function! ale_linters#sql#sqlfluff#Command(buffer, version) abort
let l:executable = ale_linters#sql#sqlfluff#Executable(a:buffer)
let l:options = ale#Var(a:buffer, 'sql_sqlfluff_options')

Expand All @@ -35,7 +35,7 @@ function! ale_linters#sql#sqlfluff#Command(buffer) abort
return l:cmd
endfunction

function! ale_linters#sql#sqlfluff#Handle(buffer, lines) abort
function! ale_linters#sql#sqlfluff#Handle(buffer, version, lines) abort
let l:output = []
let l:json_lines = ale#util#FuzzyJSONDecode(a:lines, [])

Expand All @@ -50,23 +50,51 @@ function! ale_linters#sql#sqlfluff#Handle(buffer, lines) abort
return l:output
endif

for l:violation in get(l:json, 'violations', [])
call add(l:output, {
\ 'filename': l:json.filepath,
\ 'lnum': l:violation.line_no,
\ 'col': l:violation.line_pos,
\ 'text': l:violation.description,
\ 'code': l:violation.code,
\ 'type': 'W',
\})
endfor
if ale#semver#GTE(a:version, [3, 0, 0])
for l:violation in get(l:json, 'violations', [])
call add(l:output, {
\ 'filename': l:json.filepath,
\ 'lnum': l:violation.start_line_no,
\ 'end_lnum': l:violation.end_line_no,
\ 'col': l:violation.start_line_pos,
\ 'end_col': l:violation.end_line_pos,
\ 'text': l:violation.description,
\ 'code': l:violation.code,
\ 'type': 'W',
\})
endfor
else
for l:violation in get(l:json, 'violations', [])
call add(l:output, {
\ 'filename': l:json.filepath,
\ 'lnum': l:violation.line_no,
\ 'col': l:violation.line_pos,
\ 'text': l:violation.description,
\ 'code': l:violation.code,
\ 'type': 'W',
\})
endfor
endif

return l:output
endfunction

call ale#linter#Define('sql', {
\ 'name': 'sqlfluff',
\ 'executable': function('ale_linters#sql#sqlfluff#Executable'),
\ 'command': function('ale_linters#sql#sqlfluff#Command'),
\ 'callback': 'ale_linters#sql#sqlfluff#Handle',
\ 'command': {buffer -> ale#semver#RunWithVersionCheck(
\ buffer,
\ ale_linters#sql#sqlfluff#Executable(buffer),
\ '%e --version',
\ function('ale_linters#sql#sqlfluff#Command'),
\ )},
\ 'callback': {buffer, lines -> ale#semver#RunWithVersionCheck(
\ buffer,
\ ale_linters#sql#sqlfluff#Executable(buffer),
\ '%e --version',
\ {buffer, version -> ale_linters#sql#sqlfluff#Handle(
\ buffer,
\ l:version,
\ lines)},
\ )},
\})
42 changes: 40 additions & 2 deletions test/handler/test_sql_sqlfluff_handler.vader
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Before:
After:
call ale#linter#Reset()

Execute(The sqlfluff handler should handle basic warnings):
Execute(The sqlfluff handler should handle basic warnings with version older than 3.0.0):
AssertEqual
\ [
\ {
Expand Down Expand Up @@ -32,6 +32,44 @@ Execute(The sqlfluff handler should handle basic warnings):
\ 'text': 'Files must end with a single trailing newline.',
\ },
\ ],
\ ale_linters#sql#sqlfluff#Handle(1, [
\ ale_linters#sql#sqlfluff#Handle(bufnr(''), [2, 3, 5], [
\ '[{"filepath": "schema.sql", "violations": [{"line_no": 1, "line_pos": 8, "code": "L010", "description": "Keywords must be consistently upper case."}, {"line_no": 13, "line_pos": 2, "code": "L003", "description": "Expected 1 indentation, found 0 [compared to line 12]"}, {"line_no": 16, "line_pos": 1, "code": "L009", "description": "Files must end with a single trailing newline."}]}]',
\ ])

Execute(The sqlfluff handler should handle basic warnings with version newer than 3.0.0):
AssertEqual
\ [
\ {
\ 'filename': 'schema.sql',
\ 'lnum': 1,
\ 'end_lnum': 1,
\ 'col': 8,
\ 'end_col': 12,
\ 'type': 'W',
\ 'code': 'L010',
\ 'text': 'Keywords must be consistently upper case.',
\ },
\ {
\ 'filename': 'schema.sql',
\ 'lnum': 13,
\ 'end_lnum': 13,
\ 'col': 2,
\ 'end_col': 20,
\ 'type': 'W',
\ 'code': 'L003',
\ 'text': 'Expected 1 indentation, found 0 [compared to line 12]',
\ },
\ {
\ 'filename': 'schema.sql',
\ 'lnum': 16,
\ 'end_lnum': 16,
\ 'col': 1,
\ 'end_col': 5,
\ 'type': 'W',
\ 'code': 'L009',
\ 'text': 'Files must end with a single trailing newline.',
\ },
\ ],
\ ale_linters#sql#sqlfluff#Handle(bufnr(''), [3, 0, 0], [
\ '[{"filepath": "schema.sql", "violations": [{"start_line_no": 1, "end_line_no":1, "start_line_pos": 8, "end_line_pos":12, "code": "L010", "description": "Keywords must be consistently upper case."}, {"start_line_no": 13, "end_line_no":13, "start_line_pos": 2, "end_line_pos":20, "code": "L003", "description": "Expected 1 indentation, found 0 [compared to line 12]"}, {"start_line_no": 16, "end_line_no":16, "start_line_pos": 1, "end_line_pos":5, "code": "L009", "description": "Files must end with a single trailing newline."}]}]',
\ ])