Merge pull request #2441 from ajaxorg/python-linting

[Liskov] Python linting integration (using pylint)

Author: lennartcl

Makefile

@@ -77,6 +77,7 @@ plugins-client/lib.ace/www/worker/worker-language.js plugins-client/lib.ace/www/
 	ln -s `pwd`/plugins-client/ext.htmllanguage /tmp/c9_worker_build/ext/htmllanguage
 	ln -s `pwd`/plugins-client/ext.linereport /tmp/c9_worker_build/ext/linereport
 	ln -s `pwd`/plugins-client/ext.linereport_php /tmp/c9_worker_build/ext/linereport_php
+	ln -s `pwd`/plugins-client/ext.linereport_python /tmp/c9_worker_build/ext/linereport_python
 	node Makefile.dryice.js worker
 	cp node_modules/ace/build/src/worker* plugins-client/lib.ace/www/worker
 

Makefile.dryice.js

@@ -74,6 +74,7 @@ function worker(project) {
                     'ext/codecomplete/mode_completer',
                     'ext/linereport/linereport_base',
                     'ext/linereport_php/linereport_php_worker',
+                    'ext/linereport_python/linereport_python_worker',
                 ]
             })
         ],

configs/default.js

@@ -98,6 +98,7 @@ var config = [
             "ext/help/help",
             "ext/linereport/linereport",
             "ext/linereport_php/linereport_php",
+            "ext/linereport_python/linereport_python",
             //"ext/ftp/ftp",
             "ext/code/code",
             "ext/statusbar/statusbar",

plugins-client/ext.linereport/linereport_base.js

@@ -120,7 +120,7 @@ worker.parseOutput = function(output, processLine) {
         var line = lines[i];
         if (processLine)
             line = processLine(line);
-        var result = line.charAt ? this.$parseOutputLine(line) : line;
+        var result = (line && line.charAt) ? this.$parseOutputLine(line) : line;
         if (result)
             results.push(result);
     }

plugins-client/ext.linereport_php/linereport_php_worker.js

@@ -10,6 +10,7 @@ var baseLanguageHandler = require("ext/linereport/linereport_base");
 var handler = module.exports = Object.create(baseLanguageHandler);
 
 handler.disabled = false;
+handler.$isInited = false;
 
 handler.$isInited = false;
 

plugins-client/ext.linereport_python/linereport_python.js

@@ -0,0 +1,39 @@
+/**
+ * PHP linter
+ *
+ * @copyright 2011, Ajax.org B.V.
+ * @license GPLv3 <http://www.gnu.org/licenses/gpl.txt>
+ */
+define(function(require, exports, module) {
+
+var ext = require("core/ext");
+var editors = require("ext/editors/editors");
+var language = require("ext/language/language");
+var linereport = require("ext/linereport/linereport");
+
+module.exports = ext.register("ext/linereport_python/linereport_python", {
+    name    : "Python Line Reporting Support",
+    dev     : "Ajax.org",
+    type    : ext.GENERAL,
+    deps    : [editors, language, linereport],
+    nodes   : [],
+    alone   : true,
+
+    init : function() {
+        language.registerLanguageHandler(
+            'ext/linereport_python/linereport_python_worker',
+            language.isWorkerEnabled()
+        );
+    },
+    
+    enable : function() {
+    },
+
+    disable : function() {
+    },
+
+    destroy : function() {
+    }
+});
+
+});

plugins-client/ext.linereport_python/linereport_python_worker.js

@@ -0,0 +1,47 @@
+/**
+ * PHP linter worker.
+ *
+ * @copyright 2011, Ajax.org B.V.
+ * @license GPLv3 <http://www.gnu.org/licenses/gpl.txt>
+ */
+define("ext/linereport_python/linereport_python_worker", ["require", "exports", "module"], function(require, exports, module) {
+
+var baseLanguageHandler = require("ext/linereport/linereport_base");
+var handler = module.exports = Object.create(baseLanguageHandler);
+
+handler.disabled = false;
+handler.$isInited = false;
+
+handler.handlesLanguage = function(language) {
+    return language === 'python';
+};
+
+handler.init = function(callback) {
+    handler.initReporter("pylint --version", "exit 1 # pylint isn't installed", function(err, output) {
+        if (err) {
+            console.log("Unable to lint Python\n" + output);
+            handler.disabled = true;
+        }
+        callback();
+    });
+};
+
+handler.analyze = function(doc, fullAst, callback) {
+    if (handler.disabled)
+        return callback();
+    handler.invokeReporter("pylint -i y -E " + handler.workspaceDir + "/" + handler.path,
+        this.$postProcess, callback);
+};
+
+/**
+ * Postprocess Python output to match the expected format
+ * line:column: error message.
+ */
+handler.$postProcess = function(line) {
+    var pylintRegex = /^E\d{4}:\s*(\d+),(\d+):(.*)$/;
+    return pylintRegex.test(line) && line.replace(pylintRegex, "$1:$2: $3/");
+};
+
+});
+
+

plugins-client/ext.linereport_python/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "ext.linereport_python",
+    "version": "0.0.1",
+    "main": "linereport-python-ext.js",
+    "private": true,
+    "plugin": {
+        "provides": [
+            "ext.linereport_python"
+        ],
+        "consumes": [
+            "client-plugins"
+        ]
+    }
+}