Gitlog fails when the subject or body includes quotation marks

[am]

When running the task it fails with the following error:

Warning: Log failed to match exepected pattern:
{
  "hash": "60dc76bd83bfaf1a9380683369398863847d51e6",
  "author": {
    "name": "foo",
    "email": "[email protected]"
  },
  "date": "Tue, 10 Feb 2015 10:12:42 +0100",
  "subject": "Merge pull request #705 from io/joe/123",
  "body": "Fixes boo "word" bar"
}

Is there any way to escape the values before parsing the json?

[nburana]

Having the same issue. In the meantime is there a way that client code can specify the format to remove subject and body?

[nburana]

In case this helps anyone, you can set the format in the config file to exclude subject and body (assuming you dont need it) and it wont break the json parser.

module.exports = function (options) {
return {
head: {
options: {
prop: 'gitlog.head.result',
number: 1,
pretty: 'format:{%n' +
' "hash": "%H",%n' + // commit hash
' "author": {%n' +
' "name": "%an",%n' + // author
' "email": "%ae"%n' + // email
' },%n' +
' "date": "%aD"%n' + // date
'}%n' +
'--grunt-gitlog-separator--'
}
}
}
}

[am]

@nburana the problem persists if you need that field...

[nburana]

Yeah totally. We just needed the hash and the date so this worked for us.

[am]

Looking into the source-code it will be difficult to fix this if we don't do a more granular parsing of the git log output.
When logging a range of commits the handleResult method will receive a string that almost have the complete format of a JSON. This is where the problem starts, since it's now too late to redefine the parsing.
Looking into a similar question in SO the solution implies that we parse each commit individually, even more, for each field we want to get there is a git log for that:

function escape_chars {
    sed -r 's/(\{\}")/\\\1/g'
}
function format {
    sha=$(git log -n1 --pretty=format:%h $1 | escape_chars)
    message=$(git log -n1 --pretty=format:%B $1 | escape_chars)
    author=$(git log -n1 --pretty=format:'%aN <%aE>' $1 | escape_chars)
    commit=$(git log -n1 --pretty=format:%cE $1 | escape_chars)
    date=$(git log -n1 --pretty=format:%cD $1 | escape_chars)
    echo "{\"sha\":\"$sha\",\"message\":\"$message\",\"author\":\"$author\",\"commit\":\"$commit\",\"date\":\"$date\"}"
}

for hash in $(git rev-list)
do
  format $hash
done

Not sure if this would be too much overhead for this task.
Any thoughts?

[dbrill]

Has anyone found a reasonable work around for this.

Would anyone benefit from me submitting a PR? If this comment gets a reasonable amount of notice I'll submit something.