add a Robo task to check git status is clean

[joachim-n]

It would be useful to have a task which returns whether the current git status is clean.

Presumably, you'd want a FALSE to possibly cause the whole robot command to fail and complain with an error, but I'm not sure how to do that.

The git command is probably:

git status --porcelain --untracked-files=no

Empty output means status is clean.

[Sweetchuck]

Thank you for your interest :-)

The result of git status is not good or bad if it is empty or not empty.
What you want is not supported out-of-box, but you can achieve it with the following:

class RoboFile extends Tasks
{
    use GitTaskLoader;

    /**
     * @command dummy:git:status
     */
    public function dummyGitStatus(): \Robo\Contract\TaskInterface
    {
        $cb = $this->collectionBuilder();

        $cb->addTask($this->taskGitStatus());
        $cb->addCode(function (\Robo\State\Data $state): int {
            return count($state['git.status']) ? 1 : 0;
        });

        return $cb;
    }
}

[Sweetchuck]

There is a problem :-)

The following used to work, but not anymore.

$this
  ->taskGitStatus()
  ->setUntrackedFiles('no');

Probably because of the new Git version.

git --version
git version 2.50.1

Currently it should be
--untracked-files='no'
instead of
--untracked-files 'no'

If this is the case then all the option (--foo=bar) is affected.

https://github.com/sweetchuck/robo-git/blob/e4d4e4d09c4e35ef266834ccf95cae9cdb02f29e/tests/unit/Task/GitStatusTaskTest.php#L89-L89

I use this project (sweetchuck/robo-git) actively in other projects but just only a few tasks with basic settings.

[Sweetchuck]

@joachim-n Could you check this branch #56, please.