Merge pull request #170 from AtomLinter/arcanemagus/csslint-master

Move to using mainline CSSLint

Author: Arcanemagus

.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
 .idea
 npm-debug.log
-node_modules
+node_modules/*
 .github_changelog_generator

.travis.yml

@@ -9,9 +9,6 @@ matrix:
     - os: linux
       env: ATOM_CHANNEL=beta
 
-    - os: osx
-      env: ATOM_CHANNEL=stable
-
 ### Generic setup follows ###
 script:
   - curl -s -O https://raw.githubusercontent.com/atom/ci/master/build-package.sh
@@ -32,10 +29,12 @@ git:
 
 sudo: false
 
+dist: trusty
+
 addons:
   apt:
     packages:
     - build-essential
-    - git
-    - libgnome-keyring-dev
     - fakeroot
+    - git
+    - libsecret-1-dev

CONTRIBUTING.md

@@ -12,8 +12,7 @@ Please note that modifications should follow these coding guidelines:
 
 -   Indent is 2 spaces.
 
--   Code should pass [CoffeeLint](http://www.coffeelint.org/) with the provided
-    `coffeelint.json`
+-   Code should pass [ESlint](https://eslint.org/).
 
 -   Vertical whitespace helps readability, don’t be afraid to use it.
 

lib/main.js

@@ -1,25 +1,58 @@
 'use babel';
 
-/* eslint-disable import/extensions, import/no-extraneous-dependencies */
+// eslint-disable-next-line import/no-extraneous-dependencies, import/extensions
 import { CompositeDisposable } from 'atom';
-/* eslint-enable import/extensions, import/no-extraneous-dependencies */
 
