com.github._1c_syntax.bsl.languageserver.diagnostics.OneStatementPerLineDiagnostic 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.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.utils.Ranges;
import com.github._1c_syntax.bsl.languageserver.utils.RelatedInformation;
import com.github._1c_syntax.bsl.parser.BSLParser;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
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.DiagnosticRelatedInformation;
import org.eclipse.lsp4j.Range;
import org.eclipse.lsp4j.TextEdit;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

@DiagnosticMetadata(
  type = DiagnosticType.CODE_SMELL,
  severity = DiagnosticSeverity.MINOR,
  minutesToFix = 2,
  tags = {
    DiagnosticTag.STANDARD,
    DiagnosticTag.DESIGN
  }
)
public class OneStatementPerLineDiagnostic extends AbstractVisitorDiagnostic implements QuickFixProvider {
  private static final Pattern NEW_LINE_PATTERN = CaseInsensitivePattern.compile(
    "^(\\s+?)[^\\s]"
  );
  private int previousLineNumber;
  private final List statementsPerLine = new ArrayList<>();

  private List getRelatedInformation(BSLParser.StatementContext self) {
    List relatedInformation = new ArrayList<>();
    statementsPerLine.stream()
      .filter(context -> !context.equals(self))
      .map(context -> RelatedInformation.create(
        documentContext.getUri(),
        Ranges.create(context),
        "+1"
      )).collect(Collectors.toCollection(() -> relatedInformation));
    return relatedInformation;
  }

  private void addDiagnostics() {
    if (!statementsPerLine.isEmpty()) {
      statementsPerLine.forEach(
        context -> diagnosticStorage.addDiagnostic(context,
          getRelatedInformation(context))
      );
      statementsPerLine.clear();
    }
  }

  @Override
  public ParseTree visitStatement(BSLParser.StatementContext ctx) {

    int currentLine = ctx.getStart().getLine();

    if (currentLine == previousLineNumber) {
      statementsPerLine.add(ctx);
    } else {
      addDiagnostics();
    }

    if (ctx.preprocessor() != null || ctx.exception != null
      || (ctx.getChildCount() == 1 && ctx.SEMICOLON() != null)) {
      statementsPerLine.clear();
      return super.visitStatement(ctx);
    }

    previousLineNumber = currentLine;

    return super.visitStatement(ctx);
  }

  @Override
  public ParseTree visitFile(BSLParser.FileContext ctx) {
    statementsPerLine.clear();
    super.visitFile(ctx);
    addDiagnostics();
    return ctx;
  }

  @Override
  public List getQuickFixes(
    List diagnostics,
    CodeActionParams params,
    DocumentContext documentContext
  ) {
    List textEdits = new ArrayList<>();

    diagnostics.forEach((Diagnostic diagnostic) -> {
      Range range = diagnostic.getRange();
      Range startLineRange = Ranges.create(
        range.getStart().getLine(),
        0,
        range.getStart().getLine(),
        range.getStart().getCharacter());

      Matcher matcher = NEW_LINE_PATTERN.matcher(documentContext.getText(startLineRange));
      String indent = "";
      if (matcher.find()) {
        indent = matcher.group(1);
      }

      TextEdit textEdit = new TextEdit(
        range, "\n" + indent + documentContext.getText(range)
      );
      textEdits.add(textEdit);
    });

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