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

refactor: sasslint linter #2077

Merged
merged 3 commits into from Dec 6, 2018
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 23 additions & 4 deletions ale_linters/sass/sasslint.vim
@@ -1,9 +1,28 @@
" Author: KabbAmine - https://github.com/KabbAmine,
" Ben Falconer <ben@falconers.me.uk>
" Author: sQVe - https://github.com/sQVe

call ale#Set('sass_sasslint_executable', 'sass-lint')
call ale#Set('sass_sasslint_options', '')
call ale#Set('sass_sasslint_use_global', get(g:, 'ale_use_global_executables', 0))

function! ale_linters#sass#sasslint#GetExecutable(buffer) abort
return ale#node#FindExecutable(a:buffer, 'sass_sasslint', [
\ 'node_modules/sass-lint/bin/sass-lint.js',
\ 'node_modules/.bin/sass-lint',
\])
endfunction

function! ale_linters#sass#sasslint#GetCommand(buffer) abort
let l:executable = ale_linters#sass#sasslint#GetExecutable(a:buffer)
let l:options = ale#Var(a:buffer, 'sass_sasslint_options')

return ale#node#Executable(a:buffer, l:executable)
\ . (!empty(l:options) ? ' ' . l:options : '')
\ . ' -v -q -f compact %t'
endfunction

call ale#linter#Define('sass', {
\ 'name': 'sasslint',
\ 'executable': 'sass-lint',
\ 'command_callback': 'ale#handlers#sasslint#GetCommand',
\ 'executable_callback': 'ale_linters#sass#sasslint#GetExecutable',
\ 'command_callback': 'ale_linters#sass#sasslint#GetCommand',
\ 'callback': 'ale#handlers#css#HandleCSSLintFormat',
\})
28 changes: 19 additions & 9 deletions ale_linters/scss/sasslint.vim
@@ -1,18 +1,28 @@
" Author: KabbAmine - https://github.com/KabbAmine, Ben Falconer
" <ben@falconers.me.uk>
" Author: sQVe - https://github.com/sQVe

call ale#Set('scss_sasslint_executable', 'sass-lint')
call ale#Set('scss_sasslint_options', '')
call ale#Set('scss_sasslint_use_global', get(g:, 'ale_use_global_executables', 0))

function! ale_linters#scss#sasslint#GetExecutable(buffer) abort
return ale#node#FindExecutable(a:buffer, 'scss_sasslint', [
\ 'node_modules/sass-lint/bin/sass-lint.js',
\ 'node_modules/.bin/sass-lint',
\])
endfunction

function! ale_linters#scss#sasslint#GetCommand(buffer) abort
return ale#path#BufferCdString(a:buffer)
\ . ale#Escape('sass-lint')
\ . ' -v'
\ . ' -q'
\ . ' -f compact'
\ . ' %t'
let l:executable = ale_linters#scss#sasslint#GetExecutable(a:buffer)
let l:options = ale#Var(a:buffer, 'scss_sasslint_options')

return ale#node#Executable(a:buffer, l:executable)
\ . (!empty(l:options) ? ' ' . l:options : '')
\ . ' -v -q -f compact %t'
endfunction

call ale#linter#Define('scss', {
\ 'name': 'sasslint',
\ 'executable': 'sass-lint',
\ 'executable_callback': 'ale_linters#scss#sasslint#GetExecutable',
\ 'command_callback': 'ale_linters#scss#sasslint#GetCommand',
\ 'callback': 'ale#handlers#css#HandleCSSLintFormat',
\})
8 changes: 0 additions & 8 deletions autoload/ale/handlers/sasslint.vim

This file was deleted.

6 changes: 6 additions & 0 deletions doc/ale-sass.txt
Expand Up @@ -2,6 +2,12 @@
ALE SASS Integration *ale-sass-options*


===============================================================================
sasslint *ale-sass-sasslint*

See |ale-scss-sasslint| for information about the available options.


===============================================================================
stylelint *ale-sass-stylelint*

Expand Down
27 changes: 27 additions & 0 deletions doc/ale-scss.txt
Expand Up @@ -8,6 +8,33 @@ prettier *ale-scss-prettier*
See |ale-javascript-prettier| for information about the available options.


===============================================================================
sasslint *ale-scss-sasslint*

g:ale_scss_sasslint_executable *g:ale_scss_sasslint_executable*
*b:ale_scss_sasslint_executable*
Type: |String|
Default: `'sass-lint'`

See |ale-integrations-local-executables|


g:ale_scss_sasslint_options *g:ale_scss_sasslint_options*
*b:ale_scss_sasslint_options*
Type: |String|
Default: `''`

This variable can be set to pass additional options to sass-lint.


