File not added to commit still being linted

[ivnnv]

Description

After reading the famous issue + feature #62 I think it doesn't cover the case when you have some files with changes and you want to ignore them from now (because you know they are not ready yet for committing).
But lint-staged is still checking for those files so husk rejects the commit because the file has a (known) error.

Steps to reproduce

1. I try to make a commit with all changed files, except one.

2. lint-staged runs "*.{js,jsx}": ["eslint . --fix", "git add"] and finds that DateList.js has an error (but I already know this and thats why I didnt added the file to the commit)

Theres a way to prevent this behaviour using lint-staged or may I need to manually stage the file and unstage after the commit is done?

Thanks.

Environment

• OS: macOS Mojave 10.14.6
• Node.js: v12.13.1
• lint-staged: 9.5.0
• git gui: SourceTree 3.2.1

[okonet]

That’s a faulty behavior and should not happen. Can you please run lint-stages in debug mode and add the output to the issue (as the new issue template asks you to). Thanks.

[iiroj]

I think since your command contains eslint ., it will always check every file. This might not be related to lint-staged.

Try using simply eslint --fix.

[okonet]

Ah yeah that’s a good catch. I missed that fact.

[okonet]

@iiroj since it’s a most common mistake with the library I’m wondering there is a way to detect that and warn users about wrong configuration. Ideas?

[iiroj]

@okonet we already detect git add in the v10 beta. I’m wondering if a generic soluction for matching command strings would work, like a Map(testString-> warningMessage).

[okonet]

it could I think if we’d manage the list of marchers and warnings. Not too much of the work I think.

[ivnnv]

@iiroj thanks for the suggestion, worked like a charm!

Maybe its worth mentioning this in the Readme? Honestly I just started using this tool today and the articles I read on implementing this (+ husky) suggest the ["eslint . --fix", "git add"] (with dot) rule to be added to the pre-commit.

And of course thanks @okonet for this package, I wish I applied on my repo before so I didn't woke up this morning with a broken app because last's night no-undef bug (😅)

Cheers!

[iiroj]

We do have a lot of advanced function examples, so maybe we should add some basic examples as well. I'll create a separate issue.

[okonet]

What article suggest this config? We should fix that.

[ivnnv]

What article suggest this config? We should fix that.

@okonet I meant random Medium/blog articles where people suggest how to use husky + lint-staged.
But then after reading the readme too, I didn't found any reference if whether or not I had to include the dot or not in the config line, hence my suggestion.

[okonet]

Please feel free to improve the readme based on your experience!