From c5fd6e3d13129d789ea203fab89fd0785935c954 Mon Sep 17 00:00:00 2001
From: Lucas Walter <wsacul@gmail.com>
Date: Sat, 7 Nov 2020 07:58:58 -0800
Subject: [PATCH] Optionally don't put comments in generated files.

---
 src/catkin_pkg/cli/create_pkg.py    |  6 ++++-
 src/catkin_pkg/package_templates.py | 35 ++++++++++++++++++++---------
 2 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/src/catkin_pkg/cli/create_pkg.py b/src/catkin_pkg/cli/create_pkg.py
index 6626b533..55db7e72 100644
--- a/src/catkin_pkg/cli/create_pkg.py
+++ b/src/catkin_pkg/cli/create_pkg.py
@@ -42,6 +42,9 @@ def main(argv=sys.argv[1:], parent_path=os.getcwd()):
     parser.add_argument('-m', '--maintainer',
                         action='append',
                         help='A single maintainer, may be used multiple times')
+    parser.add_argument('-n', '--no_comments',
+                        action='store_true',
+                        help="Don't put comments in package.xml or CMakeLists.txt")
     rosdistro_name = os.environ['ROS_DISTRO'] if 'ROS_DISTRO' in os.environ else None
     parser.add_argument('--rosdistro', required=rosdistro_name is None, default=rosdistro_name, help='The ROS distro (default: environment variable ROS_DISTRO if defined)')
 
@@ -64,7 +67,8 @@ def main(argv=sys.argv[1:], parent_path=os.getcwd()):
                              package_template=package_template,
                              rosdistro=args.rosdistro,
                              newfiles={},
-                             meta=args.meta)
+                             meta=args.meta,
+                             no_comments=args.no_comments)
         print('Successfully created files in %s. Please adjust the values in package.xml.' % target_path)
     except ValueError as vae:
         parser.error(str(vae))
diff --git a/src/catkin_pkg/package_templates.py b/src/catkin_pkg/package_templates.py
index d539d2f8..beb22764 100644
--- a/src/catkin_pkg/package_templates.py
+++ b/src/catkin_pkg/package_templates.py
@@ -34,6 +34,7 @@
 
 import getpass
 import os
+import re
 import string
 import sys
 
@@ -144,7 +145,7 @@ def _create_package_template(package_name, description=None, licenses=None,
         return package_temp
 
 
-def read_template_file(filename, rosdistro):
+def read_template_file(filename, rosdistro, no_comments=False):
     template_dir = os.path.join(os.path.dirname(__file__), 'templates')
     templates = []
     templates.append(os.path.join(template_dir, rosdistro, '%s.in' % filename))
@@ -153,6 +154,16 @@ def read_template_file(filename, rosdistro):
         if os.path.isfile(template):
             with open(template, 'r') as fhand:
                 template_contents = fhand.read()
+
+            if no_comments:
+                lines = template_contents.split('\n')
+                lines2 = []
+                for line in lines:
+                    if line.startswith('##') or '<!--' in line:
+                        continue
+                    lines2.append(line)
+                template_contents = '\n'.join(lines2)
+                # template_contents = re.sub(r'\n\n+', '\n\n', template_contents).strip()
             return template_contents
     raise IOError(
         'Could not read template for ROS distro '
@@ -194,7 +205,7 @@ def _safe_write_files(newfiles, target_dir):
 
 
 def create_package_files(target_path, package_template, rosdistro,
-                         newfiles=None, meta=False):
+                         newfiles=None, meta=False, no_comments=False):
     """
     Create several files from templates to start a new package.
 
@@ -209,10 +220,10 @@ def create_package_files(target_path, package_template, rosdistro,
     manifest_path = os.path.join(target_path, PACKAGE_MANIFEST_FILENAME)
     if manifest_path not in newfiles:
         newfiles[manifest_path] = \
-            create_package_xml(package_template, rosdistro, meta=meta)
+            create_package_xml(package_template, rosdistro, meta=meta, no_comments=no_comments)
     cmake_path = os.path.join(target_path, 'CMakeLists.txt')
     if cmake_path not in newfiles:
-        newfiles[cmake_path] = create_cmakelists(package_template, rosdistro, meta=meta)
+        newfiles[cmake_path] = create_cmakelists(package_template, rosdistro, meta=meta, no_comments=no_comments)
     _safe_write_files(newfiles, target_path)
     if 'roscpp' in package_template.catkin_deps:
         fname = os.path.join(target_path, 'include', package_template.name)
@@ -232,7 +243,7 @@ class CatkinTemplate(string.Template):
     escape = '@'
 
 
-def create_cmakelists(package_template, rosdistro, meta=False):
+def create_cmakelists(package_template, rosdistro, meta=False, no_comments=False):
     """Create CMake file contents from the template.
 
     :param package_template: contains the required information
@@ -246,7 +257,7 @@ def create_cmakelists(package_template, rosdistro, meta=False):
         }
         return configure_file(template_path, temp_dict)
     else:
-        cmakelists_txt_template = read_template_file('CMakeLists.txt', rosdistro)
+        cmakelists_txt_template = read_template_file('CMakeLists.txt', rosdistro, no_comments=no_comments)
         ctemp = CatkinTemplate(cmakelists_txt_template)
         if package_template.catkin_deps == []:
             components = ''
@@ -285,7 +296,9 @@ def create_cmakelists(package_template, rosdistro, meta=False):
                      'target_libraries': _create_targetlib_args(package_template),
                      'message_dependencies': message_depends
                      }
-        return ctemp.substitute(temp_dict)
+        cmake_text = ctemp.substitute(temp_dict)
+        cmake_text = re.sub(r'\n\n+', '\n\n', cmake_text).strip()
+        return cmake_text
 
 
 def _create_targetlib_args(package_template):
@@ -341,7 +354,7 @@ def _create_depend_tag(dep_type,
     return result
 
 
-def create_package_xml(package_template, rosdistro, meta=False):
+def create_package_xml(package_template, rosdistro, meta=False, no_comments=False):
     """
     Create package xml file content.
 
@@ -349,7 +362,7 @@ def create_package_xml(package_template, rosdistro, meta=False):
     :returns: file contents as string
     """
     package_xml_template = \
-        read_template_file(PACKAGE_MANIFEST_FILENAME, rosdistro)
+        read_template_file(PACKAGE_MANIFEST_FILENAME, rosdistro, no_comments=no_comments)
     ctemp = CatkinTemplate(package_xml_template)
     temp_dict = {}
     for key in package_template.__slots__:
@@ -442,4 +455,6 @@ def get_person_tag(tagname, person):
 
     temp_dict['components'] = package_template.catkin_deps
 
-    return ctemp.substitute(temp_dict)
+    package_text = ctemp.substitute(temp_dict)
+    package_text = re.sub(r'\n\n+', '\n\n', package_text).strip()
+    return package_text