Tweaks to get VSCode's internal linters to quit whinging and make the… (MetOffice#173)

* Tweaks to get VSCode's internal linters to quit whinging and make the ToDo plugin work nicely.

* Touch O Tidying and ToDo commenting.

* reviewer request to Update script_umdp3_checker/umdp3_conformance.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Update script_umdp3_checker/umdp3_checker_rules.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Update script_umdp3_checker/umdp3_checker_rules.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Update script_umdp3_checker/umdp3_checker_rules.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Update script_umdp3_checker/umdp3_checker_rules.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Update script_umdp3_checker/umdp3_checker_rules.py

Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

* Rreviwer requested changes that I was unable to commit via GitHub's web interface

---------

Co-authored-by: Pierre Siddall <43399998+Pierre-siddall@users.noreply.github.com>
Co-authored-by: Erica Neininger <107684099+ericaneininger@users.noreply.github.com>

Author: 3 people

script_umdp3_checker/umdp3_checker_rules.py

@@ -25,7 +25,11 @@
 TODO : Several of the test functions are poor shadows of the original
        Perl versions. They would benefit from improving to catch more
        cases.
+<<<<<<< HEAD
        Equally, there could probably be more consistancly in how things
+=======
+       Equally, there could probably be more consistency in how things
+>>>>>>> 674ed15 (Tweaks to get VSCode's internal linters to quit whinging and make the… (#173))
        like comments are stripped from the ends of lines
        and/or full comment lines are skipped.
 """
@@ -100,7 +104,11 @@ def get_extra_error_information(self) -> Dict:
     def add_extra_error(self, key: str, value: str = ""):
         """Add extra error information to the dictionary"""
         """
+<<<<<<< HEAD
     TODO: The usefulness of the information added has not been assesed,
+=======
+    TODO: The usefulness of the information added has not been assessed,
+>>>>>>> 674ed15 (Tweaks to get VSCode's internal linters to quit whinging and make the… (#173))
         nor does it appear to be reported as yet."""
         with self._lock:
             self._extra_error_info[key] = value
@@ -326,7 +334,11 @@ def lowercase_variable_names(self, lines: List[str]) -> TestResult:
         """Check for lowercase or CamelCase variable names only"""
         """
     TODO: This is a very simplistic check and will not detect many
+<<<<<<< HEAD
         cases which break UMDP3. I suspect the Perl Predeccessor concattenated
+=======
+        cases which break UMDP3. I suspect the Perl Predecessor concatenated
+>>>>>>> 674ed15 (Tweaks to get VSCode's internal linters to quit whinging and make the… (#173))
         continuation lines prior to 'cleaning' and checking. Having identified
         a declaration, it also then scanned the rest of the file for that
         variable name in any case."""
@@ -343,16 +355,22 @@ def lowercase_variable_names(self, lines: List[str]) -> TestResult:
                 clean_line,
                 re.IGNORECASE,
             ):
+<<<<<<< HEAD
                 # print("Debug: Found variable declaration line: "
                 # f"{clean_line}")
+=======
+>>>>>>> 674ed15 (Tweaks to get VSCode's internal linters to quit whinging and make the… (#173))
                 clean_line = re.sub(
                     r"^\s*(INTEGER|REAL|LOGICAL|CHARACTER|TYPE)\s*.*::\s*",
                     "",
                     clean_line,
                 )
                 if re.search(r"[A-Z]{2,}", clean_line):
+<<<<<<< HEAD
                     # print(f"Debug: Found UPPERCASE variable name: "
                     # f"{clean_line}")
+=======
+>>>>>>> 674ed15 (Tweaks to get VSCode's internal linters to quit whinging and make the… (#173))
                     self.add_extra_error("UPPERCASE variable name")
                     failures += 1
                     error_log = self.add_error_log(

script_umdp3_checker/umdp3_conformance.py

@@ -367,7 +367,7 @@ def print_results(self, print_volume: int = 3,
         """Print results and return True if all checks passed.
         ========================================================"""
         """
-        TODO: If an object encapsulating the data for each file is created"
+        TODO: If an object encapsulating the data for each file is created
         it should contain the "in depth" printing method for file data.
         With this method presenting the summary and then looping over
         each file object to print its details at the desired verbosity."""
@@ -624,8 +624,9 @@ def get_files_to_check(path: str, full_check: bool,
     TODO : Uncertain as to how flexible this needs to be.
         For now, just configure checkers based on file type requested.
         Later, could add configuration files to specify which
-        checkers to use for each file type.
-    """
+        checkers to use for each file type."""
+    checkers = []
+
     active_checkers = create_style_checkers(args.file_types,
                                             full_file_paths)