Merge lp:~elachuni/lazr-js/jslint-html into lp:lazr-js

[Anthony Lenton]

[Anthony Lenton (elachuni)]

This branch adds an option to jslint.py to allow you to lint .html files also.
I made it just lint html files always at first, but it does choke on some html files, so it's just optional in the end.

[Edwin Grubbs (edwin-grubbs)]

Hi Anthony,

This is great. I just have one suggestion below.

merge-conditional

-Edwin

>=== modified file 'src-py/lazr/js/jslint.py'
>--- src-py/lazr/js/jslint.py>--2009-10-21 21:43:07 +0000
>+++ src-py/lazr/js/jslint.py>--2009-11-13 17:47:54 +0000
>@@ -36,7 +39,7 @@
> # And look also at the renamed attribute for modified files.
> files_to_lint.extend(info[0] for info in delta.renamed if info[4])
>
>- # Select only the files ending in .js.
>+ # Select only the appropriate files.
> # And turn them in absolute paths.

This would be easier to read as a single sentence.
    # Select only the appropriate files and turn them in absolute paths.

review: Approve (code)

[lp:~elachuni/lazr-js/jslint-html]

147. By Anthony Lenton on 2009-11-13

Docfix from review comments.

=== modified file 'src-py/lazr/js/jslint.py'
--- src-py/lazr/js/jslint.py	2009-10-21 21:43:07 +0000
+++ src-py/lazr/js/jslint.py	2009-11-13 18:12:12 +0000
@@ -15,10 +15,13 @@
 FULLJSLINT = os.path.join(HERE, 'fulljslint.js')
 JSLINT_WRAPPER = os.path.join(HERE, 'jslint-wrapper.js')
 
-
-def js_filter(path):
-    """Filter out non-JS files."""
-    return path.endswith('.js')
+class FiletypeFilter:
+    include_html = False
+    def __call__(self, path):
+        """Return True for filetypes we want to lint."""
+        return path.endswith('.js') or (self.include_html and
+               path.endswith('.html'))
+js_filter = FiletypeFilter()
 
 
 class JSLinter:
@@ -36,8 +39,7 @@
         # And look also at the renamed attribute for modified files.
         files_to_lint.extend(info[0] for info in delta.renamed if info[4])
 
-        # Select only the files ending in .js.
-        # And turn them in absolute paths.
+        # Select only the appropriate files and turn them in absolute paths.
         return [self.tree.abspath(f) for f in files_to_lint if js_filter(f)]
 
     def find_files_to_lint_from_working_tree_or_parent(self):
@@ -65,15 +67,15 @@
 
     def find_all_files_to_lint(self):
         """Return all the JS files that can be linted."""
-        all_js_files = []
+        all_files = []
         for file_id in self.tree:
             path = self.tree.id2path(file_id)
             # Skip build files and third party files.
             if path.startswith('lib') or path.startswith('build'):
                 continue
             if js_filter(path):
-                all_js_files.append(self.tree.abspath(path))
-        return all_js_files
+                all_files.append(self.tree.abspath(path))
+        return all_files
 
     def jslint_rhino(self, filenames):
         """Run the linter on all selected files using rhino."""
@@ -134,6 +136,9 @@
         '-e', '--engine', dest='engine', default='js', action='store',
         help=('Javascript engine to use. Defaults to "js" (SpiderMonkey). '
               'Use "rhino" to use the Java-based Rhino engine'))
+    parser.add_option(
+        '-i', '--include-html', dest='html', default=False,
+        action='store_true', help=('Also lint .html files.'))
 
     options, args = parser.parse_args()
     if len(args) > 0:
@@ -162,6 +167,7 @@
     load_plugins()
     options, args = get_options()
     linter = JSLinter(options.options)
+    js_filter.include_html = options.html
     if args:
         files = [f for f in args if js_filter(f)]
     elif options.all: