nodeSolidServer / nodeSolidServer/node-solid-server
no documentation for solid start --config-path or --config-file
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 1.8k
- Forks
- 308
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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:
- 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? - if I specify foo.json as a config file, why does solid init still write it to
./config.json? - 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 theconfigFileoption in this json file? Is it used at all (to reload a secondary config file?) or is it ignored?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit solid start --help und solid init, und verfolge anschließend die Einstiegspunkte --config-path, --config-file und configFile, um deren Verhalten zu ermitteln. Aktualisiere die relevante CLI-Hilfe oder Dokumentation so, dass der Zusammenhang zwischen dem Konfigurationsverzeichnis, der Konfigurationsdatei und der generierten ./config.json eindeutig ist, und überprüfe das dokumentierte Verhalten anhand beider Befehle.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100