Add html to KnownLanguages, QP config, mute & disable commands

SonarSource · Jan 22, 2025 · 79c0043 · 79c0043
1 parent 567333a
commit 79c0043
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 89 deletions.
diff --git a/src/ConnectedMode/Binding/NonRoslynDummyBindingConfigProvider.cs b/src/ConnectedMode/Binding/NonRoslynDummyBindingConfigProvider.cs
@@ -34,7 +34,8 @@ internal class NonRoslynDummyBindingConfigProvider : IBindingConfigProvider
         Language.Js,
         Language.Ts,
         Language.Secrets,
-        Language.Css
+        Language.Css,
+        Language.Html,
     ];
 
     public bool IsLanguageSupported(Language language) => SupportedLanguages.Contains(language);

diff --git a/src/Core.UnitTests/LanguageTests.cs b/src/Core.UnitTests/LanguageTests.cs
@@ -77,21 +77,6 @@ public void Language_ISupported_UnsupportedLanguage_IsFalse()
             other.IsSupported.Should().BeFalse();
         }
 
-        [TestMethod]
-        public void Language_ServerLanguageObjectsAndKeys()
-        {
-            // Act + Assert
-            Language.CSharp.ServerLanguage.Key.Should().Be(SonarLanguageKeys.CSharp);
-            Language.VBNET.ServerLanguage.Key.Should().Be(SonarLanguageKeys.VBNet);
-            Language.Cpp.ServerLanguage.Key.Should().Be(SonarLanguageKeys.CPlusPlus);
-            Language.C.ServerLanguage.Key.Should().Be(SonarLanguageKeys.C);
-            Language.Js.ServerLanguage.Key.Should().Be(SonarLanguageKeys.JavaScript);
-            Language.Ts.ServerLanguage.Key.Should().Be(SonarLanguageKeys.TypeScript);
-            Language.Css.ServerLanguage.Key.Should().Be(SonarLanguageKeys.Css);
-            Language.Secrets.ServerLanguage.Key.Should().Be(SonarLanguageKeys.Secrets);
-            Language.Unknown.ServerLanguage.Should().BeNull();
-        }
-
         [TestMethod]
         public void Language_Equality()
         {
@@ -115,6 +100,7 @@ public void GetLanguageFromLanguageKey_GetsCorrectLanguage()
             var js = Language.GetLanguageFromLanguageKey("js");
             var ts = Language.GetLanguageFromLanguageKey("ts");
             var css = Language.GetLanguageFromLanguageKey("css");
+            var html = Language.GetLanguageFromLanguageKey("Web");
             var unknown = Language.GetLanguageFromLanguageKey("unknown");
 
             cs.Should().Be(Language.CSharp);
@@ -124,6 +110,7 @@ public void GetLanguageFromLanguageKey_GetsCorrectLanguage()
             js.Should().Be(Language.Js);
             ts.Should().Be(Language.Ts);
             css.Should().Be(Language.Css);
+            html.Should().Be(Language.Html);
             unknown.Should().Be(null);
         }
 
@@ -137,6 +124,7 @@ public void GetLanguageFromRepositoryKey_GetsCorrectLanguage()
             var js = Language.GetLanguageFromRepositoryKey("javascript");
             var ts = Language.GetLanguageFromRepositoryKey("typescript");
             var css = Language.GetLanguageFromRepositoryKey("css");
+            var html = Language.GetLanguageFromRepositoryKey("Web");
             var secrets = Language.GetLanguageFromRepositoryKey("secrets");
             var unknown = Language.GetLanguageFromRepositoryKey("unknown");
 
@@ -151,6 +139,7 @@ public void GetLanguageFromRepositoryKey_GetsCorrectLanguage()
             js.Should().Be(Language.Js);
             ts.Should().Be(Language.Ts);
             css.Should().Be(Language.Css);
+            html.Should().Be(Language.Html);
             secrets.Should().Be(Language.Secrets);
             unknown.Should().Be(null);
 
@@ -169,6 +158,7 @@ public void GetSonarRepoKeyFromLanguageKey_GetsCorrectRepoKey()
             Language.GetSonarRepoKeyFromLanguage(Language.Js).Should().Be("javascript");
             Language.GetSonarRepoKeyFromLanguage(Language.Ts).Should().Be("typescript");
             Language.GetSonarRepoKeyFromLanguage(Language.Css).Should().Be("css");
+            Language.GetSonarRepoKeyFromLanguage(Language.Html).Should().Be("Web");
 
             Language.GetSonarRepoKeyFromLanguage(Language.Unknown).Should().BeNull();
 

diff --git a/src/Core/Language.cs b/src/Core/Language.cs
@@ -118,7 +118,7 @@ public static IEnumerable<Language> KnownLanguages
         {
             get
             {
-                return new[] { CSharp, VBNET, Cpp, C, Js, Ts, Css, Secrets };
+                return new[] { CSharp, VBNET, Cpp, C, Js, Ts, Css, Html, Secrets };
             }
         }
 

diff --git a/src/Core/SonarArtefactKeys.cs b/src/Core/SonarArtefactKeys.cs
@@ -36,34 +36,6 @@ namespace SonarLint.VisualStudio.Core
     //
     // * rule definition: part of a single repository. The full rule id is given by "[repo id]:[rule id]"
 
-    /// <summary>
-    /// Language keys for languages supported by SonarQube/Cloud plugins
-    /// </summary>
-    /// <remarks>A full list of languages keys can be obtained by calling https://sonarcloud.io/api/languages/list
-    /// </remarks>
-    public static class SonarLanguageKeys
-    {
-        // TODO: the SonarQube.Client assembly has a class that defines the SonarQube language keys:
-        // see SonarQube.Client.Models.SonarQubeLanguage. We shouldn't need both definitions.
-        public const string CSharp = "cs";
-        public const string VBNet = "vbnet";
-        public const string JavaScript = "js";
-        public const string TypeScript = "ts";
-        public const string Css = "css";
-        public const string C = "c";
-        public const string CPlusPlus = "cpp";
-        public const string Secrets = "secrets";
-    }
-
-    public static class SonarPluginKeys
-    {
-        public const string SonarCSharp = "csharp";
-        public const string SonarVBNet = "vbnet";
-        public const string SonarCFamily = "cpp";
-        public const string SonarJs = "javascript";
-        public const string SonarSecrets = "text";
-    }
-
     public static class SonarRuleRepoKeys
     {
         public const string JavaScript = "javascript";

diff --git a/src/Core/Telemetry/ITelemetryManager.cs b/src/Core/Telemetry/ITelemetryManager.cs
@@ -28,8 +28,6 @@ public interface ITelemetryManager
 
     void OptIn();
 
-    void LanguageAnalyzed(string languageKey, TimeSpan analysisTime);
-
     void TaintIssueInvestigatedLocally();
 
     void TaintIssueInvestigatedRemotely();

diff --git a/src/Integration.UnitTests/Telemetry/TelemetryManagerTests.cs b/src/Integration.UnitTests/Telemetry/TelemetryManagerTests.cs
@@ -135,26 +135,6 @@ public void QuickFixApplied_CallsRpcService()
         });
     }
 
