nodeSolidServer / nodeSolidServer/node-solid-server

no documentation for solid start --config-path or --config-file

Aberta
#1,452 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
1.8k
Forks
308
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

The output of solid start --help doesn't show any help description for the following items:

--config-path [value]
--config-file [value]

What's more, the output of solid init doesn't make this very clear either:

? Path to the config directory (for example: /etc/solid-server) ./myconf
? Path to the config file (for example: ./config.json) foo.json

When I see these items, I ask the following questions:

  1. should the config file be stored in the config directory, or are these different things? I expected that the config file would be written as [config_dir]/[config_file], but it isn't. Is the config directory something for startup, or runtime configuration?
  2. if I specify foo.json as a config file, why does solid init still write it to ./config.json?
  3. I can specify a config file on the command line with solid start --config-file. If it reads this config file, what is the behaviour of the configFile option in this json file? Is it used at all (to reload a secondary config file?) or is it ignored?

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece executando solid start --help e solid init; em seguida, rastreie os pontos de entrada --config-path, --config-file e configFile para estabelecer seu comportamento. Atualize a ajuda ou a documentação de CLI relevante para deixar explícita a relação entre o diretório de configuração, o arquivo de configuração e o ./config.json gerado, e verifique o comportamento documentado com ambos os comandos.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript
Domínio
cli, documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.