Read config from JS file

Open
  • Is something wrong?
#234 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, typescript
Domain
cli

Research direction

The issue describes config loading but names no files or tests. Start by locating where the CLI reads JSON config files and how it validates or uses the resulting config. Done means a JavaScript config file like the example can provide the same settings as JSON; the issue does not specify which file formats or loading behavior should be supported beyond that example.

Written by the indexing model from the issue text.

Description

Actually user-flow reads config from JSON config files only, which can be limiting if I want to have clever config, for example:

module.exports = {
  collect: {
    url: process.env.BASE_URL ?? 'https://fallback-url/' ,
    ufPath: "./user-flows"
  }
};
Dominant language
HTML
Stars
131
Forks
7
Avg merge
7h 58m
Merged PRs (30d)
42

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from push-based/user-flow

All issues in push-based/user-flow

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.