feat: add html lint pref disable, fix mainview integ tests due to html lint panel

Author: abose

src/extensions/default/HTMLCodeHints/html-lint.js

@@ -31,10 +31,20 @@ define(function (require, exports, module) {
         Strings            = brackets.getModule("strings"),
         EditorManager      = brackets.getModule("editor/EditorManager"),
         ProjectManager     = brackets.getModule("project/ProjectManager"),
+        PreferencesManager = brackets.getModule("preferences/PreferencesManager"),
         IndexingWorker     = brackets.getModule("worker/IndexingWorker");
 
     IndexingWorker.loadScriptInWorker(`${module.uri}/../worker/html-worker.js`);
 
+    const prefs = PreferencesManager.getExtensionPrefs("HTMLLint");
+    const PREFS_HTML_LINT_DISABLED = "disabled";
+
+    prefs.definePreference(PREFS_HTML_LINT_DISABLED, "boolean", false, {
+        description: Strings.DESCRIPTION_HTML_LINT_DISABLE
+    }).on("change", function () {
+        CodeInspection.requestRun(Strings.HTML_LINT_NAME);
+    });
+
     function getTypeFromSeverity(sev) {
         // https://html-validate.org/guide/api/getting-started.html
         switch (sev) {
@@ -82,7 +92,7 @@ define(function (require, exports, module) {
         name: Strings.HTML_LINT_NAME,
         scanFileAsync: lintOneFile,
         canInspect: function (_fullPath) {
-            return true; // no restrictions for now
+            return !prefs.get(PREFS_HTML_LINT_DISABLED);
         }
     });
 });

src/extensions/default/JSLint/ESLint.js

@@ -269,6 +269,8 @@ define(function (require, exports, module) {
             if(!Phoenix.isNativeApp) {
                 return;
             }
+            // just do a dummy eslint to warm up/load the eslint runner service for the project and dispose old service
+            // on project switch.
             NodeUtils.ESLintFile("console.log();", "a.js", ProjectManager.getProjectRoot().fullPath)
                 .catch(e=>{
                     console.error(`Error warming up ESLint service`, e);

src/nls/root/strings.js

@@ -970,6 +970,7 @@ define({
     "DESCRIPTION_NO_HINTS_ON_DOT": "true to not automatically show JS code hints when . is typed",
     "DESCRIPTION_JSHINT_DISABLE": "true to disable JSHints linter in problems panel",
     "DESCRIPTION_ESLINT_DISABLE": "true to disable ESLint linter in problems panel",
+    "DESCRIPTION_HTML_LINT_DISABLE": "true to disable HTML linter in problems panel",
     "DESCRIPTION_ESLINT_FAILED": "ESLint Failed ({0}). Make sure the project contains valid <a href='https://eslint.org/docs/latest/use/configure/configuration-files'>Configuration Files</a>",
     "DESCRIPTION_ESLINT_USE_NATIVE_APP": "ESLint is only available in the Desktop app. Download it from <a href='https://phcode.io'>phcode.io</a>",
     "DESCRIPTION_ESLINT_LOAD_FAILED": "Failed to load ESLint for this project. {APP_NAME} supports only ESLint versions above 7.",

src/thirdparty/licences/language-services.markdown

@@ -10,6 +10,11 @@ Copyright (c) Microsoft
 MIT License
 Copyright (c) 2017 Chai.js Assertion Library
 
+## html-validate
+MIT License
+Copyright (c) 2017 David Sveningsson <[email protected]>
+https://html-validate.org/
+
 ## test/thirparty/mocha
 (The MIT License)
 Copyright (c) 2011-2022 OpenJS Foundation and contributors, https://openjsf.org

test/spec/MainViewManager-integ-test.js

@@ -34,6 +34,7 @@ define(function (require, exports, module) {
         Dialogs,                 // loaded from brackets.test
         DefaultDialogs,
         WorkspaceManager,
+        PreferencesManager,
         Menus,
         SpecRunnerUtils          = require("spec/SpecRunnerUtils"),
         KeyEvent                 = require("utils/KeyEvent");
@@ -58,6 +59,7 @@ define(function (require, exports, module) {
             DocumentManager         = testWindow.brackets.test.DocumentManager;
             EditorManager           = testWindow.brackets.test.EditorManager;
             DefaultDialogs          = testWindow.brackets.test.DefaultDialogs;
+            PreferencesManager      = testWindow.brackets.test.PreferencesManager;
             MainViewManager         = testWindow.brackets.test.MainViewManager;
             ProjectManager          = testWindow.brackets.test.ProjectManager;
             WorkspaceManager        = testWindow.brackets.test.WorkspaceManager;
@@ -71,6 +73,12 @@ define(function (require, exports, module) {
         beforeAll(async function () {
             testWindow = await SpecRunnerUtils.createTestWindowAndRun({forceReload: true});
             await _init();
+            // we have to disable html lint here as html lint panel interferes with the panel view tests,
+            // which was created before we added html lint. Since we only test the panel functionality, not having html
+            // lint won't impact test correctness.
+            const prefs = PreferencesManager.getExtensionPrefs("HTMLLint");
+            const PREFS_HTML_LINT_DISABLED = "disabled";
+            prefs.set(PREFS_HTML_LINT_DISABLED, true);
         }, 30000);
 
         afterAll(async function () {
@@ -83,6 +91,7 @@ define(function (require, exports, module) {
             EditorManager           = null;
             ProjectManager          = null;
             FileSystem              = null;
+            PreferencesManager      = null;
             await SpecRunnerUtils.closeTestWindow();
         }, 30000);