sourcejs/Source

Add Ability to pass SourceJS CLI options via object

Open

#243 opened on Dec 20, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (552 stars) (49 forks)batch import
good first contributionhelp wantedimprovement

Description

#241 added the ability to use NodeJS's require to load SourceJS as part of a NodeJS script.

This issue will need to add the ability to pass in the SourceJS CLI options via plain object to the startServer method.

It should follow the same inheritance/override pattern as the current CLI ability.

  1. Load Options via Options file
  2. Load Options via CLI
  3. Load Options via Options object
  4. Override using process.env

Contributor guide

Tech stack
javascript
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js requireSourceJS CLI options
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the option loading mechanism added in PR #241 (https://github.com/sourcejs/Source/pull/241). Look at the startServer function in the source code to understand how CLI options are currently loaded. Implement a new parameter that accepts an options object, merging it with file and CLI options according to the described order.