[Fix] Check for staged files prior to spawning the prompt

ognjenjevremovic commented 3 years ago

Fixes #785 and #585 (since the cause of these issues was related)

Changes

Checks the staging area prior to spawning the prompt when running git-cz,
If no files are present in the staging area (prior to running git-cz command) throw "No files added to staging!" error ,
Preserve the functionality of the git -a flag (--all) - running git-cz --all should add all the changed files to the staging area prior to spawning the prompt (no error thrown),
Provided the necessary set tests for this change.

Checklist

After the changes I ensured that:

no stylistic or unwanted errors are present (by following the conventions described in the CONTRIBUTING.md),
no tests are failing, by running npm run test,
build passes with no issues, by running npm run build,
checked the build output locally by:
- initializing a new npm & git repository (mkdir test && cd test && npm init -y && git init),
- locally built the cz-cli package by running npm run build, from within cz-cli directory,
- made a few changes in the dummy project files,
- run the command node /path/to/cz-cli/project/bin/git-cz (with and without —all flag, in different case scenarios),
- ensured everything works as expected.

Done

[x] Added/updated unit tests for this change
[x] Included links to related issues/PRs

amaltson commented 3 years ago

Love this, thank you for adding it! I run into this several times a day because I'm used to running git commit -a, but forget to add -a to commitizen. It's definitely super frustrating to fill out the questionnaire and then have it do nothing b/c I forgot to stage files. This would preserve the behaviour that Git itself has:

$ git commit
On branch properly-approve-rfc-33
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   ... the files that are unstaged ...

no changes added to commit (use "git add" and/or "git commit -a")

ognjenjevremovic commented 3 years ago

Any updates on the PR review?

amaltson commented 2 years ago

Yeah this would be awesome to get a review of this, thank you!

LinusU commented 2 years ago

Thanks! Sorry for the delay on this

amaltson commented 2 years ago

👏 yay! Thank you so much! Can't wait for this to be released, appreciate all the hard work @LinusU!

github-actions[bot] commented 2 years ago

:tada: This PR is included in version 4.2.5 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

commitizen / cz-cli