Merge pull request #3629 from 1c-syntax/feature/feat203

Диагностика бессмысленного тернарного оператора

Author: nixel2007

docs/diagnostics/UselessTernaryOperator.md

@@ -0,0 +1,24 @@
+# Бесполезный тернарный оператор (UselessTernaryOperator)
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+Размещение в тернарном операторе булевых констант "Истина" или "Ложь" указывает на плохую продуманность кода. 
+
+## Примеры
+Бессмысленные операторы
+
+```Bsl
+А = ?(Б = 1, Истина, Ложь);
+```
+```Bsl
+А = ?(Б = 0, False, True);
+```
+
+Подозрительные операторы
+
+```Bsl
+А = ?(Б = 1, True, Истина);
+```
+```Bsl
+А = ?(Б = 0, 0, False);
+```

docs/en/diagnostics/UselessTernaryOperator.md

@@ -0,0 +1,24 @@
+# Useless ternary operator (UselessTernaryOperator)
+
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+The placement of Boolean constants "True" or "False" in the ternary operator indicates poor code thoughtfulness.
+
+## Examples
+Useless operators
+
+```Bsl
+A = ?(B = 1, True, False);
+```
+```Bsl
+A = ?(B = 0, False, True);
+```
+
+Suspicious operators
+
+```Bsl
+A = ?(B = 1, True, True);
+```
+```Bsl
+A = ?(B = 0, 0, False);
+```

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/DiagnosticStorage.java

@@ -23,7 +23,6 @@
 
 import com.github._1c_syntax.bsl.languageserver.context.symbol.SourceDefinedSymbol;
 import com.github._1c_syntax.bsl.languageserver.utils.Ranges;
-import org.jspecify.annotations.Nullable;
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.antlr.v4.runtime.Token;
 import org.antlr.v4.runtime.tree.ParseTree;
@@ -32,6 +31,7 @@
 import org.eclipse.lsp4j.DiagnosticCodeDescription;
 import org.eclipse.lsp4j.DiagnosticRelatedInformation;
 import org.eclipse.lsp4j.Range;
+import org.jspecify.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -74,6 +74,17 @@ protected void addDiagnostic(ParserRuleContext node) {
     );
   }
 
