Implement automatic selector if plugins are used (#287)

Implement automatic selector if plugins are used

Author: kaste

README.md

@@ -1,7 +1,7 @@
 SublimeLinter-eslint
 =========================
 
-This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [ESLint](https://github.com/nzakas/eslint). It will be used with files that have the "JavaScript" or "HTML 5" syntax dependent on your installed syntax highlighting package.
+This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [ESLint](https://github.com/nzakas/eslint). It will be used with "JavaScript" files, but since `eslint` is pluggable, it can actually lint a variety of other files as well.
 
 ## Installation
 SublimeLinter 3 must be installed in order to use this plugin. 
@@ -20,16 +20,21 @@ npm install -g eslint
 
 - Or install `eslint` locally in your project folder (**you must have a `package.json` file there**):
 ```
-npm install eslint
+npm install -S eslint
 ```
 
 ## Using eslint with plugins (e.g. vue)
 
-If you're using plugins for eslint so that it can lint files other than `.js`, 
-you need to tell SublimeLinter it's ok to lint those files too.
-For this you can change the `"selector"` setting to include the scope
-of the other syntax. Its default value is `source.js - meta.attribute-with-value`, 
-make sure to include that in the configuration.
+SublimeLinter will detect _some_ installed **local** plugins, and thus it should work automatically for e.g. `.vue` or `.ts` files. If it works on the command line, there is a chance it works in Sublime without further ado.  
+
+- Make sure the plugins are installed **locally** colocated to `eslint` itself. T.i., technically, both `eslint` and its plugins are described in the very same `package.json`. 
+- Configuration of the plugins is out-of-scope of this README. Be sure to read _their_ README's as well. (If you just installed a plugin, without proper configuration, `eslint` will probably show error messages or wrong lint results, and SublimeLinter will just pass them to you.)
+
+Out-of-the-box SublimeLinter detects typescript, vue, svelte, html, and json. Please open a PR for important other plugins. 
+
+In any case, if you want to control which files SublimeLinter sends to `eslint`, you can always manually change the `"selector"` setting to just include the scopes you explicitly want. The default value for "JavaScript" is `source.js - meta.attribute-with-value`, make sure to include that in the configuration. 
+
+### Examples
 
 For [Typescript](https://www.typescriptlang.org/) `.ts` files it would be:
 
@@ -40,7 +45,6 @@ For [Typescript](https://www.typescriptlang.org/) `.ts` files it would be:
     }
 }
 ```
-It would also need the appropriate [eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin) setup.
 
 For [Vue.js](https://vuejs.org/) `.vue` files it would be:
 
@@ -74,6 +78,18 @@ You can configure `eslint` options in the way you would from the command line, w
 
 ## FAQ and Troubleshooting
 
+### `eslint` doesn't lint my HTML files anymore.
+
+Starting with v4.2 of this plugin, `eslint` will only lint '*.js' files for standard, vanilla configurations without further plugins. You can restore the old behavior by setting `selector` to its old value: 
+
+```json
+"linters": {
+    "eslint": {
+        "selector": "source.js - meta.attribute-with-value"
+    }
+}
+```
+
 ### I've got 'SublimeLinter: ERROR: eslint cannot locate 'eslint' in ST console when I try to use locally installed `eslint`.
 
 You **must** have a `package.json` file if you've installed `eslint` locally. Also, restart the project or Sublime Text itself after to make sure SublimeLinter uses the correct `eslint` instance.

linter.py

@@ -12,13 +12,29 @@
 
 import json
 import logging
+import os
 import re
 from SublimeLinter.lint import NodeLinter, LintMatch
 
+# TODO Proper export these in SL core
+from SublimeLinter.lint.linter import PermanentError
+from SublimeLinter.lint.base_linter.node_linter import read_json_file
+
 
 logger = logging.getLogger('SublimeLinter.plugin.eslint')
 
 
+STANDARD_SELECTOR = 'source.js'
+PLUGINS = {
+    'eslint-plugin-html': 'text.html',
+    'eslint-plugin-json': 'source.json',
+    'eslint-plugin-svelte3': 'text.html',
+    'eslint-plugin-vue': 'text.html.vue',
+    '@typescript-eslint/parser': 'source.ts',
+}
+OPTIMISTIC_SELECTOR = ', '.join({STANDARD_SELECTOR} | set(PLUGINS.values()))
+
+
 class ESLint(NodeLinter):
     """Provides an interface to the eslint executable."""
 
@@ -30,10 +46,57 @@ class ESLint(NodeLinter):
     )
     line_col_base = (1, 1)
     defaults = {
-        'selector': 'source.js - meta.attribute-with-value',
+        'selector': OPTIMISTIC_SELECTOR,
         '--stdin-filename': '${file}'
     }
 
+    def run(self, cmd, code):
+        # Workaround eslint bug https://github.com/eslint/eslint/issues/9515
+        # Fixed in eslint 4.10.0
+        if code == '':
+            code = ' '
+
+        self.ensure_plugin_installed()
+        return super().run(cmd, code)
+
+    def ensure_plugin_installed(self) -> bool:
+        # If the user changed the selector, we take it as is
+        if self.settings['selector'] != OPTIMISTIC_SELECTOR:
+            return True
+
+        # Happy path.
+        if self.view.match_selector(0, STANDARD_SELECTOR):
+            return True
+
+        # If we're here we must be pessimistic.
+
+        # The 'project_root' has the relevant 'package.json' file colocated.
+        # If we fallback to a global installation there is no 'project_root',
+        # t.i. no auto-selector in that case as well.
+        project_root = self.context.get('project_root')
+        if project_root:
+            # We still need to be careful, in case SL deduced a 'project_root'
+            # without checking for the 'package.json' explicitly. Basically, a
+            # happy path for SL core.
+            manifest_file = os.path.join(project_root, 'package.json')
+            try:
+                manifest = read_json_file(manifest_file)
+            except Exception:
+                pass
+            else:
+                defined_plugins = PLUGINS.keys() & (
+                    manifest.get('dependencies', {}).keys()
+                    | manifest.get('devDependencies', {}).keys()
+                )
+                selector = ', '.join(PLUGINS[name] for name in defined_plugins)
+                if selector and self.view.match_selector(0, selector):
+                    return True
+
+        # Indicate an error which usually can only be solved by changing
+        # the environment. Silently, do not notify and disturb the user.
+        self.notify_unassign()
+        raise PermanentError()
+
     def on_stderr(self, stderr):
         # Demote 'annoying' config is missing error to a warning.
         if self.missing_config_regex.match(stderr):
@@ -119,11 +182,3 @@ def reposition_match(self, line, col, m, vv):
             end_column += len(text)
 
         return line, col, end_column
-
-    def run(self, cmd, code):
-        # Workaround eslint bug https://github.com/eslint/eslint/issues/9515
-        # Fixed in eslint 4.10.0
-        if code == '':
-            code = ' '
-
-        return super().run(cmd, code)

messages.json

@@ -1,4 +1,4 @@
 {
     "install": "messages/install.txt",
-    "4.0.1": "messages/4.0.1.txt"
+    "4.2.0": "messages/4.2.0.txt"
 }

messages/4.0.1.txt

@@ -0,0 +1,29 @@
+SublimeLinter-eslint 4.2.0
+--------------------------
+
+BREAKING CHANGE! BREAKING CHANGE! BREAKING CHANGE! BREAKING CHANGE!
+
+This plugin used to lint only JavaScript out of the box. But eslint can do
+more using plugins. These plugins are extremely useful and popular, and we
+want to support them *automatically*.
+
+In this first release, we detect ts, html, json, vue, and svelte.
+Other plugins/languages can be added. Please open an issue/PR!
+
+Note that the plugins have to be installed *locally*, alongside with eslint
+itself, for this to work. So-called *global* installations have to be
+configured manually, since eslint v6 anyway.
+
+
+# No, thanks, I want the old behavior
+
+You can restore the old behavior by setting `selector` to its old value:
+
+```json
+"linters": {
+    "eslint": {
+        "selector": "source.js - meta.attribute-with-value"
+    }
+}
+```
+