FileGlobs.py: Recursively extract .npmignore globs

Looks for .npmignore in dirs and subdirs recursively
and extract file globs

Closes #109

Author: prachi1210

coala_quickstart/generation/FileGlobs.py

@@ -1,7 +1,8 @@
 import os
 
 from coalib.parsing.Globbing import glob_escape
-from coala_quickstart.generation.Utilities import get_gitignore_glob
+from coala_quickstart.generation.Utilities import (
+    get_gitignore_glob, get_npmignore_glob)
 from coala_utils.Question import ask_question
 from coala_quickstart.Strings import GLOB_HELP
 from coalib.collecting.Collectors import collect_files
@@ -30,6 +31,21 @@ def get_project_files(log_printer, printer, project_dir, non_interactive=False):
                       color="green")
         ignore_globs = get_gitignore_glob(project_dir)
 
+    npmignore_dir_list = []
+
+    for dir_name, subdir_name, files in os.walk(project_dir):
+        if(os.path.isfile(os.path.join(dir_name, ".npmignore"))):
+            npmignore_dir_list += [dir_name]
+
+    if(npmignore_dir_list):
+        printer.print("The contents of your .npmignore file for the project "
+                      "will be automatically loaded as files to ignore.",
+                      color="green")
+        if ignore_globs is None:
+            ignore_globs = get_npmignore_glob(project_dir, npmignore_dir_list)
+        else:
+            ignore_globs += get_npmignore_glob(project_dir, npmignore_dir_list)
+
     if non_interactive and not ignore_globs:
         ignore_globs = []
 

coala_quickstart/generation/Utilities.py

@@ -18,11 +18,12 @@ def is_glob_exp(line):
     return sum(1 for x in results) != 0
 
 
-def parse_gitignore_line(line):
+def parse_ignore_line(line):
     """
-    Parses the line from ``.gitignore`` and returns a list of globs.
+    Parses the line from ``.gitignore`` and ``.npmignore``
+    and returns a list of globs.
 
-    :param line: A line from the project's ``.gitignore`` file.
+    :param line: A line from the project's ``.gitignore`` or ``.npmignore`` file
     :return:     A list of glob expressions translated to the
                  syntax used in coala globbing.
     """
@@ -72,10 +73,31 @@ def get_gitignore_glob(project_dir, filename=".gitignore"):
 
     with open(gitignore, "r") as file:
         for line in file:
-            for glob in parse_gitignore_line(line):
+            for glob in parse_ignore_line(line):
                 yield os.path.join(project_dir, glob)
 
 
+def get_npmignore_glob(project_dir, npmignore_dir_list, filename=".npmignore"):
+    """
+    Generates a list of glob expressions equivalent to the
+    contents of the user's project's ``.npmignore`` file.
+
+    :param project_dir:
+        The user's project directory.
+    :param npmignore_dir_list:
+        A list of directories in project containing .npmignore
+    :return:
+        A list generator of glob expressions generated from the
+        ``.npmignore`` file.
+    """
+    for dir_name in npmignore_dir_list:
+        npmignore = os.path.join(dir_name, filename)
+        with open(npmignore, "r") as file:
+            for line in file:
+                for glob in parse_ignore_line(line):
+                    yield os.path.join(dir_name, glob)
+
+
 def split_by_language(project_files):
     """
     Splits the given files based on language. This ignores unknown extensions.

tests/file_globs_npmignore_testfiles/.coafile

@@ -0,0 +1,10 @@
+
+# Start of npmignore
+build
+ignore.c
+/tests
+/upload.c
+/*.py
+*.pyc
+__pycache__
+# End of npmignore

tests/file_globs_npmignore_testfiles/.npmignore

@@ -0,0 +1,4 @@
+
+#Start of npmignore
+*.html
+#End of npmignore

tests/file_globs_npmignore_testfiles/glob2.py

@@ -0,0 +1,4 @@
+
+#Start of npmignore
+*.css
+#End of npmignore