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

Go to download
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2022
 * 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.DocumentContext;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticParameter;
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.languageserver.recognizer.BSLFootprint;
import com.github._1c_syntax.bsl.languageserver.recognizer.CodeRecognizer;
import com.github._1c_syntax.bsl.languageserver.utils.DiagnosticHelper;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
import org.antlr.v4.runtime.Token;
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.Map;
import java.util.regex.Pattern;

@DiagnosticMetadata(
  type = DiagnosticType.CODE_SMELL,
  severity = DiagnosticSeverity.INFO,
  minutesToFix = 1,
  tags = {
    DiagnosticTag.STANDARD
  }
)

public class SpaceAtStartCommentDiagnostic extends AbstractDiagnostic implements QuickFixProvider {

  private static final String DEFAULT_COMMENTS_ANNOTATION = "//@,//(c),//©";
  private static final Pattern GOOD_COMMENT_PATTERN = CaseInsensitivePattern.compile(
    "(?:(?:\\/{2,}[ \\t].*)|(?:\\/{2,}[ \\t]*))$"
  );

  private static final Pattern GOOD_COMMENT_PATTERN_STRICT = CaseInsensitivePattern.compile(
    "(?:(?:\\/\\/[ \\t].*)|(?:\\/{2,}[ \\t]*))$"
  );

  private static final boolean USE_STRICT_VALIDATION = true;

  private static final int COMMENT_LENGTH = 2;

  private static final float COMMENTED_CODE_THRESHOLD = 0.9F;
  private final CodeRecognizer codeRecognizer;

  @DiagnosticParameter(
    type = String.class,
    defaultValue = "" + DEFAULT_COMMENTS_ANNOTATION
  )
  private Pattern commentsAnnotation = DiagnosticHelper.createPatternFromString(DEFAULT_COMMENTS_ANNOTATION);

  @DiagnosticParameter(
    type = Boolean.class,
    defaultValue = "" + USE_STRICT_VALIDATION
  )
  private boolean useStrictValidation = USE_STRICT_VALIDATION;

  public SpaceAtStartCommentDiagnostic() {
    this.codeRecognizer = new CodeRecognizer(COMMENTED_CODE_THRESHOLD, new BSLFootprint());
  }

  @Override
  public void configure(Map configuration) {
    DiagnosticHelper.configureDiagnostic(this, configuration, "useStrictValidation");
    this.commentsAnnotation = DiagnosticHelper.createPatternFromString(
      (String) configuration.getOrDefault("commentsAnnotation", DEFAULT_COMMENTS_ANNOTATION));
  }

  @Override
  public void check() {
    documentContext.getComments()
      .parallelStream()
      .filter((Token t) ->
        !goodPattern().matcher(t.getText()).matches()
          && !commentsAnnotation.matcher(t.getText()).matches()
          && !codeRecognizer.meetsCondition(t.getText()))
      .sequential()
      .forEach(diagnosticStorage::addDiagnostic);
  }

  @Override
  public List getQuickFixes(
    List diagnostics,
    CodeActionParams params,
    DocumentContext documentContext
  ) {

    List textEdits = new ArrayList<>();

    diagnostics.forEach((Diagnostic diagnostic) -> {
      var range = diagnostic.getRange();
      String currentText = documentContext.getText(range);

      var textEdit = new TextEdit(
        range,
        currentText.substring(0, COMMENT_LENGTH) + " " + currentText.substring(COMMENT_LENGTH)
      );
      textEdits.add(textEdit);
    });

    return CodeActionProvider.createCodeActions(
      textEdits,
      info.getResourceString("quickFixMessage"),
      documentContext.getUri(),
      diagnostics
    );
  }

  private Pattern goodPattern() {
    if (useStrictValidation) {
      return GOOD_COMMENT_PATTERN_STRICT;
    } else {
      return GOOD_COMMENT_PATTERN;
    }
  }
}