g:ale_scss_sasslint_use_global *g:ale_scss_sasslint_use_global*
*b:ale_scss_sasslint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`

See |ale-integrations-local-executables|


===============================================================================
stylelint *ale-scss-stylelint*

Expand Down
2 changes: 2 additions & 0 deletions doc/ale.txt
Expand Up @@ -288,13 +288,15 @@ CONTENTS *ale-contents*
rustc...............................|ale-rust-rustc|
rustfmt.............................|ale-rust-rustfmt|
sass..................................|ale-sass-options|
sasslint............................|ale-sass-sasslint|
stylelint...........................|ale-sass-stylelint|
scala.................................|ale-scala-options|
sbtserver...........................|ale-scala-sbtserver|
scalafmt............................|ale-scala-scalafmt|
scalastyle..........................|ale-scala-scalastyle|
scss..................................|ale-scss-options|
prettier............................|ale-scss-prettier|
sasslint............................|ale-scss-sasslint|
stylelint...........................|ale-scss-stylelint|
sh....................................|ale-sh-options|
sh-language-server..................|ale-sh-language-server|
Expand Down
43 changes: 43 additions & 0 deletions test/command_callback/test_sass_sasslint_command_callback.vader
@@ -0,0 +1,43 @@
Before:
call ale#assert#SetUpLinterTest('sass', 'sasslint')
call ale#test#SetFilename('test.sass')
unlet! b:executable

After:
call ale#assert#TearDownLinterTest()

Execute(should default to source, bin/sass-lint.js):
call ale#test#SetFilename('sasslint-test-files/with-source/test.sass')

let b:executable = ale#path#Simplify(
\ g:dir
\ . '/sasslint-test-files/with-source/node_modules/sass-lint/bin/sass-lint.js'
\)

AssertLinter b:executable,
\ (has('win32') ? 'node.exe ' : '')
\ . ale#Escape(b:executable)
\ . ' -v -q -f compact %t'

Execute(should fallback to bin, .bin/sass-lint):
call ale#test#SetFilename('sasslint-test-files/with-bin/test.sass')

let b:executable = ale#path#Simplify(
\ g:dir
\ . '/sasslint-test-files/with-bin/node_modules/.bin/sass-lint'
\)

AssertLinter b:executable, ale#Escape(b:executable) . ' -v -q -f compact %t'

Execute(should fallback to global bin):
AssertLinter 'sass-lint', ale#Escape('sass-lint') . ' -v -q -f compact %t'

Execute(The global executable should be configurable):
let b:ale_sass_sasslint_executable = 'foo'

AssertLinter 'foo', ale#Escape('foo') . ' -v -q -f compact %t'

Execute(The options should be configurable):
let b:ale_sass_sasslint_options = '--bar'

AssertLinter 'sass-lint', ale#Escape('sass-lint') . ' --bar -v -q -f compact %t'
11 changes: 0 additions & 11 deletions test/command_callback/test_sasslint_command_callback.vader

This file was deleted.

43 changes: 43 additions & 0 deletions test/command_callback/test_scss_sasslint_command_callback.vader
@@ -0,0 +1,43 @@
Before:
call ale#assert#SetUpLinterTest('scss', 'sasslint')
call ale#test#SetFilename('test.scss')
unlet! b:executable

After:
call ale#assert#TearDownLinterTest()

Execute(should default to source, bin/sass-lint.js):
call ale#test#SetFilename('sasslint-test-files/with-source/test.scss')

let b:executable = ale#path#Simplify(
\ g:dir
\ . '/sasslint-test-files/with-source/node_modules/sass-lint/bin/sass-lint.js'
\)

AssertLinter b:executable,
\ (has('win32') ? 'node.exe ' : '')
\ . ale#Escape(b:executable)
\ . ' -v -q -f compact %t'

Execute(should fallback to bin, .bin/sass-lint):
call ale#test#SetFilename('sasslint-test-files/with-bin/test.scss')

let b:executable = ale#path#Simplify(
\ g:dir
\ . '/sasslint-test-files/with-bin/node_modules/.bin/sass-lint'
\)

AssertLinter b:executable, ale#Escape(b:executable) . ' -v -q -f compact %t'
sQVe marked this conversation as resolved.
Show resolved Hide resolved

Execute(should fallback to global bin):
AssertLinter 'sass-lint', ale#Escape('sass-lint') . ' -v -q -f compact %t'

Execute(The global executable should be configurable):
let b:ale_scss_sasslint_executable = 'foo'

AssertLinter 'foo', ale#Escape('foo') . ' -v -q -f compact %t'

Execute(The options should be configurable):
let b:ale_scss_sasslint_options = '--bar'

AssertLinter 'sass-lint', ale#Escape('sass-lint') . ' --bar -v -q -f compact %t'