Add option "-W" (or "--no-whitespace-eol") to not check trailing whitespace at end of lines inside strings

Author: flashcode

README.md

@@ -5,9 +5,10 @@
 
 * check compilation (with command `msgfmt -c`)
 * for each translation, the script can check:
-  * number of lines in translated string
-  * whitespace at beginning/end of string
-  * punctuation at end of string
+  * number of lines in translated strings
+  * whitespace at beginning/end of strings
+  * trailing whitespace at end of lines inside strings
+  * punctuation at end of strings
   * spelling
 
 The script requires Python >= 2.7.
@@ -35,12 +36,14 @@ Options:
 * `-m`, `--only-misspelled`: display only misspelled words (no error, line
   number and translation)
 * `-w`, `--no-whitespace`: do not check whitespace at beginning/end of strings
+* `-W`, `--no-whitespace-eol`: do not check whitespace at end of lines inside
+  strings
 * `-e`, `--extract`: display all translations and exit (all checks except
   compilation are disabled in this mode)
 * `-q`, `--quiet`: quiet mode: only display number of errors
 * `-v`, `--version`: display version and exit
 
-Environment variable 'MSGCHECK_OPTIONS' can be set with some default options.
+Environment variable `MSGCHECK_OPTIONS` can be set with some default options.
 
 The script returns following exit code:
   0: all files checked are OK (0 errors) (or --extract given)
@@ -70,3 +73,20 @@ The script returns following exit code:
      valeur courante
     ======================================================================
     fr.po: 3 errors (almost good!)
+
+## Copyright
+
+Copyright (C) 2009-2014 Sébastien Helleu <[email protected]>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

msgcheck.py

@@ -41,7 +41,7 @@
 except:
     pass
 
-VERSION = '2.3'
+VERSION = '2.4'
 
 
 class PoMessage:
@@ -328,6 +328,31 @@ def check_whitespace(self, msg):
                 errors += 1
         return errors
 
+    def check_whitespace_eol(self, msg):
+        """
+        Check trailing whitespace at the end of lines in a string.
+        Return the number of errors detected.
+        """
+        errors = 0
+        for mid, mstr in msg.messages:
+            if not mid or not mstr:
+                continue
+            idlines = mid.split('\n')
+            strlines = mstr.split('\n')
+            if len(idlines) < 2 or len(idlines) != len(strlines):
+                continue
+            for i in range(0, len(idlines)):
+                endin = len(idlines[i]) - len(idlines[i].rstrip(' '))
+                endout = len(strlines[i]) - len(strlines[i].rstrip(' '))
+                if (endin > 0 or endout > 0) and endin != endout:
+                    self.error(msg, mid, mstr,
+                               'different whitespace at end of a line: {0} in '
+                               'string, {1} in translation'.format(endin,
+                                                                   endout))
+                    errors += 1
+                    break
+        return errors
+
     def check_spelling(self, msg):
         """
         Check spelling.
@@ -377,6 +402,8 @@ def check(self):
                 errors += self.check_punctuation(msg)
             if not self.args.no_whitespace:
                 errors += self.check_whitespace(msg)
+            if not self.args.no_whitespace_eol:
+                errors += self.check_whitespace_eol(msg)
             if self.args.spelling:
                 errors += self.check_spelling(msg)
         return errors
@@ -419,6 +446,9 @@ def main():
     parser.add_argument('-w', '--no-whitespace', action='store_true',
                         help='do not check whitespace at beginning/end of '
                         'strings')
+    parser.add_argument('-W', '--no-whitespace-eol', action='store_true',
+                        help='do not check trailing whitespace at end of '
+                        'lines inside strings')
     parser.add_argument('-e', '--extract', action='store_true',
                         help='display all translations and exit '
                         '(all checks except compilation are disabled in this '