nodeSolidServer / nodeSolidServer/node-solid-server

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

Open
#1,452 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.8k
Forks
308
PR merge metrics
No merged PRs in 30d

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running solid start --help and solid init, then trace the --config-path, --config-file, and configFile entry points to establish their behavior. Update the relevant CLI help or documentation so the relationship between the config directory, config file, and generated ./config.json is explicit, and verify the documented behavior against both commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.