nodeSolidServer / nodeSolidServer/node-solid-server

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

Aperta
#1,452 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
1.8k
Fork
308
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo solid start --help e solid init, quindi segui i punti di ingresso --config-path, --config-file e configFile per stabilirne il comportamento. Aggiorna la guida o la documentazione CLI pertinente in modo che sia esplicita la relazione tra la directory di configurazione, il file di configurazione e il ./config.json generato, quindi verifica il comportamento documentato con entrambi i comandi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
cli, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.