-    [DataTestMethod]
-    [DataRow(SonarLanguageKeys.C, Language.C, 1)]
-    [DataRow(SonarLanguageKeys.CPlusPlus, Language.CPP, 2)]
-    [DataRow(SonarLanguageKeys.CSharp, Language.CS, 3)]
-    [DataRow(SonarLanguageKeys.VBNet, Language.VBNET, 4)]
-    [DataRow(SonarLanguageKeys.JavaScript, Language.JS, 5)]
-    [DataRow(SonarLanguageKeys.TypeScript, Language.TS, 6)]
-    [DataRow(SonarLanguageKeys.Css, Language.CSS, 7)]
-    [DataRow(SonarLanguageKeys.Secrets, Language.SECRETS, 8)]
-    public void LanguageAnalyzed_CallsRpcService(string languageKey, Language language, int analysisTimeMs)
-    {
-        telemetryManager.LanguageAnalyzed(languageKey, TimeSpan.FromMilliseconds(analysisTimeMs));
-
-        Received.InOrder(() =>
-        {
-            telemetryHandler.Notify(Arg.Any<Action<ITelemetrySLCoreService>>());
-            telemetryService.AnalysisDoneOnSingleLanguage(Arg.Is<AnalysisDoneOnSingleLanguageParams>(a => a.language == language && a.analysisTimeMs == analysisTimeMs));
-        });
-    }
-
     [DataTestMethod]
     [DataRow(true)]
     [DataRow(false)]

diff --git a/src/Integration.Vsix.UnitTests/Analysis/DisableRuleCommandTests.cs b/src/Integration.Vsix.UnitTests/Analysis/DisableRuleCommandTests.cs
@@ -83,6 +83,7 @@ public void CommandRegistration()
         [DataRow("javascript:S333")]
         [DataRow("typescript:S444")]
         [DataRow("css:S777")]
+        [DataRow("Web:S787")]
         [DataRow("secrets:S555")]
         public void CheckStatusAndExecute_SingleIssue_SupportedRepo_StandaloneMode_VisibleAndEnabled(string errorCode)
         {
@@ -119,6 +120,8 @@ public void CheckStatusAndExecute_SingleIssue_SupportedRepo_StandaloneMode_Visib
         [DataRow("typescript:S111", SonarLintMode.LegacyConnected, false)]
         [DataRow("css:S111", SonarLintMode.Connected, false)]
         [DataRow("css:S111", SonarLintMode.LegacyConnected, false)]
+        [DataRow("Web:S111", SonarLintMode.Connected, false)]
+        [DataRow("Web:S111", SonarLintMode.LegacyConnected, false)]
         public void CheckStatus_SingleIssue_SupportedRepo_ConnectedMode_HasExpectedEnabledStatus(string errorCode, SonarLintMode bindingMode,
             bool expectedEnabled)
         {

diff --git a/src/Integration.Vsix.UnitTests/Analysis/MuteIssueCommandTests.cs b/src/Integration.Vsix.UnitTests/Analysis/MuteIssueCommandTests.cs
@@ -155,6 +155,7 @@ public void QueryStatus_NotInConnectedMode_VisibleButDisabled()
     [DataRow("javascript:S333")]
     [DataRow("typescript:S444")]
     [DataRow("css:S555")]
+    [DataRow("Web:S545")]
     [DataRow("csharpsquid:S555")]
     [DataRow("vbnet:S555")]
     public void QueryStatus_ConnectedModeAndSupportedIssue_VisibleAndEnabled(string errorCode)

diff --git a/src/Integration.Vsix/Analysis/DisableRuleCommand.cs b/src/Integration.Vsix/Analysis/DisableRuleCommand.cs
@@ -148,6 +148,7 @@ private void Execute(object sender, EventArgs e)
             SonarRuleRepoKeys.JavaScript,
             SonarRuleRepoKeys.TypeScript,
             SonarRuleRepoKeys.Css,
+            SonarRuleRepoKeys.HtmlRules,
             SonarRuleRepoKeys.Secrets,
         };
 

diff --git a/src/Integration.Vsix/Analysis/MuteIssueCommand.cs b/src/Integration.Vsix/Analysis/MuteIssueCommand.cs
@@ -29,6 +29,7 @@
 using SonarLint.VisualStudio.Core.Suppressions;
 using SonarLint.VisualStudio.Core.Transition;
 using SonarLint.VisualStudio.Infrastructure.VS;
+using SonarQube.Client.Models;
 using MessageBox = SonarLint.VisualStudio.Core.MessageBox;
 using Task = System.Threading.Tasks.Task;
 
@@ -193,6 +194,7 @@ private async Task<bool> MuteIssueAsync(IFilterableIssue issue)
             SonarRuleRepoKeys.JavaScript,
             SonarRuleRepoKeys.TypeScript,
             SonarRuleRepoKeys.Css,
+            SonarRuleRepoKeys.HtmlRules,
             SonarRuleRepoKeys.CSharpRules,
             SonarRuleRepoKeys.VBNetRules
         };

