Merge pull request #128 from richardbann/master

Linter v2 Update

Author: Arcanemagus

lib/main.js

@@ -9,8 +9,13 @@ const baseUrl = 'https://github.com/koalaman/shellcheck/wiki';
 const errorCodeRegex = /SC\d{4}/;
 const regex = /.+?:(\d+):(\d+):\s(\w+?):\s(.+)/g;
 
-const linkifyErrorCode = text =>
-  text.replace(errorCodeRegex, `<a href="${baseUrl}/$&">$&</a>`);
+const createURL = (text) => {
+  const match = errorCodeRegex.exec(text);
+  if (match) {
+    return `${baseUrl}/${match[0]}`;
+  }
+  return undefined;
+};
 
 export default {
   activate() {
@@ -45,7 +50,7 @@ export default {
       name: 'ShellCheck',
       grammarScopes: ['source.shell'],
       scope: 'file',
-      lintOnFly: true,
+      lintsOnChange: true,
       lint: (textEditor) => {
         if (!atom.workspace.isTextEditor(textEditor)) {
           return null;
@@ -84,10 +89,13 @@ export default {
               const line = Number.parseInt(match[1], 10) - 1;
               const col = Number.parseInt(match[2], 10) - 1;
               messages.push({
-                type,
-                filePath,
-                range: helpers.generateRange(textEditor, line, col),
-                html: linkifyErrorCode(match[4]),
+                severity: type,
+                location: {
+                  file: filePath,
+                  position: helpers.generateRange(textEditor, line, col),
+                },
+                excerpt: match[4],
+                url: createURL(match[4]),
               });
             }
             match = regex.exec(output);

package.json

@@ -71,12 +71,12 @@
     }
   },
   "package-deps": [
-    "linter"
+    "linter:2.0.0"
   ],
   "providedServices": {
     "linter": {
       "versions": {
-        "1.0.0": "provideLinter"
+        "2.0.0": "provideLinter"
       }
     }
   }

spec/linter-shellcheck-spec.js

@@ -34,17 +34,17 @@ describe('The ShellCheck provider for Linter', () => {
   });
 
   it('handles messages from ShellCheck', async () => {
-    const expectedMsg = 'Tips depend on target shell and yours is unknown. Add a shebang. ' +
-      '[<a href="https://github.com/koalaman/shellcheck/wiki/SC2148">SC2148</a>]';
+    const expectedExcerpt = 'Tips depend on target shell and yours is unknown. Add a shebang. [SC2148]';
+    const expectedURL = 'https://github.com/koalaman/shellcheck/wiki/SC2148';
     const editor = await atom.workspace.open(badPath);
     const messages = await lint(editor);
 
     expect(messages.length).toBe(1);
-    expect(messages[0].type).toBe('error');
-    expect(messages[0].text).not.toBeDefined();
-    expect(messages[0].html).toBe(expectedMsg);
-    expect(messages[0].filePath).toBe(badPath);
-    expect(messages[0].range).toEqual([[0, 0], [0, 4]]);
+    expect(messages[0].severity).toBe('error');
+    expect(messages[0].excerpt).toBe(expectedExcerpt);
+    expect(messages[0].url).toBe(expectedURL);
+    expect(messages[0].location.file).toBe(badPath);
+    expect(messages[0].location.position).toEqual([[0, 0], [0, 4]]);
   });
 
   describe('implements useProjectCwd and', () => {
@@ -65,7 +65,7 @@ describe('The ShellCheck provider for Linter', () => {
       const editor = await atom.workspace.open(sourceFileRelativePath);
       const messages = await lint(editor);
       expect(messages.length).toBe(1);
-      expect(messages[0].html).toMatch(/openBinaryFile: does not exist/);
+      expect(messages[0].excerpt).toMatch(/openBinaryFile: does not exist/);
     });
 
     it('uses project-relative source= directives via setting (based at fixtures/)', async () => {
@@ -80,7 +80,7 @@ describe('The ShellCheck provider for Linter', () => {
       const editor = await atom.workspace.open(sourceProjectRelativePath);
       const messages = await lint(editor);
       expect(messages.length).toBe(1);
-      expect(messages[0].html).toMatch(/openBinaryFile: does not exist/);
+      expect(messages[0].excerpt).toMatch(/openBinaryFile: does not exist/);
     });
   });
 });