• Home
• io.github.1c-syntax
• bsl-language-server
• 0.23.0-rc.1
• source code
• MissingParameterDescriptionDiagnostic.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github._1c_syntax.bsl.languageserver.diagnostics.MissingParameterDescriptionDiagnostic Maven / Gradle / Ivy

/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2023
 * Alexey Sosnoviy , Nikita Fedkin  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.symbol.MethodSymbol;
import com.github._1c_syntax.bsl.languageserver.context.symbol.ParameterDefinition;
import com.github._1c_syntax.bsl.languageserver.context.symbol.description.MethodDescription;
import com.github._1c_syntax.bsl.languageserver.context.symbol.description.ParameterDescription;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
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 org.apache.commons.collections4.map.CaseInsensitiveMap;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Function;
import java.util.stream.Collectors;

@DiagnosticMetadata(
  type = DiagnosticType.CODE_SMELL,
  severity = DiagnosticSeverity.MAJOR,
  minutesToFix = 5,
  tags = {
    DiagnosticTag.STANDARD,
    DiagnosticTag.BADPRACTICE
  }
)
public class MissingParameterDescriptionDiagnostic extends AbstractSymbolTreeDiagnostic {

  /**
   * Анализируется только методы, имеющие описание
   * Для удобства кидается несколько разных замечаний
   */
  @Override
  public void visitMethod(MethodSymbol methodSymbol) {

    var description = methodSymbol.getDescription();

    boolean hasDescription = description.isPresent();

    if (!hasDescription) {
      return;
    }

    List parameters = methodSymbol.getParameters();
    List parametersDescriptions = description
      .map(MethodDescription::getParameters)
      .orElse(Collections.emptyList());

    // параметров и описания нет, что в принципе не ошибка
    if (parameters.isEmpty() && parametersDescriptions.isEmpty()) {
      return;
    }

    // параметров нет, но есть их описания, что есть ошибка
    if (parameters.isEmpty()) {
      addDiagnostic(methodSymbol, parametersDescriptions);
      return;
    }

    if (parametersDescriptions.isEmpty()) {
      if (!description.get().getLink().isEmpty()) {
        // пока считаем ссылку наличием описания всего и вся
        return;
      }
      // ошибка отсутствует описание всех параметров
      diagnosticStorage.addDiagnostic(methodSymbol.getSubNameRange());
      return;
    }

    // сопоставление параметров и описаний
    checkParameterDescription(methodSymbol, parameters, parametersDescriptions);
  }

  private void checkParameterDescription(MethodSymbol methodSymbol,
                                         List parameters,
                                         List parametersDescriptions) {

    AtomicBoolean hasMissingDescription = new AtomicBoolean(false);

    var parametersDescriptionsCopy = new ArrayList<>(parametersDescriptions);
    var descriptions = parametersDescriptions.stream()
      .collect(
        Collectors.toMap(
          ParameterDescription::getName,
          Function.identity(),
          (first, second) -> first,
          CaseInsensitiveMap::new));

    parameters.forEach((ParameterDefinition parameter) -> {
      var description = descriptions.get(parameter.getName());
      // описание параметра отсутствует как таковое
      if (description == null) {
        addDiagnostic(parameter, "missingDescription");
        hasMissingDescription.set(true);
        return;
      }

      // параметр в описании есть, но нет типа и описания типа
      if (description.getTypes().isEmpty()) {
        addDiagnostic(parameter, "emptyDescription");
      }

      // найденный параметр удалим из кэша
      parametersDescriptionsCopy.remove(description);
    });

    // лишние описания параметров, отсутствующие в сигнатуре
    if (!parametersDescriptionsCopy.isEmpty()) {
      hasMissingDescription.set(true);
      addDiagnostic(methodSymbol, parametersDescriptionsCopy);
    }

    // проверить порядок параметров в описании
    // но это имеет смысл только при отсутствии ошибок

    if (!hasMissingDescription.get()) {
      var paramDescriptionString = parametersDescriptions.stream()
        .map(ParameterDescription::getName).collect(Collectors.joining(",")).toLowerCase(Locale.ENGLISH);
      var paramString = parameters.stream()
        .map(ParameterDefinition::getName).collect(Collectors.joining(",")).toLowerCase(Locale.ENGLISH);
      // если строки не равны, значит порядок описаний не совпадает
      if (!paramDescriptionString.equals(paramString)) {
        diagnosticStorage.addDiagnostic(methodSymbol.getSubNameRange(), info.getResourceString("wrongOrder"));
      }
    }
  }

  private void addDiagnostic(ParameterDefinition parameter, String messageKey) {
    diagnosticStorage.addDiagnostic(parameter.getRange(), info.getResourceString(messageKey, parameter.getName()));
  }

  private void addDiagnostic(MethodSymbol methodSymbol, List parametersDescriptions) {
    var parametersString = parametersDescriptions.stream()
      .map(ParameterDescription::getName).collect(Collectors.joining(", "));
    diagnosticStorage.addDiagnostic(
      methodSymbol.getSubNameRange(),
      info.getResourceString("missingInSignature", parametersString));
  }
}