diff --git a/src/Integration/Telemetry/TelemetryManager.cs b/src/Integration/Telemetry/TelemetryManager.cs
@@ -54,13 +54,6 @@ public TelemetryManager(ISlCoreTelemetryHelper telemetryHelper, IKnownUIContexts
 
     public void OptOut() => telemetryHelper.Notify(telemetryService => telemetryService.DisableTelemetry());
 
-    public void LanguageAnalyzed(string languageKey, TimeSpan analysisTime)
-    {
-        var language = Convert(languageKey);
-        telemetryHelper.Notify(telemetryService =>
-            telemetryService.AnalysisDoneOnSingleLanguage(new AnalysisDoneOnSingleLanguageParams(language, (int)Math.Round(analysisTime.TotalMilliseconds))));
-    }
-
     public void TaintIssueInvestigatedLocally() => telemetryHelper.Notify(telemetryService => telemetryService.TaintVulnerabilitiesInvestigatedLocally());
 
     public void TaintIssueInvestigatedRemotely() => telemetryHelper.Notify(telemetryService => telemetryService.TaintVulnerabilitiesInvestigatedRemotely());
@@ -77,29 +70,19 @@ private void OnCSharpProjectContextChanged(object sender, UIContextChangedEventA
     {
         if (e.Activated)
         {
-            LanguageAnalyzed(SonarLanguageKeys.CSharp, TimeSpan.Zero);
+            LanguageAnalyzed(TimeSpan.Zero, Language.CS);
         }
     }
 
     private void OnVBProjectContextChanged(object sender, UIContextChangedEventArgs e)
     {
         if (e.Activated)
         {
-            LanguageAnalyzed(SonarLanguageKeys.VBNet, TimeSpan.Zero);
+            LanguageAnalyzed(TimeSpan.Zero, Language.VBNET);
         }
     }
 
-    private static Language Convert(string languageKey) =>
-        languageKey switch
-        {
-            SonarLanguageKeys.CPlusPlus => Language.CPP,
-            SonarLanguageKeys.C => Language.C,
-            SonarLanguageKeys.Css => Language.CSS,
-            SonarLanguageKeys.JavaScript => Language.JS,
-            SonarLanguageKeys.TypeScript => Language.TS,
-            SonarLanguageKeys.VBNet => Language.VBNET,
-            SonarLanguageKeys.CSharp => Language.CS,
-            SonarLanguageKeys.Secrets => Language.SECRETS,
-            _ => throw new ArgumentOutOfRangeException(nameof(languageKey), languageKey, null)
-        };
+    private void LanguageAnalyzed(TimeSpan analysisTime, Language language) =>
+        telemetryHelper.Notify(telemetryService =>
+            telemetryService.AnalysisDoneOnSingleLanguage(new AnalysisDoneOnSingleLanguageParams(language, (int)Math.Round(analysisTime.TotalMilliseconds))));
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -118,7 +118,7 @@ public static IEnumerable<Language> KnownLanguages @@
             {
                 get
                 {
-                    return new[] { CSharp, VBNET, Cpp, C, Js, Ts, Css, Secrets };
+                    return new[] { CSharp, VBNET, Cpp, C, Js, Ts, Css, Html, Secrets };
                 }
             }
@@ Expand Down @@