Merge pull request #7 from SublimeLinter/cleanup

Cleanup

Author: kaste

README.md

@@ -18,38 +18,48 @@ Once `clang` is installed, ensure it is in your system PATH so that SublimeLinte
 The docs cover [troubleshooting PATH configuration](http://sublimelinter.com/en/latest/troubleshooting.html#finding-a-linter-executable)
 
 ## Settings
-- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
-- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html
 
-Additional settings for SublimeLinter-clang:
+We have two settings sections. 'clang' for c files, and 'clang++' to configure the linter for c++ files. E.g.
 
-|Setting|Description|
-|:------|:----------|
-|include_dirs|A list of directories to be added to the header search paths (-I is not needed).|
-|extra_flags|A string with extra flags to pass to clang. These should be used carefully, as they may cause linting to fail.|
-
-In project-specific settings, SublimeLinter allows [expansion variables](http://sublimelinter.readthedocs.io/en/latest/settings.html#settings-expansion). For example, in project-specific settings, '${project_path}' can be used to specify a path relative to the project folder.
 ```
-"SublimeLinter":
 {
     "linters":
     {
         "clang": {
-            "extra_flags": "-Wall -I${project_path}/foo",
-            "include_dirs": [
-                "${project_path}/3rdparty/bar/include",
-                "${project_path}/3rdparty/baz"
+            "args": "-fvery-important",
+            "I": [
+                "${folder}/3rdparty/bar/include",
+                "${folder}/3rdparty/baz"
             ]
+        },
+        "clang++": {
+            "args": "-falso-important"
         }
     }
 },
 ```
 
+Note: 'args' has the default value '-Wall -fsyntax-only -fno-caret-diagnostics', so make sure to include them when overriding 'args'.
+
+All common settings information can be found here:
+
+- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
+- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html
+
+Additional settings for SublimeLinter-clang:
+
+|Setting|Description|
+|:------|:----------|
+|I|A list of directories to be added to the header search paths.|
+|x|Automatically set depending on the file type.|
+
+SublimeLinter allows [expansion variables](http://sublimelinter.readthedocs.io/en/latest/settings.html#settings-expansion). For example, '${folder}' can be used to specify a path relative to the project folder.
+
 ## Troubleshooting
 C/C++ linting is not always straightforward. A few things to try when there's (almost) no linting information available:
 - Try to compile from the command line, and verify it works.
 - The linter might be missing some header files. They can be added with "include_dirs".
 - Sometimes clang fails to locate the C++ standard library headers.
 Assuming the compilation works when executed via command line, try to compile with `clang++ -v`.
-This will display all of the hidden flags clang uses. As a last resort, they can all be added as "extra_flags".
+This will display all of the hidden flags clang uses. As a last resort, they can all be added as "args".
 

linter.py

@@ -10,63 +10,44 @@
 
 """This module exports the Clang plugin class."""
 
-import shlex
-from SublimeLinter.lint import Linter, util
+import re
+from SublimeLinter.lint import Linter
 
 
-class Clang(Linter):
-
-    """Provides an interface to clang."""
-
-    executable = 'clang'
+OUTPUT_RE = re.compile(
+    r'<stdin>:(?P<line>\d+):'
+    r'((?P<col>\d*): )?'  # column number, colon and space are only applicable for single line messages
+    # several lines of anything followed by
+    # either error/warning/note or newline (= irrelevant backtrace content)
+    # (lazy quantifiers so we don’t skip what we seek)
+    r'(.*?((?P<error>error)|(?P<warning>warning|note)|\r?\n))+?'
+    r': (?P<message>.+)',  # match the remaining content of the current line for output
+    re.MULTILINE
+)
 
-    regex = (
-        r'<stdin>:(?P<line>\d+):'
-        r'((?P<col>\d*): )?'  # column number, colon and space are only applicable for single line messages
-        # several lines of anything followed by
-        # either error/warning/note or newline (= irrelevant backtrace content)
-        # (lazy quantifiers so we don’t skip what we seek)
-        r'(.*?((?P<error>error)|(?P<warning>warning|note)|\r?\n))+?'
-        r': (?P<message>.+)'  # match the remaining content of the current line for output
-    )
-
-    multiline = True
 
+class Clang(Linter):
+    cmd = 'clang ${args} -'
     defaults = {
-        'include_dirs': [],
-        'extra_flags': "",
-        'selector': 'source.c, source.c++'
+        'selector': 'source.c',
+        'args': '-Wall -fsyntax-only -fno-caret-diagnostics',
+        '-I +': [],
+        '-x': 'c'
     }
-
-    base_cmd = (
-        'clang -fsyntax-only '
-        '-fno-caret-diagnostics -Wall '
-    )
-
+    regex = OUTPUT_RE
+    multiline = True
     on_stderr = None
 
-    def cmd(self):
-        """
-        Return the command line to execute.
-
-        We override this method, so we can add extra flags and include paths
-        based on the 'include_dirs' and 'extra_flags' settings.
 
-        """
-
-        result = self.base_cmd
-
-        if util.get_syntax(self.view) in ['c', 'c improved']:
-            result += ' -x c '
-        elif util.get_syntax(self.view) in ['c++', 'c++11']:
-            result += ' -x c++ '
-
-        settings = self.get_view_settings()
-        result += settings.get('extra_flags', '')
-
-        include_dirs = settings.get('include_dirs', [])
-
-        if include_dirs:
-            result += ' '.join([' -I ' + shlex.quote(include) for include in include_dirs])
-
-        return result + ' -'
+class ClangPlus(Linter):
+    name = 'clang++'
+    cmd = 'clang ${args} -'
+    defaults = {
+        'selector': 'source.c++',
+        'args': '-Wall -fsyntax-only -fno-caret-diagnostics',
+        '-I +': [],
+        '-x': 'c++'
+    }
+    regex = OUTPUT_RE
+    multiline = True
+    on_stderr = None

messages.json

@@ -1,3 +1,4 @@
 {
-    "install": "messages/install.txt"
+    "install": "messages/install.txt",
+    "2.0.0": "messages/2.0.0.txt"
 }

messages/2.0.0.txt

@@ -0,0 +1,25 @@
+SublimeLinter-clang 2.0.0
+-------------------------
+
+
+We revamped the settings, and you probably have to make changes.
+
+* If you used 'include_dirs', it is now called 'I' (just like the arg
+  on the command line).
+
+* 'extra_flags' is now 'args' (which is the standard name in the
+  SublimeLinter world). Note that 'args' has the default value
+  '-Wall -fsyntax-only -fno-caret-diagnostics'.
+
+'c' and 'c++' files now have different settings sections.
+
+{
+    "linters": {
+        "clang": {    // <- for c files
+
+        },
+        "clang++": {  // <-  for c++ files
+
+        }
+    }
+}

messages/install.txt

@@ -4,4 +4,4 @@ This linter plugin for SublimeLinter provides an interface to clang.
 
 Please read the installation instructions at:
 
-https://github.com/nirm03/SublimeLinter-clang
+https://github.com/SublimeLinter/SublimeLinter-clang