feat: css Linter Language service integration

Author: abose

package-lock.json

@@ -91,7 +91,7 @@
         "@fortawesome/fontawesome-free": "^6.1.2",
         "@highlightjs/cdn-assets": "^11.5.1",
         "@phcode/fs": "^3.0.0",
-        "@phcode/language-support": "^1.0.5",
+        "@phcode/language-support": "^1.0.6",
         "@pixelbrackets/gfm-stylesheet": "^1.1.0",
         "@prettier/plugin-php": "^0.22.2",
         "@uiw/file-icons": "^1.3.2",

package.json

@@ -0,0 +1,76 @@
+/*
+ * GNU AGPL-3.0 License
+ *
+ * Copyright (c) 2021 - present core.ai . All rights reserved.
+ * Original work Copyright (c) 2012 - 2021 Adobe Systems Incorporated. All rights reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.
+ *
+ */
+
+// Parts of this file is adapted from https://github.com/cfjedimaster/brackets-jshint
+
+/**
+ * Provides JSLint results via the core linting extension point
+ */
+define(function (require, exports, module) {
+
+    // Load dependent modules
+    const CodeInspection     = brackets.getModule("language/CodeInspection"),
+        Strings            = brackets.getModule("strings"),
+        IndexingWorker     = brackets.getModule("worker/IndexingWorker");
+
+    IndexingWorker.loadScriptInWorker(`${module.uri}/../worker/css-worker.js`);
+
+    function getTypeFromSeverity(sev) {
+        switch (sev) {
+        case 1:  return CodeInspection.Type.ERROR;
+        case 2:  return CodeInspection.Type.WARNING;
+        default: return CodeInspection.Type.META;
+        }
+    }
+
+    /**
+     * Run JSLint on the current document. Reports results to the main UI. Displays
+     * a gold star when no errors are found.
+     */
+    async function lintOneFile(text, fullPath) {
+        return new Promise((resolve)=>{
+            IndexingWorker.execPeer("cssLint", {
+                text,
+                cssMode: "CSS",
+                filePath: fullPath
+            }).then(lintResult =>{
+                if (lintResult && lintResult.length) {
+                    lintResult = lintResult.map(function (lintError) {
+                        return {
+                            pos: { line: lintError.range.start.line, ch: lintError.range.start.character },
+                            message: `${lintError.message} (${lintError.code})`,
+                            type: getTypeFromSeverity(lintError.severity)
+                        };
+                    });
+
+                    resolve({ errors: lintResult });
+                }
+                resolve();
+            });
+        });
+    }
+
+    // Register for JS files
+    CodeInspection.register("css", {
+        name: Strings.CSS_LINT_NAME,
+        scanFileAsync: lintOneFile
+    });
+});

src/extensions/default/CSSCodeHints/css-lint.js

@@ -35,6 +35,7 @@ define(function (require, exports, module) {
         CSSProperties       = require("text!CSSProperties.json"),
         properties          = JSON.parse(CSSProperties);
 
+    require("./css-lint");
 
     const cssWideKeywords = ['initial', 'inherit', 'unset', 'var()', 'calc()'];
 

src/extensions/default/CSSCodeHints/main.js

@@ -0,0 +1,38 @@
+/*
+ * GNU AGPL-3.0 License
+ *
+ * Copyright (c) 2021 - present core.ai . All rights reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.
+ *
+ */
+
+/*global Phoenix, WorkerComm, CSSLanguageService*/
+
+(function () {
+    function cssLint(params) {
+        return  CSSLanguageService.validateCSS(params.text, params.cssMode, params.filePath, {
+            duplicateProperties: "warning",
+            zeroUnits: "warning",
+            emptyRules: "warning",
+            unknownProperties: "warning",
+            ieHack: "warning",
+            propertyIgnoredDueToDisplay: "warning",
+            fontFaceProperties: "warning",
+            unknownVendorSpecificProperties: "warning"
+        });
+    }
+
+    WorkerComm.setExecHandler("cssLint", cssLint);
+}());

src/extensions/default/CSSCodeHints/worker/css-worker.js

@@ -876,6 +876,9 @@ define({
     // extensions/default/JSLint
     "JSHINT_NAME": "JSHint",
 
+    // extension css code hints
+    "CSS_LINT_NAME": "CSS Lint",
+
     // Features/QuickView and quick view extensions
     "CMD_ENABLE_QUICK_VIEW": "Quick View on Hover",
     "CMD_ENABLE_SELECTION_VIEW": "Selection View",