Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

README config example breaks when copied into ~/.nodeenvrc

Open Beginner friendly
  • Is something wrong?
#422 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Open the Configuration section of README.rst and compare it with the output of nodeenv --dump-config-defaults. Check how Config._load handles the documented values, then update the example so copied options match the command output and mirror is omitted or commented out. Done means the README example no longer introduces quoted values or an unusable mirror setting.

Written by the indexing model from the issue text.

Description

docs

The Configuration section of README.rst lists the options with Python-style values:

[nodeenv]
node = 'latest'
npm = 'latest'
with_npm = False
jobs = '2'
...
make = 'make'
...
mirror = None

Config._load reads the file with ConfigParser.get, which returns the raw string, so the quotes become part of the value. Copied into ~/.nodeenvrc, five of the fifteen lines change the option:

Line in README Value nodeenv gets
node = 'latest' "'latest'"
npm = 'latest' "'latest'"
jobs = '2' "'2'"
make = 'make' "'make'"
mirror = None 'None'

The boolean lines are fine, because getboolean accepts True and False.

Reproduce

On master (e745358):

$ printf "[nodeenv]\nnode = 'latest'\n" > quoted.ini
$ nodeenv -C quoted.ini env
...
ValueError: invalid literal for int() with base 10: "'latest'"

$ printf "[nodeenv]\nmirror = None\n" > mirror.ini
$ nodeenv -C mirror.ini --node=22.11.0 env
 * Install prebuilt node (22.11.0) .Error: cannot download https://None/download/release/v22.11.0/node-v22.11.0-darwin-arm64.tar.gz: [Errno 8] nodename nor servname provided, or not known
Where it comes from

The block was added in ac9a510 ("Add ability to configure mirror through setting file"). nodeenv --dump-config-defaults, whose docstring says it prints the defaults for the README, now prints the values without quotes, but it still prints mirror = None.

Possible fix

Regenerate the block from --dump-config-defaults, and leave mirror out of it or show it commented out, since it has no default.

Dominant language
Python
Stars
1.8k
Forks
224
Avg merge
10h 15m
Merged PRs (30d)
22

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 ekalinin/nodeenv

All issues in ekalinin/nodeenv

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.