com.github._1c_syntax.bsl.languageserver.cli.WebsocketCommand 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
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.cli;

import com.github._1c_syntax.bsl.languageserver.configuration.LanguageServerConfiguration;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;

import java.io.File;
import java.util.concurrent.Callable;

import static picocli.CommandLine.Command;
import static picocli.CommandLine.Option;

/**
 * Запускает приложение в режиме Websocket Language Server.
 * Ключ команды:
 *  -w, (--websocket)
 * Параметры:
 *  -c, (--configuration) <arg> - Путь к конфигурационному файлу BSL Language Server (.bsl-language-server.json).
 *                                      Возможно указывать как в абсолютном, так и относительном виде.
 *                                      Если параметр опущен, то будут использованы настройки по умолчанию.
 *  --server.port                     - Порт, на котором открывается соединение. Если параметр опущен,
 *                                      то будет использован порт по умолчанию, а именно 8025.
 *  --app.websocket.lsp-path          - Адрес, по которому открывается соединение. Если параметр опущен,
 *                                      то будет использован адрес по умолчанию, а именно /lsp.
 * Выводимая информация:
 *  Данный режим используется для взаимодействия с клиентом по протоколу LSP через websocket.
 *
 */
@Command(
  name = "websocket",
  aliases = {"-w", "--websocket"},
  description = "Websocket server mode",
  usageHelpAutoWidth = true,
  footer = "@|green Copyright(c) 2018-2022|@")
@Component
@RequiredArgsConstructor
public class WebsocketCommand implements Callable {
  @Option(
    names = {"-h", "--help"},
    usageHelp = true,
    description = "Show this help message and exit")
  private boolean usageHelpRequested;

  @Option(
    names = {"-c", "--configuration"},
    description = "Path to language server configuration file",
    paramLabel = "",
    defaultValue = "")
  private String configurationOption;

  @Option(
    names = {"--server.port"},
    description = "Port to listen. Default is 8025",
    paramLabel = "",
    defaultValue = "8025")
  private int serverPort;

  @Option(
    names = {"--app.websocket.lsp-path"},
    description = "Path to LSP endpoint. Default is /lsp",
    paramLabel = "",
    defaultValue = "/lsp")
  private String endpointPath;

  private final LanguageServerConfiguration configuration;

  public Integer call() {
    var configurationFile = new File(configurationOption);
    if (configurationFile.exists()) {
      configuration.update(configurationFile);
    }

    return -1;
  }

}