Merge pull request #211 from AtomLinter/arcanemagus/linter-v2

Upgrade to Linter v2 API

Author: Arcanemagus

lib/main.coffee

@@ -94,7 +94,7 @@ module.exports =
       name: 'sass-lint'
       grammarScopes: ['source.css.scss', 'source.scss', 'source.css.sass', 'source.sass']
       scope: 'file'
-      lintOnFly: true
+      lintsOnChange: true
       lint: (editor) =>
         {find} = require 'atom-linter'
         helpers = require './helpers'
@@ -136,10 +136,12 @@ module.exports =
 
         if config is null and @noConfigDisable is false
           return [
-            type: 'Info'
-            text: 'No .sass-lint.yml config file detected or specified. Please check your settings'
-            filePath: filePath
-            range: [[0, 0], [0, 0]]
+            severity: 'info'
+            excerpt: 'No .sass-lint.yml config file detected or specified. Please check your settings'
+            location: {
+              file: filePath
+              position: [[0, 0], [0, 0]]
+            }
           ]
 
         else if config is null and @noConfigDisable is true
@@ -165,34 +167,40 @@ module.exports =
             colEndIdx = if line then line.length else 1
 
             return [
-              type: 'Error'
-              text: text
-              filePath: filePath
-              range: [[lineIdx, 0], [lineIdx, colEndIdx]]
+              severity: 'error'
+              excerpt: text
+              location: {
+                file: filePath
+                position: [[lineIdx, 0], [lineIdx, colEndIdx]]
+              }
             ]
           else
             # Leaving this here to allow people to report the errors
             console.log('linter-sass-lint', error)
             return [
-              type: 'Error'
-              text: 'Unexpected parse error in file'
-              filePath: filePath
-              range: [[lineIdx, 0], [lineIdx, colEndIdx]]
+              severity: 'error'
+              excerpt: 'Unexpected parse error in file'
+              location: {
+                file: filePath
+                position: [[lineIdx, 0], [lineIdx, colEndIdx]]
+              }
             ]
           return []
 
         if result then return result.messages.map (msg) ->
           line = if msg.line then msg.line - 1 else 0
           col = if msg.column then msg.column - 1 else 0
-          text = if msg.message then ' ' + msg.message else 'Unknown Error'
+          text = if msg.message then msg.message + ' (' + msg.ruleId + ')' else 'Unknown Error'
           ruleHref = helpers.getRuleURI(msg.ruleId)
-          html = '<a href="'+ ruleHref + '" class="badge badge-flexible sass-lint">' + msg.ruleId + '</a>' + text
 
           result = {
-            type: if msg.severity is 1 then 'Warning' else if msg.severity is 2 then 'Error' else 'Info',
-            html,
-            filePath: filePath,
-            range: [[line, col], [line, col + 1]]
+            severity: if msg.severity is 1 then 'warning' else if msg.severity is 2 then 'error' else 'info',
+            excerpt: text,
+            url: ruleHref
+            location: {
+              file: filePath,
+              position: [[line, col], [line, col + 1]]
+            }
           }
 
           return result

spec/linter-sass-lint-path-options-spec.js

@@ -32,28 +32,26 @@ describe('The sass-lint provider for Linter - path options', () => {
 
     it('verifies the first message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-ids.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-ids</a>`;
-      const warnId = ' ID selectors not allowed';
-
-      expect(messages[0].type).toBe('Error');
-      expect(messages[0].text).not.toBeDefined();
-      expect(messages[0].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[0].filePath).toBe(failurePath);
-      expect(messages[0].range).toEqual([[0, 0], [0, 1]]);
+      const warnId = 'ID selectors not allowed (no-ids)';
+
+      expect(messages[0].severity).toBe('error');
+      expect(messages[0].description).not.toBeDefined();
+      expect(messages[0].url).toBe(slDocUrl);
+      expect(messages[0].excerpt).toBe(warnId);
+      expect(messages[0].location.file).toBe(failurePath);
+      expect(messages[0].location.position).toEqual([[0, 0], [0, 1]]);
     });
 
     it('verifies the second message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-color-literals.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-color-literals</a>`;
-      const warnId = ' Color literals such as \'red\' should only be used in variable declarations';
-
-      expect(messages[1].type).toBe('Warning');
-      expect(messages[1].text).not.toBeDefined();
-      expect(messages[1].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[1].filePath).toBe(failurePath);
-      expect(messages[1].range).toEqual([[1, 9], [1, 10]]);
+      const warnId = 'Color literals such as \'red\' should only be used in variable declarations (no-color-literals)';
+
+      expect(messages[1].severity).toBe('warning');
+      expect(messages[1].description).not.toBeDefined();
+      expect(messages[1].url).toBe(slDocUrl);
+      expect(messages[1].excerpt).toBe(warnId);
+      expect(messages[1].location.file).toBe(failurePath);
+      expect(messages[1].location.position).toEqual([[1, 9], [1, 10]]);
     });
   });
 });

spec/linter-sass-lint-resolve-spec.js