+  protected void addDiagnostic(ParserRuleContext node, DiagnosticAdditionalData data) {
+    if (node.exception != null) {
+      return;
+    }
+
+    addDiagnostic(
+      Ranges.create(node),
+      data
+    );
+  }
+
   protected void addDiagnostic(ParserRuleContext node, String diagnosticMessage) {
     if (node.exception != null) {
       return;
@@ -98,6 +109,14 @@ protected void addDiagnostic(Range range) {
     );
   }
 
+  protected void addDiagnostic(Range range, DiagnosticAdditionalData data) {
+    addDiagnostic(
+      range,
+      data,
+      diagnostic.getInfo().getMessage()
+    );
+  }
+
   protected void addDiagnostic(Range range, String diagnosticMessage) {
     addDiagnostic(
       range,
@@ -106,6 +125,15 @@ protected void addDiagnostic(Range range, String diagnosticMessage) {
     );
   }
 
+  protected void addDiagnostic(Range range, DiagnosticAdditionalData data, String diagnosticMessage) {
+    addDiagnostic(
+      range,
+      data,
+      diagnosticMessage,
+      null
+    );
+  }
+
   protected void addDiagnostic(Token token) {
     addDiagnostic(
       Ranges.create(token)
@@ -202,6 +230,20 @@ public void addDiagnostic(
     String diagnosticMessage,
     @Nullable List<DiagnosticRelatedInformation> relatedInformation
   ) {
+    addDiagnostic(
+      range,
+      null,
+      diagnosticMessage,
+      relatedInformation
+    );
+  }
+
+  public void addDiagnostic(
+    Range range,
+    @Nullable DiagnosticAdditionalData data,
+    String diagnosticMessage,
+    @Nullable List<DiagnosticRelatedInformation> relatedInformation
+  ) {
 
     if (Ranges.isEmpty(range)) {
       return;
@@ -210,6 +252,7 @@ public void addDiagnostic(
     diagnosticList.add(createDiagnostic(
       diagnostic,
       range,
+      data,
       diagnosticMessage,
       relatedInformation
     ));
@@ -234,9 +277,20 @@ protected void addDiagnostic(SourceDefinedSymbol sourceDefinedSymbol) {
     addDiagnostic(sourceDefinedSymbol.getSelectionRange());
   }
 
+  /**
+   * Создает доп данные для диагностики на основании строки
+   *
+   * @param string Некая строка для помещения в доп данные диагностики
+   * @return Допданные диагностики
+   */
+  public static DiagnosticAdditionalData createAdditionalData(String string) {
+    return new DiagnosticAdditionalData(string);
+  }
+
   private static Diagnostic createDiagnostic(
     BSLDiagnostic bslDiagnostic,
     Range range,
+    @Nullable DiagnosticAdditionalData data,
     String diagnosticMessage,
     @Nullable List<DiagnosticRelatedInformation> relatedInformation
   ) {
@@ -258,6 +312,21 @@ private static Diagnostic createDiagnostic(
     if (relatedInformation != null) {
       diagnostic.setRelatedInformation(relatedInformation);
     }
+
+    if (data != null) {
+      diagnostic.setData(data);
+    }
     return diagnostic;
   }
+
+  /**
+   * Служебный класс для хранения вспомогательной информации диагностики, которая может использоваться
+   * например в квикфиксах.
+   * Пока реализация примитивная под конкретную задачу
+   *
+   * @param string Некая строка
+   */
+  public record DiagnosticAdditionalData(String string) {
+
+  }
 }

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/UselessTernaryOperatorDiagnostic.java

@@ -0,0 +1,129 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2025
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Fedkin <nixel2007@gmail.com> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import com.github._1c_syntax.bsl.languageserver.context.DocumentContext;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticScope;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
+import com.github._1c_syntax.bsl.languageserver.providers.CodeActionProvider;
+import com.github._1c_syntax.bsl.parser.BSLParser;
+import org.antlr.v4.runtime.tree.ParseTree;
+import org.eclipse.lsp4j.CodeAction;
+import org.eclipse.lsp4j.CodeActionParams;
+import org.eclipse.lsp4j.Diagnostic;
+import org.eclipse.lsp4j.TextEdit;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+@DiagnosticMetadata(
+  type = DiagnosticType.CODE_SMELL,
+  severity = DiagnosticSeverity.INFO,
+  scope = DiagnosticScope.BSL,
+  minutesToFix = 1,
+  tags = {
+    DiagnosticTag.BADPRACTICE,
+    DiagnosticTag.SUSPICIOUS
+  }
+)
+public class UselessTernaryOperatorDiagnostic extends AbstractVisitorDiagnostic implements QuickFixProvider {
+
+  private static final int SKIPPED_RULE_INDEX = 0;
+
+  @Override
+  public ParseTree visitTernaryOperator(BSLParser.TernaryOperatorContext ctx) {
+    var exp = ctx.expression();
+
+    if (exp != null && exp.size() >= 3) {
+      var condition = getBooleanToken(exp.get(0));
+      var trueBranch = getBooleanToken(exp.get(1));
+      var falseBranch = getBooleanToken(exp.get(2));
+
+      if (condition != SKIPPED_RULE_INDEX) {
+        diagnosticStorage.addDiagnostic(ctx);
+      } else if (trueBranch == BSLParser.TRUE && falseBranch == BSLParser.FALSE) {
+        diagnosticStorage.addDiagnostic(ctx, DiagnosticStorage.createAdditionalData(exp.get(0).getText()));
+      } else if (trueBranch == BSLParser.FALSE && falseBranch == BSLParser.TRUE) {
+        diagnosticStorage.addDiagnostic(ctx,
+          DiagnosticStorage.createAdditionalData(getAdaptedText(exp.get(0).getText())));
+      } else if (trueBranch != SKIPPED_RULE_INDEX || falseBranch != SKIPPED_RULE_INDEX) {
+        diagnosticStorage.addDiagnostic(ctx);
+      }
+    }
+
+    return super.visitTernaryOperator(ctx);
+  }
+
+  @Override
+  public List<CodeAction> getQuickFixes(
+    List<Diagnostic> diagnostics,
+    CodeActionParams params,
+    DocumentContext documentContext
+  ) {
+
+    List<TextEdit> textEdits = new ArrayList<>();
+
+    diagnostics.forEach((Diagnostic diagnostic) -> {
+      var range = diagnostic.getRange();
+      var data = diagnostic.getData();
+      if (data instanceof DiagnosticStorage.DiagnosticAdditionalData additionalData) {
+        var textEdit = new TextEdit(range, additionalData.string());
+        textEdits.add(textEdit);
+      }
+    });
+
+    return CodeActionProvider.createCodeActions(
+      textEdits,
+      info.getResourceString("quickFixMessage"),
+      documentContext.getUri(),
+      diagnostics
+    );
+
+  }
+
+  private String getAdaptedText(String text) {
+    return info.getResourceString("quickFixAdaptedText", text);
+  }
+
+  private int getBooleanToken(BSLParser.ExpressionContext expCtx) {
+
+    var tmpCtx = Optional.of(expCtx)
+      .filter(ctx -> ctx.children.size() == 1)
+      .map(ctx -> ctx.member(0))
+      .map(ctx -> ctx.getChild(0))
+      .filter(BSLParser.ConstValueContext.class::isInstance)
+      .map(BSLParser.ConstValueContext.class::cast);
+
+    return tmpCtx
+      .map(ctx -> ctx.getToken(BSLParser.TRUE, 0))
+      .map(ctx -> BSLParser.TRUE)
+      .or(() -> tmpCtx
+        .map(ctx -> ctx.getToken(BSLParser.FALSE, 0))
+        .map(ctx -> BSLParser.FALSE)
+      )
+      .orElse(SKIPPED_RULE_INDEX);
+  }
+}

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

@@ -2114,6 +2114,16 @@
             "title": "Use of system information",
             "$id": "#/definitions/UseSystemInformation"
         },
+        "UselessTernaryOperator": {
+            "description": "Useless ternary operator",
+            "default": true,
+            "type": [
+                "boolean",
+                "object"
+            ],
+            "title": "Useless ternary operator",
+            "$id": "#/definitions/UselessTernaryOperator"
+        },
         "UsingCancelParameter": {
             "description": "Using parameter \"Cancel\"",
             "default": true,

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/schema.json

@@ -491,6 +491,9 @@
                 "UseSystemInformation": {
                     "$ref": "parameters-schema.json#/definitions/UseSystemInformation"
                 },
+                "UselessTernaryOperator": {
+                    "$ref": "parameters-schema.json#/definitions/UselessTernaryOperator"
+                },
                 "UsingCancelParameter": {
                     "$ref": "parameters-schema.json#/definitions/UsingCancelParameter"
                 },

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/UselessTernaryOperatorDiagnostic_en.properties

@@ -0,0 +1,4 @@
+diagnosticMessage=Useless ternary operator
+diagnosticName=Useless ternary operator
+quickFixMessage=Fix some useless ternary operators
+quickFixAdaptedText=NOT (%s)

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/UselessTernaryOperatorDiagnostic_ru.properties

@@ -0,0 +1,4 @@
+diagnosticMessage=Бесполезный тернарный оператор
+diagnosticName=Бесполезный тернарный оператор
+quickFixMessage=Исправить некоторые бесполезные тернарные операторы
+quickFixAdaptedText=НЕ (%s)