feat(template-lint): Read from stdin #2622

dcyriller · 2019-06-26T15:53:05Z

Description

This PR proposes to leverage a new feature introduced in ember-template-lint v1.6: reading from stdin.

Currently, ale copies the file to a temporary file and lints it from there. But this approach has a few issues regarding the configuration files (especially .prettierrc.js).

w0rp

The reason the author is checking a temporary file is so they can check for problems with the buffer as you type. Does this linter support some sort of option to make this work properly? If it does, find out that that is and use it. If it doesn't, set 'lint_file': 1 so the linter only runs when the buffer is opened/saved.

dcyriller · 2019-07-08T17:04:53Z

Interesting! Thank you for your guidance.

Unfortunately, there is no such option with this linter. I've added the 'lint_file': 1 option.

dcyriller · 2019-07-24T14:14:45Z

It should be good now :)

dcyriller · 2019-08-19T10:59:51Z

Reading from stdin is currently being added in template-lint. Maybe we should wait for that feature and then update this PR.

w0rp · 2019-09-10T19:47:49Z

Okay, let's wait for that then. Sorry for the delay.

dcyriller · 2019-09-10T20:39:00Z

Cross-linking the wip for future reference: ember-template-lint/ember-template-lint#783

dcyriller · 2019-10-11T13:26:37Z

The above-mentioned PR has been merged in ember-template-lint.

I've updated this PR to lint from stdin. It should be good now @w0rp!

w0rp

Update the tests to handle this. I think we should add a --version check for this linter too, so it will work with older and newer versions. ale_linters/php/phpstan.vim contains some pretty good example code for running different commands for different versions.

w0rp · 2019-10-18T14:46:06Z

ale_linters/handlebars/embertemplatelint.vim

@@ -34,6 +34,6 @@ call ale#linter#Define('handlebars', {
 \   'executable': {b -> ale#node#FindExecutable(b, 'handlebars_embertemplatelint', [
 \       'node_modules/.bin/ember-template-lint',
 \   ])},
-\   'command': '%e --json %t',
+\   'command': '%e --json < %t',


If you take < %t away from the command, ALE should pipe in stdin to the command automatically. ALE does that whenever %t isn't present in the command, and the read_buffer option isn't set to 0.

Ok, I didn’t know that. I will update accordingly.

@dcyriller - We should also pass the current file name in via --filename (so that the linting rules that make changes based on filename have the correct value).

This feature has recently been implemented in ember-template-lint.

dcyriller · 2020-03-13T12:34:08Z

@w0rp it should be ready for review

dcyriller · 2020-04-13T13:27:19Z

I wound need some help to understand why the CI is failing. @w0rp is there any chance you have some time to help me on this?

jamescdavis · 2020-04-30T21:03:44Z

test/test_embertemplatelint_executable_detection.vader

+
+  AssertEqual
+  \ ale_linters#handlebars#embertemplatelint#GetCommand(bufnr(''), [2, 0, 0]),
+  \ '%e --json --filename /testplugin/test/ember-template-lint-test-files/app/template.hbs'


This fails on Windows: https://ci.appveyor.com/project/dense-analysis/ale/builds/32131713?fullLog=true#L316

Something like:

if has('win32') let g:ember_template_lint_command = \ '%e --json --filename C:\testplugin\test\ember-template-lint-test-files\app\template.hbs' else let g:ember_template_lint_command = \ '%e --json --filename /testplugin/test/ember-template-lint-test-files/app/template.hbs' endif AssertEqual \ ale_linters#handlebars#embertemplatelint#GetCommand(bufnr(''), [2, 0, 0]), \ g:ember_template_lint_command

should work.

dcyriller · 2020-05-01T21:16:31Z

Okay CI is green now, thanks a lot for your help @jamescdavis!

This PR has been tested locally by a few people I believe @w0rp. So the changes should be safe 😄. Do you mind giving it a review?

jamescdavis · 2020-05-01T22:22:22Z

Oh, that's much better than the conditional!

jamescdavis · 2020-05-02T02:02:03Z

I tested locally again with this latest change and can confirm it works.

dcyriller · 2020-08-10T13:13:21Z

friendly ping @w0rp

jamescdavis · 2020-08-13T11:10:03Z

Also ping @hsanson 😉

w0rp · 2020-08-31T08:18:27Z

This doesn't work because @% is the current filename, but the current filename might not be the same file as the one that ALE started checking earlier. I'll fix this by using the %s formatting ALE has.

ale_linters/handlebars/embertemplatelint.vim

test/test_embertemplatelint_executable_detection.vader

w0rp · 2020-08-31T08:26:44Z

Cheers! 🍻

dcyriller · 2020-08-31T10:58:59Z

Thanks a lot @w0rp !

* master: (123 commits) Add tests for maven.vim file Fix grammatical error in doc Add maven helper file; use maven wrapper if available instead of global 'mvn' executable fix lint, fix variable semantics and update tests bibclean: update matchlist reges for bibclean > v2.11.4 Bump the ALE version to 3.0.0 Close dense-analysis#2522 - Check pylint on the fly Add tests for covering the coming Vint version Close dense-analysis#3003 - Show ignored linters in :ALEInfo Close dense-analysis#3333 - Add an ALECompletePost event Fix a completion error Fix typo Close dense-analysis#3268 - Implement :ALEImport Fix dense-analysis#3183 - Escape filename characters from LSP/tsserver Clean up embertemplatelint code Fix asciidoc languagetool integration Fix dense-analysis#3322 - Apply rename changes correctly feat(template-lint): Read from stdin (dense-analysis#2622) Fix flake8 cd logic for invalid options Add tests for \r removal ...