@@ -33,28 +33,26 @@ describe('The sass-lint provider for Linter - resolve paths relative to config f
 
     it('verifies the first message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-ids.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-ids</a>`;
-      const warnId = ' ID selectors not allowed';
+      const warnId = 'ID selectors not allowed (no-ids)';
 
-      expect(messages[0].type).toBe('Error');
-      expect(messages[0].text).not.toBeDefined();
-      expect(messages[0].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[0].filePath).toBe(ignoredPath);
-      expect(messages[0].range).toEqual([[0, 0], [0, 1]]);
+      expect(messages[0].severity).toBe('error');
+      expect(messages[0].description).not.toBeDefined();
+      expect(messages[0].url).toBe(slDocUrl);
+      expect(messages[0].excerpt).toBe(warnId);
+      expect(messages[0].location.file).toBe(ignoredPath);
+      expect(messages[0].location.position).toEqual([[0, 0], [0, 1]]);
     });
 
     it('verifies the second message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-color-literals.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-color-literals</a>`;
-      const warnId = ' Color literals such as \'red\' should only be used in variable declarations';
+      const warnId = 'Color literals such as \'red\' should only be used in variable declarations (no-color-literals)';
 
-      expect(messages[1].type).toBe('Warning');
-      expect(messages[1].text).not.toBeDefined();
-      expect(messages[1].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[1].filePath).toBe(ignoredPath);
-      expect(messages[1].range).toEqual([[1, 9], [1, 10]]);
+      expect(messages[1].severity).toBe('warning');
+      expect(messages[1].description).not.toBeDefined();
+      expect(messages[1].url).toBe(slDocUrl);
+      expect(messages[1].excerpt).toBe(warnId);
+      expect(messages[1].location.file).toBe(ignoredPath);
+      expect(messages[1].location.position).toEqual([[1, 9], [1, 10]]);
     });
   });
 

spec/linter-sass-lint-sass-spec.js

@@ -33,28 +33,26 @@ describe('The sass-lint provider for Linter - sass', () => {
 
     it('verifies the first message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-ids.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-ids</a>`;
-      const warnId = ' ID selectors not allowed';
-
-      expect(messages[0].type).toEqual('Error');
-      expect(messages[0].text).not.toBeDefined();
-      expect(messages[0].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[0].filePath).toBe(failurePath);
-      expect(messages[0].range).toEqual([[0, 0], [0, 1]]);
+      const warnId = 'ID selectors not allowed (no-ids)';
+
+      expect(messages[0].severity).toBe('error');
+      expect(messages[0].description).not.toBeDefined();
+      expect(messages[0].url).toBe(slDocUrl);
+      expect(messages[0].excerpt).toBe(warnId);
+      expect(messages[0].location.file).toBe(failurePath);
+      expect(messages[0].location.position).toEqual([[0, 0], [0, 1]]);
     });
 
     it('verifies the second message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-color-literals.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-color-literals</a>`;
-      const warnId = ' Color literals such as \'red\' should only be used in variable declarations';
-
-      expect(messages[1].type).toEqual('Warning');
-      expect(messages[1].text).not.toBeDefined();
-      expect(messages[1].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[1].filePath).toBe(failurePath);
-      expect(messages[1].range).toEqual([[1, 9], [1, 10]]);
+      const warnId = 'Color literals such as \'red\' should only be used in variable declarations (no-color-literals)';
+
+      expect(messages[1].severity).toBe('warning');
+      expect(messages[1].description).not.toBeDefined();
+      expect(messages[1].url).toBe(slDocUrl);
+      expect(messages[1].excerpt).toBe(warnId);
+      expect(messages[1].location.file).toBe(failurePath);
+      expect(messages[1].location.position).toEqual([[1, 9], [1, 10]]);
     });
   });
 

spec/linter-sass-lint-scss-spec.js

@@ -33,28 +33,26 @@ describe('The sass-lint provider for Linter - scss', () => {
 
     it('verifies the first message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-ids.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-ids</a>`;
-      const warnId = ' ID selectors not allowed';
-
-      expect(messages[0].type).toBe('Error');
-      expect(messages[0].text).not.toBeDefined();
-      expect(messages[0].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[0].filePath).toBe(failurePath);
-      expect(messages[0].range).toEqual([[0, 0], [0, 1]]);
+      const warnId = 'ID selectors not allowed (no-ids)';
+
+      expect(messages[0].severity).toBe('error');
+      expect(messages[0].description).not.toBeDefined();
+      expect(messages[0].url).toBe(slDocUrl);
+      expect(messages[0].excerpt).toBe(warnId);
+      expect(messages[0].location.file).toBe(failurePath);
+      expect(messages[0].location.position).toEqual([[0, 0], [0, 1]]);
     });
 
     it('verifies the second message', () => {
       const slDocUrl = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules/no-color-literals.md';
-      const attributes = `href="${slDocUrl}" class="badge badge-flexible sass-lint"`;
-      const warningMarkup = `<a ${attributes}>no-color-literals</a>`;
-      const warnId = ' Color literals such as \'red\' should only be used in variable declarations';
-
-      expect(messages[1].type).toBe('Warning');
-      expect(messages[1].text).not.toBeDefined();
-      expect(messages[1].html).toBe(`${warningMarkup}${warnId}`);
-      expect(messages[1].filePath).toBe(failurePath);
-      expect(messages[1].range).toEqual([[1, 9], [1, 10]]);
+      const warnId = 'Color literals such as \'red\' should only be used in variable declarations (no-color-literals)';
+
+      expect(messages[1].severity).toBe('warning');
+      expect(messages[1].description).not.toBeDefined();
+      expect(messages[1].url).toBe(slDocUrl);
+      expect(messages[1].excerpt).toBe(warnId);
+      expect(messages[1].location.file).toBe(failurePath);
+      expect(messages[1].location.position).toEqual([[1, 9], [1, 10]]);
     });
   });