com.github._1c_syntax.bsl.languageserver.cli.AnalyzeCommand 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.
/*
* 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.cli;
import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
import com.github._1c_syntax.bsl.languageserver.context.ServerContext;
import com.github._1c_syntax.bsl.languageserver.reporters.ReportersAggregator;
import com.github._1c_syntax.bsl.languageserver.reporters.data.AnalysisInfo;
import com.github._1c_syntax.bsl.languageserver.reporters.data.FileInfo;
import com.github._1c_syntax.bsl.mdo.MD;
import com.github._1c_syntax.bsl.types.MdoReference;
import com.github._1c_syntax.utils.Absolute;
import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import me.tongfei.progressbar.ProgressBar;
import me.tongfei.progressbar.ProgressBarBuilder;
import me.tongfei.progressbar.ProgressBarStyle;
import org.apache.commons.io.FileUtils;
import org.springframework.stereotype.Component;
import picocli.CommandLine.Command;
import java.io.File;
import java.nio.file.Path;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.stream.Collectors;
import static picocli.CommandLine.Option;
/**
* Выполнение анализа
* Ключ команды:
* -a, (--analyze)
* Параметры:
* -s, (--srcDir) <arg> - Путь к каталогу исходных файлов.
* Возможно указывать как в абсолютном, так и относительном виде. Если параметр опущен,
* то анализ выполняется в текущем каталоге запуска.
* -o, (--outputDir) <arg> - Путь к каталогу размещения отчетов - результатов анализа.
* Возможно указывать как в абсолютном, так и относительном виде. Если параметр опущен,
* то файлы отчета будут сохранены в текущем каталоге запуска.
* -w, (--workspaceDir) <arg> - Путь к каталогу проекта, относительно которого располагаются исходные файлы.
* Возможно указывать как в абсолютном, так и в относительном виде. Если параметр опущен,
* то пути к исходным файлам будут указываться относительно текущего каталога запуска.
* -c, (--configuration) <arg> - Путь к конфигурационному файлу BSL Language Server (.bsl-language-server.json).
* Возможно указывать как в абсолютном, так и относительном виде. Если параметр опущен,
* то будут использованы настройки по умолчанию.
* -r, (--reporter) <arg> - Ключи "Репортеров", т.е. форматов отчетов, котрые необходимо сгенерировать после
* выполнения анализа. Может быть указано более одного ключа. Если параметр опущен,
* то вывод результата будет призведен в консоль.
* -q, (--silent) - Флаг для отключения вывода прогресс-бара и дополнительных сообщений в консоль
* Выводимая информация:
* Выполняет анализ каталога исходных файлов и генерацию файлов отчета. Для каждого указанного ключа "Репортера"
* создается отдельный файл (каталог файлов). Реализованные "репортеры" находятся в пакете "reporter".
**/
@Slf4j
@Command(
name = "analyze",
aliases = {"-a", "--analyze"},
description = "Run analysis and get diagnostic info",
usageHelpAutoWidth = true,
footer = "@|green Copyright(c) 2018-2022|@")
@Component
@RequiredArgsConstructor
public class AnalyzeCommand implements Callable {
private static class ReportersKeys extends ArrayList {
ReportersKeys(ReportersAggregator aggregator) {
super(aggregator.reporterKeys());
}
}
@Option(
names = {"-h", "--help"},
usageHelp = true,
description = "Show this help message and exit")
private boolean usageHelpRequested;
@Option(
names = {"-w", "--workspaceDir"},
description = "Workspace directory",
paramLabel = "",
defaultValue = "")
private String workspaceDirOption;
@Option(
names = {"-s", "--srcDir"},
description = "Source directory",
paramLabel = "",
defaultValue = "")
private String srcDirOption;
@Option(
names = {"-o", "--outputDir"},
description = "Output report directory",
paramLabel = "",
defaultValue = "")
private String outputDirOption;
@Option(
names = {"-c", "--configuration"},
description = "Path to language server configuration file",
paramLabel = "",
defaultValue = "")
private String configurationOption;
@Option(
names = {"-r", "--reporter"},
paramLabel = "",
completionCandidates = ReportersKeys.class,
description = "Reporter key (${COMPLETION-CANDIDATES})")
private String[] reportersOptions = {};
@Option(
names = {"-q", "--silent"},
description = "Silent mode")
private boolean silentMode;
private final ReportersAggregator aggregator;
private final LanguageServerConfiguration configuration;
private final ServerContext context;
public Integer call() {
var workspaceDir = Absolute.path(workspaceDirOption);
if (!workspaceDir.toFile().exists()) {
LOGGER.error("Workspace dir `{}` is not exists", workspaceDir);
return 1;
}
var srcDir = Absolute.path(srcDirOption);
if (!srcDir.toFile().exists()) {
LOGGER.error("Source dir `{}` is not exists", srcDir);
return 1;
}
var configurationFile = new File(configurationOption);
if (configurationFile.exists()) {
configuration.update(configurationFile);
}
var configurationPath = LanguageServerConfiguration.getCustomConfigurationRoot(configuration, srcDir);
context.setConfigurationRoot(configurationPath);
var files = (List) FileUtils.listFiles(srcDir.toFile(), new String[]{"bsl", "os"}, true);
context.populateContext(files);
List fileInfos;
if (silentMode) {
fileInfos = files.parallelStream()
.map((File file) -> getFileInfoFromFile(workspaceDir, file))
.collect(Collectors.toList());
} else {
try (ProgressBar pb = new ProgressBarBuilder()
.setTaskName("Analyzing files...")
.setInitialMax(files.size())
.setStyle(ProgressBarStyle.ASCII)
.build()) {
fileInfos = files.parallelStream()
.map((File file) -> {
pb.step();
return getFileInfoFromFile(workspaceDir, file);
})
.collect(Collectors.toList());
}
}
var analysisInfo = new AnalysisInfo(LocalDateTime.now(), fileInfos, srcDir.toString());
var outputDir = Absolute.path(outputDirOption);
aggregator.report(analysisInfo, outputDir);
return 0;
}
public String[] getReportersOptions() {
return reportersOptions.clone();
}
@SneakyThrows
private FileInfo getFileInfoFromFile(Path srcDir, File file) {
var documentContext = context.addDocument(file.toURI());
context.rebuildDocument(documentContext);
var filePath = srcDir.relativize(Absolute.path(file));
var diagnostics = documentContext.getDiagnostics();
var metrics = documentContext.getMetrics();
var mdoRef = documentContext.getMdObject()
.map(MD::getMdoReference)
.map(MdoReference::getMdoRef)
.orElse("");
var fileInfo = new FileInfo(filePath, mdoRef, diagnostics, metrics);
// clean up AST after diagnostic computing to free up RAM.
context.tryClearDocument(documentContext);
return fileInfo;
}
}