Merge pull request #85 from mauricerkelly/migrate-to-linter-2.0

Update to use Linter v2 provider and message formats

Author: Arcanemagus

lib/init.js

@@ -109,11 +109,11 @@ const parseError = async (toParse, sourceFilePath) => {
   const projectPath = await elixirProjectPath(sourceFilePath);
   let reResult = re.exec(toParse);
   while (reResult !== null) {
-    let text;
+    let excerpt;
     let filePath;
     let range;
     if (reResult[2] !== undefined) {
-      text = `(${reResult[1]}) ${reResult[2]}`;
+      excerpt = `(${reResult[1]}) ${reResult[2]}`;
       filePath = join(projectPath, reResult[3]);
       const fileEditor = findTextEditor(filePath);
       if (fileEditor) {
@@ -126,7 +126,7 @@ const parseError = async (toParse, sourceFilePath) => {
         range = new Range([reResult[4] - 1, 0], [reResult[4] - 1, 1]);
       }
     } else {
-      text = `(${reResult[1]}) ${reResult[7]}`;
+      excerpt = `(${reResult[1]}) ${reResult[7]}`;
       filePath = join(projectPath, reResult[5]);
       const fileEditor = findTextEditor(filePath);
       if (fileEditor) {
@@ -136,10 +136,9 @@ const parseError = async (toParse, sourceFilePath) => {
       }
     }
     messages.push({
-      type: 'Error',
-      text,
-      filePath,
-      range,
+      severity: 'error',
+      excerpt,
+      location: { file: filePath, position: range },
     });
     reResult = re.exec(toParse);
   }
@@ -170,10 +169,9 @@ const parseWarning = async (toParse, sourceFilePath) => {
         range = new Range([reResult[3] - 1, 0], [reResult[3] - 1, 1]);
       }
       messages.push({
-        type: 'Warning',
-        text: reResult[1],
-        filePath,
-        range,
+        severity: 'warning',
+        excerpt: reResult[1],
+        location: { file: filePath, position: range },
       });
     } catch (Error) {
       // eslint-disable-next-line no-console
@@ -209,10 +207,9 @@ const parseLegacyWarning = async (toParse, sourceFilePath) => {
         range = new Range([reResult[3] - 1, 0], [reResult[3] - 1, 1]);
       }
       messages.push({
-        type: 'Warning',
-        text: reResult[3],
-        filePath,
-        range,
+        severity: 'warning',
+        excerpt: reResult[3],
+        location: { file: filePath, position: range },
       });
     } catch (Error) {
       // eslint-disable-next-line no-console
@@ -339,7 +336,7 @@ export default {
     return {
       grammarScopes: ['source.elixir'],
       scope: 'project',
-      lintOnFly: false,
+      lintsOnChange: false,
       name: 'Elixir',
       async lint(textEditor) {
         const filePath = textEditor.getPath();

package.json

@@ -36,17 +36,17 @@
   "providedServices": {
     "linter": {
       "versions": {
-        "1.0.0": "provideLinter"
+        "2.0.0": "provideLinter"
       }
     }
   },
   "package-deps": [
-    "linter",
+    "linter:2.0.0",
     "language-elixir"
   ],
   "dependencies": {
     "atom-linter": "^9.0.0",
-    "atom-package-deps": "^4.0.1",
+    "atom-package-deps": "^4.5.0",
     "tmp": "^0.0.31"
   },
   "devDependencies": {

spec/linter-elixirc-spec.js

@@ -25,11 +25,11 @@ describe('The elixirc provider for Linter', () => {
     waitsForPromise(() =>
       atom.workspace.open(errorMode1Path).then(editor => lint(editor)).then((messages) => {
         expect(messages.length).toBe(1);
-        expect(messages[0].type).toBe('Error');
+        expect(messages[0].severity).toBe('error');
         expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].text).toBe('(ArgumentError) Dangerous is not available');
-        expect(messages[0].filePath).toBe(errorMode1Path);
-        expect(messages[0].range).toEqual([[1, 0], [1, 32]]);
+        expect(messages[0].excerpt).toBe('(ArgumentError) Dangerous is not available');
+        expect(messages[0].location.file).toBe(errorMode1Path);
+        expect(messages[0].location.position).toEqual([[1, 0], [1, 32]]);
       }),
     );
   });
@@ -38,11 +38,11 @@ describe('The elixirc provider for Linter', () => {
     waitsForPromise(() =>
       atom.workspace.open(errorMode2Path).then(editor => lint(editor)).then((messages) => {
         expect(messages.length).toBe(1);
-        expect(messages[0].type).toBe('Error');
+        expect(messages[0].severity).toBe('error');
         expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].text).toBe('(CompileError) module Usefulness is not loaded and could not be found');
-        expect(messages[0].filePath).toBe(errorMode2Path);
-        expect(messages[0].range).toEqual([[3, 2], [3, 20]]);
+        expect(messages[0].excerpt).toBe('(CompileError) module Usefulness is not loaded and could not be found');
+        expect(messages[0].location.file).toBe(errorMode2Path);
+        expect(messages[0].location.position).toEqual([[3, 2], [3, 20]]);
       }),
     );
   });
@@ -51,11 +51,11 @@ describe('The elixirc provider for Linter', () => {
     waitsForPromise(() =>
       atom.workspace.open(warningPath).then(editor => lint(editor)).then((messages) => {
         expect(messages.length).toBe(1);
-        expect(messages[0].type).toBe('Warning');
+        expect(messages[0].severity).toBe('warning');
         expect(messages[0].html).not.toBeDefined();
-        expect(messages[0].text).toBe('variable "deps" does not exist and is being expanded to "deps()", please use parentheses to remove the ambiguity or change the variable name');
-        expect(messages[0].filePath).toBe(warningPath);
-        expect(messages[0].range).toEqual([[9, 5], [9, 16]]);
+        expect(messages[0].excerpt).toBe('variable "deps" does not exist and is being expanded to "deps()", please use parentheses to remove the ambiguity or change the variable name');
+        expect(messages[0].location.file).toBe(warningPath);
+        expect(messages[0].location.position).toEqual([[9, 5], [9, 16]]);
       }),
     );
   });