Avoid empty commits?

Maybe it’s an edge case but I tested lint-staged on an example where I just mis-formatted a file to see if calling eslint --fix would do the right thing. It did – the formatting error was corrected – but it also created an empty commit. This is a different behavior compared to a scenario where I would run eslint --fix manually and then attempted to commit – Git would just tell me “no changes added to commit”.

[LauraBeatris]

If you’re testing the eslint --fix command, by just adding some empty lines, producing auto fixable errors that don’t indeed add changes to the codebase, then it makes sense to be an empty commit.

By doing so, the “changes” of the commit would be fixed when running lint-staged and then, wouldn’t be any changes added to the commit.

That’s the reason to have another step after running the tasks - check if it’s a valid commit.

[YoussefZidan]

I had the same problem.

This happened to me when I tried the lint-staged scripts after filling the file with linting problems (I just added some spaces)

  "lint-staged": {
    "**/*.{js,jsx}": [
      "yarn eslint --fix",
      "prettier  --write"
    ]
  }

And lint-staged will fix the linting errors, leaving you with no modifications in the file. This will cause the following error message:

⚠ lint-staged prevented an empty git commit.
  Use the --allow-empty option to continue, or check your task configuration

Try missing some linting errors and making a modification, such as a console.log, and everything should work properly as you expected.