-let helpers = null;
-let path = null;
+// Dependencies
+let fs;
+let path;
+let helpers;
+
+// Internal Variables
+let bundledCsslintPath;
+
+const loadDeps = () => {
+  if (!fs) {
+    fs = require('fs-plus');
+  }
+  if (!path) {
+    path = require('path');
+  }
+  if (!helpers) {
+    helpers = require('atom-linter');
+  }
+};
 
 export default {
   activate() {
-    require('atom-package-deps').install('linter-csslint');
+    this.idleCallbacks = new Set();
+    let depsCallbackID;
+    const installLinterCsslintDeps = () => {
+      this.idleCallbacks.delete(depsCallbackID);
+      if (!atom.inSpecMode()) {
+        require('atom-package-deps').install('linter-csslint');
+      }
+      loadDeps();
+
+      // FIXME: Remove this after a few versions
+      if (atom.config.get('linter-csslint.disableTimeout')) {
+        atom.config.unset('linter-csslint.disableTimeout');
+      }
+    };
+    depsCallbackID = window.requestIdleCallback(installLinterCsslintDeps);
+    this.idleCallbacks.add(depsCallbackID);
 
     this.subscriptions = new CompositeDisposable();
     this.subscriptions.add(
-      atom.config.observe('linter-csslint.disableTimeout', (value) => {
-        this.disableTimeout = value;
+      atom.config.observe('linter-csslint.executablePath', (value) => {
+        this.executablePath = value;
       }),
     );
   },
 
   deactivate() {
+    this.idleCallbacks.forEach(callbackID => window.cancelIdleCallback(callbackID));
+    this.idleCallbacks.clear();
     this.subscriptions.dispose();
   },
 
@@ -28,77 +61,129 @@ export default {
       name: 'CSSLint',
       grammarScopes: ['source.css', 'source.html'],
       scope: 'file',
-      lintOnFly: true,
-      lint(textEditor) {
-        if (!helpers) {
-          helpers = require('atom-linter');
-        }
-        if (!path) {
-          path = require('path');
-        }
+      lintsOnChange: false,
+      lint: async (textEditor) => {
+        loadDeps();
         const filePath = textEditor.getPath();
         const text = textEditor.getText();
-        if (text.length === 0) {
-          return Promise.resolve([]);
+        if (!filePath || text.length === 0) {
+          // Empty or unsaved file
+          return [];
         }
-        const parameters = ['--format=json', '-'];
-        const exec = path.join(__dirname, '..', 'node_modules', 'atomlinter-csslint', 'cli.js');
+
+        const parameters = [
+          '--format=json',
+          filePath,
+        ];
+
         const projectPath = atom.project.relativizePath(filePath)[0];
         let cwd = projectPath;
-        if (!(cwd)) {
+        if (!cwd) {
           cwd = path.dirname(filePath);
         }
-        const options = { stdin: text, cwd };
-        if (this.disableTimeout) {
-          options.timeout = Infinity;
+
+        const execOptions = {
+          cwd,
+          uniqueKey: `linter-csslint::${filePath}`,
+          timeout: 1000 * 30, // 30 seconds
+          ignoreExitCode: true,
+        };
+
+        const execPath = this.determineExecPath(this.executablePath, projectPath);
+
+        const output = await helpers.exec(execPath, parameters, execOptions);
+
+        if (textEditor.getText() !== text) {
+          // The editor contents have changed, tell Linter not to update
+          return null;
         }
-        return helpers.execNode(exec, parameters, options).then((output) => {
-          if (textEditor.getText() !== text) {
-            // The editor contents have changed, tell Linter not to update
-            return null;
-          }
 
-          const toReturn = [];
-          if (output.length < 1) {
-            // No output, no errors
-            return toReturn;
+        const toReturn = [];
+
+        if (output.length < 1) {
+          // No output, no errors
+          return toReturn;
+        }
+
+        let lintResult;
+        try {
+          lintResult = JSON.parse(output);
+        } catch (e) {
+          const excerpt = 'Invalid response received from CSSLint, check ' +
+            'your console for more details.';
+          return [{
+            severity: 'error',
+            excerpt,
+            location: {
+              file: filePath,
+              position: helpers.generateRange(textEditor, 0),
+            },
+          }];
+        }
+
+        if (lintResult.messages.length < 1) {
+          // Output, but no errors found
+          return toReturn;
+        }
+
+        lintResult.messages.forEach((data) => {
+          let line;
+          let col;
+          if (!(data.line && data.col)) {
+            // Use the file start if a location wasn't defined
+            [line, col] = [0, 0];
+          } else {
+            [line, col] = [data.line - 1, data.col - 1];
           }
 
-          const lintResult = JSON.parse(output);
+          const severity = data.type === 'error' ? 'error' : 'warning';
 
-          if (lintResult.messages.length < 1) {
-            // Output, but no errors found
-            return toReturn;
+          const msg = {
+            severity,
+            excerpt: data.message,
+            location: {
+              file: filePath,
+              position: helpers.generateRange(textEditor, line, col),
+            },
+          };
+          if (data.rule.id && data.rule.desc) {
+            msg.details = `${data.rule.desc} (${data.rule.id})`;
+          }
+          if (data.rule.url) {
+            msg.url = data.rule.url;
           }
 
-          lintResult.messages.forEach((data) => {
-            let line;
-            let col;
-            if (!(data.line && data.col)) {
-              // Use the file start if a location wasn't defined
-              [line, col] = [0, 0];
-            } else {
-              [line, col] = [data.line - 1, data.col - 1];
-            }
-
-            const msg = {
-              type: data.type.charAt(0).toUpperCase() + data.type.slice(1),
-              text: data.message,
-              filePath,
-              range: helpers.generateRange(textEditor, line, col),
-            };
-
-            if (data.rule.id && data.rule.desc) {
-              msg.trace = [{
-                type: 'Trace',
-                text: `[${data.rule.id}] ${data.rule.desc}`,
-              }];
-            }
-            toReturn.push(msg);
-          });
-          return toReturn;
+          toReturn.push(msg);
         });
+
+        return toReturn;
       },
     };
   },
+
+  determineExecPath(givenPath, projectPath) {
+    let execPath = givenPath;
+    if (execPath === '') {
+      // Use the bundled copy of CSSLint
+      let relativeBinPath = path.join('node_modules', '.bin', 'csslint');
+      if (process.platform === 'win32') {
+        relativeBinPath += '.cmd';
+      }
+      if (!bundledCsslintPath) {
+        const packagePath = atom.packages.resolvePackagePath('linter-csslint');
+        bundledCsslintPath = path.join(packagePath, relativeBinPath);
+      }
+      execPath = bundledCsslintPath;
+      if (projectPath) {
+        const localCssLintPath = path.join(projectPath, relativeBinPath);
+        if (fs.existsSync(localCssLintPath)) {
+          execPath = localCssLintPath;
+        }
+      }
+    } else {
+      // Normalize any usage of ~
+      fs.normalize(execPath);
+    }
+    return execPath;
+  },
 };

package.json

@@ -13,27 +13,29 @@
   "license": "MIT",
   "private": true,
   "configSchema": {
-    "disableTimeout": {
-      "type": "boolean",
-      "description": "Disable the 10 second execution timeout",
-      "default": false
+    "executablePath": {
+      "type": "string",
+      "default": "",
+      "description": "If unset a project local install of CSSLint is attempted to be used first, falling back to the bundled version. Requires a full path to `csslint` (e.g.: `/usr/bin/csslint` or `C:\\foo\\bar\\csslint.cmd`)."
     }
   },
   "engines": {
     "atom": ">=1.4.0 <2.0.0"
   },
   "dependencies": {
     "atom-linter": "^10.0.0",
-    "atom-package-deps": "^4.0.1",
-    "atomlinter-csslint": "0.10.1"
+    "atom-package-deps": "^4.6.0",
+    "csslint": "^1.0.5",
+    "fs-plus": "^3.0.1"
   },
   "devDependencies": {
-    "eslint": "^3.15.0",
-    "eslint-config-airbnb-base": "^11.1.0",
-    "eslint-plugin-import": "^2.2.0"
+    "eslint": "^4.3.0",
+    "eslint-config-airbnb-base": "^11.3.1",
+    "eslint-plugin-import": "^2.7.0",
+    "jasmine-fix": "^1.3.0"
   },
   "package-deps": [
-    "linter"
+    "linter:2.0.0"
   ],
   "scripts": {
     "lint": "eslint .",
@@ -56,13 +58,14 @@
       "atom": true
     },
     "env": {
-      "node": true
+      "node": true,
+      "browser": true
     }
   },
   "providedServices": {
     "linter": {
       "versions": {
-        "1.0.0": "provideLinter"
+        "2.0.0": "provideLinter"
       }
     }
   }

spec/.eslintrc.js

@@ -1,6 +1,14 @@
 module.exports = {
   env: {
     jasmine: true,
-    atomtest: true
+    atomtest: true,
+  },
+  rules: {
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true
+      }
+    ]
   }
 };