Gitlog fails when the subject or body includes quotation marks #101

Activity

1. nburana commented on Feb 17, 2015

   

   nburana

   on Feb 17, 2015

   More actions

   Having the same issue. In the meantime is there a way that client code can specify the format to remove subject and body?
2. nburana commented on Feb 17, 2015

   

   nburana

   on Feb 17, 2015

   More actions

   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--'
   }
   }
   }
   }
3. am commented on Feb 17, 2015

   

   am

   on Feb 17, 2015

   Author

   More actions

   @nburana the problem persists if you need that field...
4. nburana commented on Feb 17, 2015

   

   nburana

   on Feb 17, 2015

   More actions

   Yeah totally. We just needed the hash and the date so this worked for us.
5. am commented on Feb 17, 2015

   

   am

   on Feb 17, 2015

   Author

   More actions

   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?
6. dbrill commented on Oct 21, 2019

   

   dbrill

   on Oct 21, 2019

   Last edited by dbrill

   More actions

   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.