Make undefined references messages more user-friendly

Austin Clements · Austin Clements · commit bbc7003b46f2 · 2014-07-25T14:43:47.000-04:00
diff --git a/latexrun b/latexrun
@@ -875,13 +875,32 @@ class LaTeX(Task):
 
         # Parse the log
         logfile = open(extra['jobname'] + '.log', 'rt', errors='surrogateescape')
-        for msg in LaTeXFilter(self.__nowarns).feed(
-                logfile.read(), True).get_messages():
+        for msg in self.__clean_messages(
+                LaTeXFilter(self.__nowarns).feed(
+                    logfile.read(), True).get_messages()):
             print(msg, file=sys.stderr)
 
         # Return LaTeX's exit status
         return extra['status']
 
+    def __clean_messages(self, msgs):
+        """Make some standard log messages more user-friendly."""
+        have_undefined_reference = False
+        for msg in msgs:
+            if msg.msg.startswith('[LaTeX] '):
+                # Strip unnecessary package name
+                msg = msg._replace(msg=msg.msg.split(' ', 1)[1])
+            if re.match(r'Reference .* undefined', msg.msg):
+                have_undefined_reference = True
+            if have_undefined_reference and \
+               re.match(r'There were undefined references', msg.msg):
+                # LaTeX prints this at the end so the user knows it's
+                # worthwhile looking back at the log.  Since latexrun
+                # makes the earlier messages obvious, this is
+                # redundant.
+                continue
+            yield msg
+
     def get_tex_filename(self):
         return self.__tex_filename
 
diff --git a/test/T-missing-input.tex b/test/T-missing-input.tex
@@ -7,7 +7,7 @@
 %% status: 1
 
 %% output:
-%% T-missing-input.tex:4: error: [LaTeX] File `does-not-exist.tex' not found
+%% T-missing-input.tex:4: error: File `does-not-exist.tex' not found
 %%       at <read *>
 %%     from \input{does-not-exist}
 %% T-missing-input.tex: error: ==> Fatal error occurred, no output PDF file produced!
diff --git a/test/T-new-input.sh b/test/T-new-input.sh
@@ -28,7 +28,7 @@ rm -rf $TMP
 
 ## output:
 ## chap1 does not exist
-## tmp.T-new-input/test.tex:4: error: [LaTeX] File `./tmp.T-new-input/chap1.tex' not found
+## tmp.T-new-input/test.tex:4: error: File `./tmp.T-new-input/chap1.tex' not found
 ##       at <read *>
 ##     from \input{./tmp.T-new-input/chap1}
 ## tmp.T-new-input/test.tex: error: ==> Fatal error occurred, no output PDF file produced!
