nodeSolidServer / nodeSolidServer/node-solid-server

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

Ouverte
#1,452 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
1.8k
Forks
308
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par exécuter solid start --help et solid init, puis suivez les points d’entrée --config-path, --config-file et configFile afin d’établir leur comportement. Mettez à jour l’aide ou la documentation CLI pertinente afin que la relation entre le répertoire de configuration, le fichier de configuration et le ./config.json généré soit explicite, puis vérifiez le comportement documenté avec les deux commandes.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
cli, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.