feat: throw error to prevent empty commits unless --allow-empty is used

[iiroj]

BREAKING CHANGE: Previously, lint-staged would allow empty commits in the situation where a linter task like "prettier --write" reverts all staged changes automatically. Now the default behaviour is to throw an error with a helpful warning message. The --allow empty option can be used to allow empty commits, or allowEmpty: true for the Node.js API.

What do you think, @okonet?

[codecov]

Codecov Report

Merging #762 into beta will not change coverage.
The diff coverage is 100%.

@@         Coverage Diff         @@
##           beta   #762   +/-   ##
===================================
  Coverage   100%   100%           
===================================
  Files        13     13           
  Lines       417    429   +12     
  Branches     90     97    +7     
===================================
+ Hits        417    429   +12

Impacted Files	Coverage Δ
lib/runAll.js	100% <100%> (ø)	⬆️
lib/gitWorkflow.js	100% <100%> (ø)	⬆️
lib/index.js	100% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 30b4809...fa2cb8a. Read the comment docs.

[okonet]

I love it!

[okonet]

🎉 This PR is included in version 10.0.0-beta.15 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[okonet]

🎉 This PR is included in version 10.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[Frozen-byte]

I do not understand properly how to migrate this change.

Previously I had the following config (git add already removed):

"lint-staged": {
    "app/javascript/**/*.{css,scss}": [
      "./node_modules/.bin/prettier --write"
    ],
    "app/javascript/**/*.{js,jsx}": [
      "./node_modules/.bin/eslint --fix",
      "./node_modules/.bin/prettier --write",
      "./node_modules/.bin/esplint --stage-record-file"
    ]
  }

When I submit a commit with version ^10 with only JSX changes, I will see an error.

I do not want to merge these blocks, due eslint and esplint should not be executed for CSS files.

I am not aware if the following

"lint-staged": {
    "app/javascript/**/*.{css,scss,js,jsx}": [
      "./node_modules/.bin/prettier --write"
    ],
    "app/javascript/**/*.{js,jsx}": [
      "./node_modules/.bin/eslint --fix",
      "./node_modules/.bin/esplint --stage-record-file"
    ]
  }

still ensures prettier is called after eslint and before esplint.

Any Conclusions how to handle it aside just adding allowEmpty: true to my config?

[jinggk]

@Frozen-byte i have the same problem, how can i make allowEmpty work with my .lintstagedrc.js file, anyone know?

[iiroj]

you should add the cli flag to the command where you invoke lint-staged itself, maybe from husky:

{
    "husky": {
        "pre-commit": "lint-staged --allow-empty"
    }
}

[jinggk]

I tried it but it seems useless

[iiroj]

@jinggk That's too bad to hear. Do you mean it didn't work, or that the feature itself is useless? Make sure have the latest version of lint-staged, at the time of this comment v10.1.3.

[jinggk]

@iiroj thank you, i confirm my error again, the detail is:

husky > pre-commit (node v12.16.1)
  ✖ Preparing...
    → You do not have the initial commit yet
  ↓ Running tasks... [skipped]
    → Skipped because of previous git error.
  ↓ Applying modifications... [skipped]
    → Skipped because of previous git error.
  ↓ Cleaning up... [skipped]
    → Skipped because of previous git error.

  ✖ lint-staged failed due to a git error.

    The initial commit is needed for lint-staged to work.
    Please use the --no-verify flag to skip running lint-staged.
fatal: bad revision 'HEAD'
fatal: bad revision 'HEAD'
fatal: Needed a single revision
You do not have the initial commit yet
husky > pre-commit hook failed (add --no-verify to bypass)

my configs file content:

module.exports = {
  hooks: {
    'pre-commit': 'lint-staged --allow-empty',
  },
};
module.exports = {
  "*.{gql,html,json,yaml,yml,css,less,js,jsx,ts,tsx}": [
    "prettier --write"
  ],
  "*.{js,jsx,ts,tsx}": [
    "eslint -c .eslintrc.pro.js"
  ]
}

and here is my operation detail:

mkdir test 
cd test
yarn init -y
git init
mkdir src
touch an index.js and write some js content
add my configs 
then git add .
git commit -m 'test. commit'

then the error show

i do not understand why i need an initial commit?? when i add staged, i think it's enough.. can you help me?

add my package.json version

  "husky": "^4.2.5",
   "lint-staged": "^10.1.3"

[iiroj]

@jinggk different issue, please see the PR that fixes this: #838

Currently lint-staged creates a backup using git stash, and that command requires at least the initial commit.

[jinggk]

@iiroj very thank you ,i will check it