dcyriller changed the title ~~template-lint: Lint against source file not a temp file~~ fix(template-lint): Lint against source file not a temp file Jun 26, 2019

w0rp requested changes Jul 6, 2019

View reviewed changes

w0rp added this to In Review in Old Working List via automation Jul 6, 2019

w0rp added this to In Review in On the Radar Aug 17, 2019

charlesbjohnson mentioned this pull request Sep 1, 2019

fixers/stylelint: enhance stylelint fixer #2745

Merged

w0rp requested changes Oct 18, 2019

View reviewed changes

dcyriller mentioned this pull request Nov 24, 2019

Add cli param to disable default ignores ember-template-lint/ember-template-lint#938

Closed

dcyriller added 6 commits March 13, 2020 09:30

ember-template-lint: Lint from stdin

16b4973

This feature has recently been implemented in ember-template-lint.

Refactor ember-template-lint executable

aa4a84d

Fallback on a temporary file for old template-lint

b729821

Pass filename to ember-template-lint executable

3fe4cc3

Make function name match script file name

ebf982a

Test ale_linters#handlebars#embertemplatelint#GetExecutable

0c95fcf

dcyriller requested a review from w0rp March 13, 2020 13:13

dcyriller changed the title ~~fix(template-lint): Lint against source file not a temp file~~ feat(template-lint): Read from stdin Apr 12, 2020

jamescdavis suggested changes Apr 30, 2020

View reviewed changes

This was referenced Apr 30, 2020

if unable to resolve a config from filepath, try cwd ember-template-lint/ember-template-lint-plugin-prettier#82

Closed

ALE always complains about newline at end of file ember-template-lint/ember-template-lint-plugin-prettier#83

Closed

Improve how filename is read

186a680

w0rp requested changes Aug 31, 2020

View reviewed changes

ale_linters/handlebars/embertemplatelint.vim Outdated Show resolved Hide resolved

test/test_embertemplatelint_executable_detection.vader Outdated Show resolved Hide resolved

w0rp added 2 commits August 31, 2020 09:20

Update ale_linters/handlebars/embertemplatelint.vim

e5b0f20

Update test/test_embertemplatelint_executable_detection.vader

ae335dc

w0rp merged commit d4a1474 into dense-analysis:master Aug 31, 2020

On the Radar automation moved this from In Review to Done Aug 31, 2020

dcyriller deleted the template-lint-remove-temp-file branch August 31, 2020 10:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(template-lint): Read from stdin #2622

feat(template-lint): Read from stdin #2622

dcyriller commented Jun 26, 2019 •

edited

w0rp left a comment

dcyriller commented Jul 8, 2019

dcyriller commented Jul 24, 2019

dcyriller commented Aug 19, 2019

w0rp commented Sep 10, 2019

dcyriller commented Sep 10, 2019

dcyriller commented Oct 11, 2019

w0rp left a comment

w0rp Oct 18, 2019

dcyriller Oct 21, 2019

rwjblue Mar 8, 2020

dcyriller commented Mar 13, 2020

dcyriller commented Apr 13, 2020 •

edited

jamescdavis Apr 30, 2020

jamescdavis Apr 30, 2020

dcyriller commented May 1, 2020

jamescdavis commented May 1, 2020

jamescdavis commented May 2, 2020

dcyriller commented Aug 10, 2020

jamescdavis commented Aug 13, 2020

w0rp commented Aug 31, 2020 •

edited

w0rp commented Aug 31, 2020

dcyriller commented Aug 31, 2020

feat(template-lint): Read from stdin #2622

feat(template-lint): Read from stdin #2622

Conversation

dcyriller commented Jun 26, 2019 • edited

Description

w0rp left a comment

Choose a reason for hiding this comment

dcyriller commented Jul 8, 2019

dcyriller commented Jul 24, 2019

dcyriller commented Aug 19, 2019

w0rp commented Sep 10, 2019

dcyriller commented Sep 10, 2019

dcyriller commented Oct 11, 2019

w0rp left a comment

Choose a reason for hiding this comment

w0rp Oct 18, 2019

Choose a reason for hiding this comment

dcyriller Oct 21, 2019

Choose a reason for hiding this comment

rwjblue Mar 8, 2020

Choose a reason for hiding this comment

dcyriller commented Mar 13, 2020

dcyriller commented Apr 13, 2020 • edited

jamescdavis Apr 30, 2020

Choose a reason for hiding this comment

jamescdavis Apr 30, 2020

Choose a reason for hiding this comment

dcyriller commented May 1, 2020

jamescdavis commented May 1, 2020

jamescdavis commented May 2, 2020

dcyriller commented Aug 10, 2020

jamescdavis commented Aug 13, 2020

w0rp commented Aug 31, 2020 • edited

w0rp commented Aug 31, 2020

dcyriller commented Aug 31, 2020

dcyriller commented Jun 26, 2019 •

edited

dcyriller commented Apr 13, 2020 •

edited

w0rp commented Aug 31, 2020 •

edited