com.github._1c_syntax.bsl.languageserver.diagnostics.PublicMethodsDescriptionDiagnostic Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation
Show all versions of bsl-language-server Show documentation
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
The newest version!
/*
* This file is a part of BSL Language Server.
*
* Copyright (c) 2018-2024
* 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.Symbol;
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.parser.BSLParser;
import com.github._1c_syntax.utils.CaseInsensitivePattern;
import org.antlr.v4.runtime.tree.ParseTree;
import org.eclipse.lsp4j.SymbolKind;
import java.util.regex.Pattern;
@DiagnosticMetadata(
type = DiagnosticType.CODE_SMELL,
severity = DiagnosticSeverity.INFO,
minutesToFix = 1,
tags = {
DiagnosticTag.STANDARD,
DiagnosticTag.BRAINOVERLOAD,
DiagnosticTag.BADPRACTICE
}
)
public class PublicMethodsDescriptionDiagnostic extends AbstractVisitorDiagnostic {
private static final Pattern API_REGION_NAME = CaseInsensitivePattern.compile(
"^(?:ПрограммныйИнтерфейс|Public)$"
);
private static final boolean DEFAULT_CHECK_ALL_REGION = false;
@DiagnosticParameter(
type = Boolean.class,
defaultValue = "" + DEFAULT_CHECK_ALL_REGION
)
private boolean checkAllRegion = DEFAULT_CHECK_ALL_REGION;
@Override
public ParseTree visitSub(BSLParser.SubContext ctx) {
documentContext.getSymbolTree().getMethodSymbol(ctx).ifPresent((MethodSymbol methodSymbol) -> {
if (methodSymbol.isExport() && methodSymbol.getDescription().isEmpty()) {
if (checkAllRegion) {
diagnosticStorage.addDiagnostic(methodSymbol.getSubNameRange());
} else {
methodSymbol.getRootParent(SymbolKind.Namespace).ifPresent((Symbol rootRegion) -> {
if (isAPIRegion(rootRegion)) {
diagnosticStorage.addDiagnostic(methodSymbol.getSubNameRange());
}
});
}
}
});
return ctx;
}
private static boolean isAPIRegion(Symbol symbol) {
return API_REGION_NAME.matcher(symbol.getName()).matches();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy