Rename option "--skip-noqa" to "--check-noqa" and reverse behavior

This is an incompatible change: without option, the "noqa"-commented lines are
now skipped by default (this is the way most linters work). With the option
`--check-noqa`, the "noqa"-commented lines are checked.

Author: flashcode

ChangeLog.md

@@ -3,6 +3,7 @@
 ## Version 3.2.0 (under dev)
 
 - Drop Python 2 support, Python 3.6 is now required.
+- Rename option `--skip-noqa` to `--check-noqa` and reverse behavior: without option, strings with `noqa` are now skipped by default.
 - Add support for Chinese full-stop.
 - Add lint with bandit in CI.
 

README.md

@@ -46,7 +46,7 @@ Options:
 - `-h`, `--help`: display help message and exit
 - `-c`, `--no-compile`: do not check compilation of file (with `msgfmt -c`)
 - `-f`, `--fuzzy`: check fuzzy strings
-- `-n`, `--skip-noqa`: do not check "noqa"-commented lines
+- `-n`, `--check-noqa`: check "noqa"-commented lines (they are skipped by default)
 - `-l`, `--no-lines`: do not check number of lines
 - `-p`, `--no-punct`: do not check punctuation at end of strings
 - `-s id|str`, `--spelling id|str`: check spelling (`id` = source messages, `str` = translations)

msgcheck/msgcheck.py

@@ -66,8 +66,9 @@ def msgcheck_parser():
                         help='do not check compilation of file')
     parser.add_argument('-f', '--fuzzy', action='store_true',
                         help='check fuzzy strings')
-    parser.add_argument('-n', '--skip-noqa', action='store_true',
-                        help='do not check "noqa"-commented lines')
+    parser.add_argument('-n', '--check-noqa', action='store_true',
+                        help='check "noqa"-commented lines (they are skipped '
+                        'by default)')
     parser.add_argument('-l', '--no-lines', action='store_true',
                         help='do not check number of lines')
     parser.add_argument('-p', '--no-punct', action='store_true',
@@ -118,8 +119,9 @@ def msgcheck_check_files(args):
     """Check files."""
     # create checker and set boolean options
     po_check = PoCheck()
-    for option in ('no_compile', 'fuzzy', 'skip_noqa', 'no_lines', 'no_punct',
-                   'no_whitespace', 'no_whitespace_eol', 'extract'):
+    for option in ('no_compile', 'fuzzy', 'check_noqa', 'no_lines',
+                   'no_punct', 'no_whitespace', 'no_whitespace_eol',
+                   'extract'):
         if args.__dict__[option]:
             po_check.set_check(option.lstrip('no_'),
                                not option.startswith('no_'))

msgcheck/po.py

@@ -477,7 +477,7 @@ def __init__(self):
         self.checks = {
             'compile': True,
             'fuzzy': False,
-            'skip_noqa': False,
+            'check_noqa': False,
             'lines': True,
             'punct': True,
             'whitespace': True,
@@ -587,9 +587,9 @@ def check_pofile(self, po_file):
 
         # check all messages
         check_fuzzy = self.checks['fuzzy']
-        skip_noqa = self.checks['skip_noqa']
+        check_noqa = self.checks['check_noqa']
         for msg in po_file.msgs:
-            if skip_noqa and msg.noqa:
+            if msg.noqa and not check_noqa:
                 continue
             if msg.fuzzy and not check_fuzzy:
                 continue

tests/test_msgcheck.py

@@ -114,7 +114,7 @@ def test_checks():
     assert not result[0][1]
 
     # second file has 10 errors
-    assert len(result[1][1]) == 10
+    assert len(result[1][1]) == 9
 
     # check first error
     report = result[1][1][0]
@@ -129,7 +129,7 @@ def test_checks():
             '2 in string, 1 in translation' in str(report))
 
     # check last error
-    report = result[1][1][9]
+    report = result[1][1][8]
     assert report.message == \
         'different whitespace at end of a line: 1 in string, 0 in translation'
     assert report.idmsg == 'whitespace_eol'
@@ -144,7 +144,7 @@ def test_checks():
     for report in result[1][1]:
         errors[report.idmsg] = errors.get(report.idmsg, 0) + 1
     assert errors['lines'] == 2
-    assert errors['punct'] == 2
+    assert errors['punct'] == 1
     assert errors['whitespace'] == 4
     assert errors['whitespace_eol'] == 2
 
@@ -159,20 +159,20 @@ def test_checks_fuzzy():
     assert len(result) == 1
 
     # the file has 11 errors (with the fuzzy string)
-    assert len(result[0][1]) == 11
+    assert len(result[0][1]) == 10
 
 
 def test_checks_noqa():
-    """Test checks on a gettext file ignoring `noqa`-commented lines."""
+    """Test checks on a gettext file including `noqa`-commented lines."""
     po_check = PoCheck()
-    po_check.set_check('skip_noqa', True)
+    po_check.set_check('check_noqa', True)
     result = po_check.check_files([local_path('fr_errors.po')])
 
     # be sure we have one file in result
     assert len(result) == 1
 
-    # the file has 9 errors (`noqa` was skipped)
-    assert len(result[0][1]) == 9
+    # the file has 10 errors (including `noqa`-commented lines)
+    assert len(result[0][1]) == 10
 
 
 def test_replace_fmt_c():