Better error handling for "Clean Repo" check

[conor909]

🚀 Feature Proposal

When publishing we do a deep check on a clean "git status" object, and check it against the actual result of git.status on the path to the project we provide.

here:

releasify/lib/commands/publish.js

Line 76 in 52ffba8

assert.deepStrictEqual(compare, CLEAN_REPO, 'The git repo must be clean (committed and pushed) before releasing!')

Motivation

The issue is that no matter what the differences of the two objects is, the error prints:
The git repo must be clean (committed and pushed) before releasing!

My issue was that my branch was named "main" instead of the default "master". But the error message was throwing me off.

I propose to print the result of assert.deepStrictEqual, as it provides the expected vs. received, so it would flag up if the tracking or any other properties on those objects didn't match.

Alternatively, if we only care about the ahead & behind properties to determine the git status, we could only compare those 2 properties.

Example

   try {
      assert.deepStrictEqual(compare, CLEAN_REPO)
    } catch (err) {
      console.log(err)
    }

or something like:

  const CLEAN_REPO = {
    ahead: 0,
    behind: 0
  }

  const compare = {
    ahead: status.ahead,
    behind: status.behind
  }

  assert.deepStrictEqual(compare, CLEAN_REPO, 'The git repo must be clean (committed and pushed) before releasing!')

[capaj]

Yes, this would help quite a bit-bumped into an issue today and I had to add console.logs there

[Eomm]

Alternatively, if we only care about the ahead & behind properties to determine the git status, we could only compare those 2 properties.

This would be harmful because the subsequent commands would run against master instead of the main

Remember that you can change the default with the command

$ releasify config --arg branch -v info
# input "main"

[Aslam-13]

Hi,
I want to give it a try can you pls assign to me.

[Aslam-13]

Hi,
I have made a PR #214 kindly review it and give me a feedback if any changes is required