nodeenv 1.9.0__tar.gz → 1.10.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. nodeenv-1.10.0/.github/release.yml +22 -0
  2. {nodeenv-1.9.0 → nodeenv-1.10.0}/.github/workflows/main.yml +21 -20
  3. nodeenv-1.10.0/.github/workflows/tests.yml +67 -0
  4. {nodeenv-1.9.0 → nodeenv-1.10.0}/AUTHORS +19 -12
  5. {nodeenv-1.9.0 → nodeenv-1.10.0}/Makefile +16 -7
  6. {nodeenv-1.9.0 → nodeenv-1.10.0}/PKG-INFO +121 -12
  7. {nodeenv-1.9.0 → nodeenv-1.10.0}/README +109 -10
  8. {nodeenv-1.9.0 → nodeenv-1.10.0}/README.rst +109 -10
  9. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/PKG-INFO +121 -12
  10. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/SOURCES.txt +2 -0
  11. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.py +43 -21
  12. {nodeenv-1.9.0 → nodeenv-1.10.0}/requirements-dev.txt +3 -0
  13. nodeenv-1.10.0/tests/nodeenv_test.py +1080 -0
  14. {nodeenv-1.9.0 → nodeenv-1.10.0}/tests/nodejs_index.json +2 -2
  15. nodeenv-1.10.0/tests/test_install_activate.py +298 -0
  16. {nodeenv-1.9.0 → nodeenv-1.10.0}/tox.ini +1 -1
  17. nodeenv-1.9.0/tests/nodeenv_test.py +0 -163
  18. nodeenv-1.9.0/tests/test_install_activate.py +0 -87
  19. {nodeenv-1.9.0 → nodeenv-1.10.0}/.coveragerc +0 -0
  20. {nodeenv-1.9.0 → nodeenv-1.10.0}/.gitignore +0 -0
  21. {nodeenv-1.9.0 → nodeenv-1.10.0}/CHANGES +0 -0
  22. {nodeenv-1.9.0 → nodeenv-1.10.0}/LICENSE +0 -0
  23. {nodeenv-1.9.0 → nodeenv-1.10.0}/MANIFEST.in +0 -0
  24. {nodeenv-1.9.0 → nodeenv-1.10.0}/README.ru.rst +0 -0
  25. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/changelog +0 -0
  26. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/compat +0 -0
  27. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/control +0 -0
  28. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/copyright +0 -0
  29. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/nodeenv.links +0 -0
  30. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/nodeenv.triggers +0 -0
  31. {nodeenv-1.9.0 → nodeenv-1.10.0}/debian-upstream/rules +0 -0
  32. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/dependency_links.txt +0 -0
  33. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/entry_points.txt +0 -0
  34. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/not-zip-safe +0 -0
  35. {nodeenv-1.9.0 → nodeenv-1.10.0}/nodeenv.egg-info/top_level.txt +0 -0
  36. {nodeenv-1.9.0 → nodeenv-1.10.0}/pyproject.toml +0 -0
  37. {nodeenv-1.9.0 → nodeenv-1.10.0}/setup.cfg +0 -0
  38. {nodeenv-1.9.0 → nodeenv-1.10.0}/setup.py +0 -0
  39. {nodeenv-1.9.0 → nodeenv-1.10.0}/tests/__init__.py +0 -0
@@ -0,0 +1,22 @@
1
+ # https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
2
+
3
+ changelog:
4
+ categories:
5
+ - title: New Features 🎉
6
+ labels:
7
+ - new-feature
8
+ - title: Fixed bugs 🐛
9
+ labels:
10
+ - bug
11
+ - title: Improvements 🛠
12
+ labels:
13
+ - enhancement
14
+ - title: Dependencies 🤖
15
+ labels:
16
+ - deps
17
+ - title: Documentation 📄
18
+ labels:
19
+ - docs
20
+ - title: Other Changes
21
+ labels:
22
+ - "*"
@@ -10,23 +10,22 @@ on:
10
10
  jobs:
11
11
  tests:
12
12
  name: Python ${{ matrix.python-version }}
13
- runs-on: ubuntu-20.04
13
+ runs-on: ubuntu-latest
14
14
 
15
15
  strategy:
16
16
  fail-fast: false
17
17
  matrix:
18
18
  python-version:
19
- - '3.7'
20
- - '3.8'
21
- - '3.9'
22
19
  - '3.10'
23
20
  - '3.11'
24
21
  - '3.12'
22
+ - '3.13'
23
+ - '3.14'
25
24
 
26
25
  steps:
27
- - uses: actions/checkout@v3
26
+ - uses: actions/checkout@v5
28
27
 
29
- - uses: actions/setup-python@v4
28
+ - uses: actions/setup-python@v6
30
29
  with:
31
30
  python-version: ${{ matrix.python-version }}
32
31
 
@@ -39,33 +38,36 @@ jobs:
39
38
 
40
39
  - name: Run tox targets for ${{ matrix.python-version }}
41
40
  run: |
42
- ENV_PREFIX=$(tr -C -d "0-9" <<< "${{ matrix.python-version }}")
43
- TOXENV=$(tox --listenvs | grep "^py$ENV_PREFIX" | tr '\n' ',') tox
41
+ ENV_SUFFIX=$(echo "${{ matrix.python-version }}" | tr -d '.')
42
+ tox -e py${ENV_SUFFIX}
44
43
 
45
44
  - name: Upload coverage data
46
- uses: actions/upload-artifact@v3
45
+ if: always()
46
+ uses: actions/upload-artifact@v6
47
47
  with:
48
- name: coverage-data
49
- path: '.coverage.*'
48
+ name: coverage-data-${{ matrix.python-version }}
49
+ path: .coverage.*
50
+ include-hidden-files: true
50
51
 
51
52
  coverage:
52
53
  name: Coverage
53
- runs-on: ubuntu-20.04
54
+ runs-on: ubuntu-latest
54
55
  needs: tests
55
56
  steps:
56
- - uses: actions/checkout@v3
57
+ - uses: actions/checkout@v5
57
58
 
58
- - uses: actions/setup-python@v4
59
+ - uses: actions/setup-python@v6
59
60
  with:
60
- python-version: '3.10'
61
+ python-version: '3.14'
61
62
 
62
63
  - name: Install dependencies
63
64
  run: python -m pip install --upgrade coverage[toml]
64
65
 
65
66
  - name: Download data
66
- uses: actions/download-artifact@v3
67
+ uses: actions/download-artifact@v7
67
68
  with:
68
- name: coverage-data
69
+ pattern: coverage-data-*
70
+ merge-multiple: true
69
71
 
70
72
  - name: Combine coverage and fail if it's <100%
71
73
  run: |
@@ -74,8 +76,7 @@ jobs:
74
76
  python -m coverage report --fail-under=55
75
77
 
76
78
  - name: Upload HTML report
77
- if: ${{ failure() }}
78
- uses: actions/upload-artifact@v3
79
+ uses: actions/upload-artifact@v6
79
80
  with:
80
81
  name: html-report
81
- path: htmlcov
82
+ path: coverage-html
@@ -0,0 +1,67 @@
1
+ name: Tests
2
+
3
+ on:
4
+ pull_request:
5
+ branches:
6
+ - master
7
+ - main
8
+ push:
9
+
10
+ jobs:
11
+ test:
12
+ runs-on: ${{ matrix.os }}
13
+ strategy:
14
+ fail-fast: false
15
+ matrix:
16
+ os: [ubuntu-latest, macos-latest, windows-latest]
17
+ python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
18
+
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+
22
+ - name: Set up Python ${{ matrix.python-version }}
23
+ uses: actions/setup-python@v5
24
+ with:
25
+ python-version: ${{ matrix.python-version }}
26
+
27
+ - name: Install dependencies
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ pip install -r requirements-dev.txt
31
+
32
+ - name: Run tests with tox
33
+ run: |
34
+ tox -e py$(echo ${{ matrix.python-version }} | tr -d '.')
35
+
36
+ - name: Run flake8
37
+ run: |
38
+ flake8 --extend-ignore=E127 nodeenv.py tests setup.py
39
+
40
+ coverage:
41
+ runs-on: ubuntu-latest
42
+ steps:
43
+ - uses: actions/checkout@v4
44
+
45
+ - name: Set up Python 3.14
46
+ uses: actions/setup-python@v5
47
+ with:
48
+ python-version: '3.14'
49
+
50
+ - name: Install dependencies
51
+ run: |
52
+ python -m pip install --upgrade pip
53
+ pip install -r requirements-dev.txt
54
+
55
+ - name: Run tests with coverage
56
+ run: |
57
+ coverage run -p -m pytest
58
+ coverage report -m
59
+ coverage html
60
+
61
+ - name: Upload coverage report
62
+ uses: actions/upload-artifact@v4
63
+ if: always()
64
+ with:
65
+ name: coverage-report
66
+ path: coverage-html/
67
+
@@ -17,9 +17,9 @@ Patches and Suggestions
17
17
  - Eashwar Ranganathan
18
18
  - Doug Turnbull
19
19
  - Anton Parkhomenko
20
- - syndbg
21
20
  - Vyacheslav Levit
22
21
  - Travis Miller
22
+ - syndbg
23
23
  - Spencer Rathbun
24
24
  - Robert Schwebel
25
25
  - Luis Orduz
@@ -39,23 +39,15 @@ Patches and Suggestions
39
39
  - Alex Couper
40
40
  - 0Xellos
41
41
  - zjeuhpiung liu
42
- - zbw
43
- - urbandove
44
- - sam
45
- - rely10
46
- - rachmadaniHaryono
47
- - proItheus
48
- - michael
49
- - jiho
50
- - dkgitdev
51
- - dhilipsiva
52
- - cmehay
53
42
  - Zenobius Jiricek
43
+ - zbw
54
44
  - Yi-Feng Tzeng
55
45
  - Willem Jan Withagen
56
46
  - Walter dos Santos Filho
57
47
  - Vladimír Gorej
48
+ - Vizonex
58
49
  - Vincent Bernat
50
+ - urbandove
59
51
  - Uman Shahzad
60
52
  - Tomi Belan
61
53
  - Tom Whitwell
@@ -66,12 +58,20 @@ Patches and Suggestions
66
58
  - Stan Seibert
67
59
  - Shubhang Mani
68
60
  - Sam James
61
+ - sam
62
+ - Rob Moss
69
63
  - Rik
64
+ - rely10
65
+ - rachmadaniHaryono
66
+ - proItheus
70
67
  - Philipp Dieter
71
68
  - Philipp A
72
69
  - Mrinal Wadhwa
73
70
  - Michal Kolodziejski
71
+ - Michał Górny
72
+ - michael
74
73
  - Maxim Mazurok
74
+ - max0x53
75
75
  - Max R
76
76
  - Max Melamed
77
77
  - Max Liebkies
@@ -83,17 +83,24 @@ Patches and Suggestions
83
83
  - Josh Soref
84
84
  - Johnny Lim
85
85
  - Joby Harding
86
+ - jiho
86
87
  - Jesse Dhillon
87
88
  - Jeremy Banks
88
89
  - Jelle van der Waa
90
+ - Hugo van Kemenade
91
+ - Hugo
92
+ - Han Yeong-woo
89
93
  - Geoffrey Huntley
90
94
  - Fabricio C Zuardi
91
95
  - Eashwar Ranganathan
92
96
  - Duncan Bellamy
97
+ - dkgitdev
98
+ - dhilipsiva
93
99
  - Dennis Flanigan
94
100
  - Dan North
95
101
  - Dan Fuchs
96
102
  - Damien Nozay
103
+ - cmehay
97
104
  - Brian Jacobel
98
105
  - Ben Davis
99
106
  - Ben Beasley
@@ -1,7 +1,8 @@
1
1
  .PHONY: default deploy deploy-github deploy-pypi update-pypi clean tests env
2
+ PYTHON=python3
2
3
  TEST_ENV=env
3
4
  DEV_TEST_ENV=env-dev
4
- SETUP=pip install -U pip setuptools && python setup.py install > /dev/null
5
+ SETUP=pip install -U pip setuptools && $(PYTHON) setup.py install > /dev/null
5
6
 
6
7
  default:
7
8
  : do nothing when dpkg-buildpackage runs this project Makefile
@@ -12,11 +13,13 @@ deploy-github:
12
13
 
13
14
  deploy-pypi:
14
15
  rm -rf dist
15
- python setup.py sdist bdist_wheel
16
- twine upload --repository pypi dist/*
16
+ @. ${DEV_TEST_ENV}/bin/activate && \
17
+ pip install -U setuptools wheel twine && \
18
+ $(PYTHON) setup.py sdist bdist_wheel && \
19
+ twine upload --repository pypi dist/*
17
20
 
18
21
  update-pypi:
19
- python setup.py register
22
+ $(PYTHON) setup.py register
20
23
 
21
24
  deploy: contributors deploy-github deploy-pypi
22
25
 
@@ -37,13 +40,13 @@ setup-test-env:
37
40
 
38
41
  env: clean-test-env setup-test-env
39
42
  @. ${TEST_ENV}/bin/activate && \
40
- python setup.py install
43
+ $(PYTHON) setup.py install
41
44
 
42
45
  # https://virtualenv.pypa.io/en/legacy/reference.html#cmdoption-no-site-packages
43
46
  # https://github.com/pypa/virtualenv/issues/1681
44
47
  env-dev:
45
48
  @rm -rf ${DEV_TEST_ENV} && \
46
- virtualenv ${DEV_TEST_ENV} && \
49
+ $(PYTHON) -m venv ${DEV_TEST_ENV} && \
47
50
  . ${DEV_TEST_ENV}/bin/activate && \
48
51
  pip install -r requirements-dev.txt
49
52
 
@@ -135,7 +138,13 @@ test10: clean clean-test-env setup-test-env
135
138
  tests: test1 test2 test3 test4 test7 test8 test9 test10 clean
136
139
 
137
140
  ut: env-dev
138
- @. ${DEV_TEST_ENV}/bin/activate && tox -e py39
141
+ @. ${DEV_TEST_ENV}/bin/activate && tox -e py314
142
+
143
+ coverage: env-dev
144
+ @. ${DEV_TEST_ENV}/bin/activate && \
145
+ coverage run -p -m pytest && \
146
+ coverage report -m && \
147
+ coverage html
139
148
 
140
149
  contributors:
141
150
  @echo "Nodeenv is written and maintained by Eugene Kalinin." > AUTHORS
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: nodeenv
3
- Version: 1.9.0
3
+ Version: 1.10.0
4
4
  Summary: Node.js virtual environment builder
5
5
  Home-page: https://github.com/ekalinin/nodeenv
6
6
  Author: Eugene Kalinin
@@ -24,14 +24,24 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
24
24
  Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*
25
25
  License-File: LICENSE
26
26
  License-File: AUTHORS
27
+ Dynamic: author
28
+ Dynamic: author-email
29
+ Dynamic: classifier
30
+ Dynamic: description
31
+ Dynamic: home-page
32
+ Dynamic: license
33
+ Dynamic: license-file
34
+ Dynamic: platform
35
+ Dynamic: requires-python
36
+ Dynamic: summary
27
37
 
28
38
  Node.js virtual environment
29
39
  ===========================
30
40
 
31
- ``nodeenv`` (node.js virtual environment) is a tool to create
41
+ ``nodeenv`` (node.js virtual environment) is a tool to create
32
42
  isolated node.js environments.
33
43
 
34
- It creates an environment that has its own installation directories,
44
+ It creates an environment that has its own installation directories,
35
45
  that doesn't share libraries with other node.js virtual environments.
36
46
 
37
47
  Also the new environment can be integrated with the environment which was built
@@ -41,8 +51,9 @@ If you use nodeenv feel free to add your project on wiki: `Who-Uses-Nodeenv`_.
41
51
 
42
52
  .. _Who-Uses-Nodeenv: https://github.com/ekalinin/nodeenv/wiki/Who-Uses-Nodeenv
43
53
 
44
- .. image:: https://travis-ci.org/ekalinin/nodeenv.svg?branch=master
45
- :target: https://travis-ci.org/ekalinin/nodeenv
54
+ .. image:: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml/badge.svg?branch=master
55
+ :target: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml
56
+ :alt: CI
46
57
 
47
58
  .. contents:: :local:
48
59
 
@@ -81,7 +92,7 @@ pip_/easy_install_ inside any virtual environment built with virtualenv::
81
92
  (env) $ nodeenv --version
82
93
  0.6.5
83
94
 
84
- If you want to work with the latest version of the nodeenv you can
95
+ If you want to work with the latest version of the nodeenv you can
85
96
  install it from the github `repository`_::
86
97
 
87
98
  $ git clone https://github.com/ekalinin/nodeenv.git
@@ -154,7 +165,7 @@ Get available node.js versions::
154
165
  0.3.2 0.3.3 0.3.4 0.3.5 0.3.6 0.3.7 0.3.8
155
166
  0.4.1 0.4.2 0.4.3 0.4.4 0.4.5 0.4.6
156
167
 
157
- Install node.js "0.4.3" without ssl support with 4 parallel commands
168
+ Install node.js "0.4.3" without ssl support with 4 parallel commands
158
169
  for compilation and npm.js "0.3.17"::
159
170
 
160
171
  $ nodeenv --without-ssl --node=0.4.3 --npm=0.3.17 --with-npm --jobs=4 env-4.3
@@ -203,7 +214,7 @@ Create an environment from a requirements file::
203
214
 
204
215
  $ nodeenv --requirements=../prod-requirements.txt --jobs=4 env-copy
205
216
 
206
- Requirements files are plain text files that contain a list of packages
217
+ Requirements files are plain text files that contain a list of packages
207
218
  to be installed. These text files allow you to create repeatable installations.
208
219
  Requirements file example::
209
220
 
@@ -228,7 +239,7 @@ virtual environment::
228
239
  and add a node virtual environment to this existing new_venv::
229
240
 
230
241
  $ nodeenv -p
231
-
242
+
232
243
  If you need to set the path to make used to build node::
233
244
 
234
245
  $ nodeenv -m /usr/local/bin/gmake ENV
@@ -240,7 +251,7 @@ environment::
240
251
  $ npm install -g coffee-script
241
252
  $ command -v coffee
242
253
  /home/monty/virtualenvs/my_env/bin/coffee
243
-
254
+
244
255
  Creating a virtual environment with a custom prompt:
245
256
 
246
257
  $ nodeenv --node=12.18.2 --prompt="(myenv)" nodeenv
@@ -261,6 +272,104 @@ use `shim` script::
261
272
  $ ./env-4.3/bin/shim --version
262
273
  v0.4.3
263
274
 
275
+ Command Line Options
276
+ --------------------
277
+
278
+ Basic options
279
+ ^^^^^^^^^^^^^
280
+
281
+ ``-n NODE_VER, --node=NODE_VER``
282
+ The node.js version to use, e.g., ``--node=22.11.0``. The default is the
283
+ last stable version (``latest``). Use ``lts`` for the latest LTS release.
284
+ Use ``system`` to use system-wide node.
285
+
286
+ ``-l, --list``
287
+ Lists available node.js versions.
288
+
289
+ ``-p, --python-virtualenv``
290
+ Use current python virtualenv.
291
+
292
+ ``-r FILENAME, --requirements=FILENAME``
293
+ Install all the packages listed in the given requirements file.
294
+
295
+ ``--prompt=PROMPT``
296
+ Provides an alternative prompt prefix for this environment.
297
+
298
+ ``--force``
299
+ Force installation in a pre-existing directory.
300
+
301
+ ``--update``
302
+ Install npm packages from file without reinstalling node.
303
+
304
+ Installation options
305
+ ^^^^^^^^^^^^^^^^^^^^
306
+
307
+ ``--prebuilt``
308
+ Install node.js from prebuilt package (default).
309
+
310
+ ``--source``
311
+ Install node.js from the source (Unix only).
312
+
313
+ ``--mirror=URL``
314
+ Set mirror server of nodejs.org to download from.
315
+
316
+ ``-c, --clean-src``
317
+ Remove "src" directory after installation.
318
+
319
+ NPM options
320
+ ^^^^^^^^^^^
321
+
322
+ ``--npm=NPM_VER``
323
+ The npm version to use, e.g., ``--npm=10.0.0``.
324
+ The default is the last available version (``latest``).
325
+
326
+ ``--with-npm``
327
+ Install npm into the new virtual environment. Required for node.js < 0.6.3.
328
+ By default, the npm included with node.js is used.
329
+
330
+ ``--no-npm-clean``
331
+ Skip the npm 0.x cleanup. Cleanup is enabled by default.
332
+
333
+ Compilation options (Unix only)
334
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
335
+
336
+ ``-j JOBS, --jobs=JOBS``
337
+ Sets number of parallel commands at node.js compilation. The default is 2 jobs.
338
+
339
+ ``--load-average=LOAD``
340
+ Sets maximum load average for executing parallel commands at node.js compilation.
341
+
342
+ ``-m MAKE_PATH, --make=MAKE_PATH``
343
+ Path to make command.
344
+
345
+ ``--without-ssl``
346
+ Build node.js without SSL support.
347
+
348
+ ``--debug``
349
+ Build debug variant of the node.js.
350
+
351
+ ``--profile``
352
+ Enable profiling for node.js.
353
+
354
+ Other options
355
+ ^^^^^^^^^^^^^
356
+
357
+ ``-v, --verbose``
358
+ Verbose mode.
359
+
360
+ ``-q, --quiet``
361
+ Quiet mode.
362
+
363
+ ``-C CONFIG_FILE, --config-file=CONFIG_FILE``
364
+ Load a different config file than ``~/.nodeenvrc``.
365
+ Pass an empty string for no config (use built-in defaults).
366
+
367
+ ``--ignore_ssl_certs``
368
+ Ignore SSL certificates for package downloads. **UNSAFE - use at your own risk**.
369
+
370
+ ``--version``
371
+ Show program version and exit.
372
+
264
373
  Configuration
265
374
  -------------
266
375
  You can use the INI-style file ``~/.nodeenvrc`` to set default values for many options,
@@ -290,7 +399,7 @@ There are several alternatives that create isolated environments:
290
399
  Nave stores all environments in one directory ``~/.nave``. Can create
291
400
  per node version environments using `nave use envname versionname`.
292
401
  Can not pass additional arguments into configure (for example --without-ssl)
293
- Can't run on windows because it relies on bash.
402
+ Can't run on windows because it relies on a POSIX shell.
294
403
 
295
404
  * `nvm <https://github.com/creationix/nvm/blob/master/nvm.sh>`_ - Node Version
296
405
  Manager. It is necessarily to do `nvm sync` for caching available node.js
@@ -1,10 +1,10 @@
1
1
  Node.js virtual environment
2
2
  ===========================
3
3
 
4
- ``nodeenv`` (node.js virtual environment) is a tool to create
4
+ ``nodeenv`` (node.js virtual environment) is a tool to create
5
5
  isolated node.js environments.
6
6
 
7
- It creates an environment that has its own installation directories,
7
+ It creates an environment that has its own installation directories,
8
8
  that doesn't share libraries with other node.js virtual environments.
9
9
 
10
10
  Also the new environment can be integrated with the environment which was built
@@ -14,8 +14,9 @@ If you use nodeenv feel free to add your project on wiki: `Who-Uses-Nodeenv`_.
14
14
 
15
15
  .. _Who-Uses-Nodeenv: https://github.com/ekalinin/nodeenv/wiki/Who-Uses-Nodeenv
16
16
 
17
- .. image:: https://travis-ci.org/ekalinin/nodeenv.svg?branch=master
18
- :target: https://travis-ci.org/ekalinin/nodeenv
17
+ .. image:: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml/badge.svg?branch=master
18
+ :target: https://github.com/ekalinin/nodeenv/actions/workflows/main.yml
19
+ :alt: CI
19
20
 
20
21
  .. contents:: :local:
21
22
 
@@ -54,7 +55,7 @@ pip_/easy_install_ inside any virtual environment built with virtualenv::
54
55
  (env) $ nodeenv --version
55
56
  0.6.5
56
57
 
57
- If you want to work with the latest version of the nodeenv you can
58
+ If you want to work with the latest version of the nodeenv you can
58
59
  install it from the github `repository`_::
59
60
 
60
61
  $ git clone https://github.com/ekalinin/nodeenv.git
@@ -127,7 +128,7 @@ Get available node.js versions::
127
128
  0.3.2 0.3.3 0.3.4 0.3.5 0.3.6 0.3.7 0.3.8
128
129
  0.4.1 0.4.2 0.4.3 0.4.4 0.4.5 0.4.6
129
130
 
130
- Install node.js "0.4.3" without ssl support with 4 parallel commands
131
+ Install node.js "0.4.3" without ssl support with 4 parallel commands
131
132
  for compilation and npm.js "0.3.17"::
132
133
 
133
134
  $ nodeenv --without-ssl --node=0.4.3 --npm=0.3.17 --with-npm --jobs=4 env-4.3
@@ -176,7 +177,7 @@ Create an environment from a requirements file::
176
177
 
177
178
  $ nodeenv --requirements=../prod-requirements.txt --jobs=4 env-copy
178
179
 
179
- Requirements files are plain text files that contain a list of packages
180
+ Requirements files are plain text files that contain a list of packages
180
181
  to be installed. These text files allow you to create repeatable installations.
181
182
  Requirements file example::
182
183
 
@@ -201,7 +202,7 @@ virtual environment::
201
202
  and add a node virtual environment to this existing new_venv::
202
203
 
203
204
  $ nodeenv -p
204
-
205
+
205
206
  If you need to set the path to make used to build node::
206
207
 
207
208
  $ nodeenv -m /usr/local/bin/gmake ENV
@@ -213,7 +214,7 @@ environment::
213
214
  $ npm install -g coffee-script
214
215
  $ command -v coffee
215
216
  /home/monty/virtualenvs/my_env/bin/coffee
216
-
217
+
217
218
  Creating a virtual environment with a custom prompt:
218
219
 
219
220
  $ nodeenv --node=12.18.2 --prompt="(myenv)" nodeenv
@@ -234,6 +235,104 @@ use `shim` script::
234
235
  $ ./env-4.3/bin/shim --version
235
236
  v0.4.3
236
237
 
238
+ Command Line Options
239
+ --------------------
240
+
241
+ Basic options
242
+ ^^^^^^^^^^^^^
243
+
244
+ ``-n NODE_VER, --node=NODE_VER``
245
+ The node.js version to use, e.g., ``--node=22.11.0``. The default is the
246
+ last stable version (``latest``). Use ``lts`` for the latest LTS release.
247
+ Use ``system`` to use system-wide node.
248
+
249
+ ``-l, --list``
250
+ Lists available node.js versions.
251
+
252
+ ``-p, --python-virtualenv``
253
+ Use current python virtualenv.
254
+
255
+ ``-r FILENAME, --requirements=FILENAME``
256
+ Install all the packages listed in the given requirements file.
257
+
258
+ ``--prompt=PROMPT``
259
+ Provides an alternative prompt prefix for this environment.
260
+
261
+ ``--force``
262
+ Force installation in a pre-existing directory.
263
+
264
+ ``--update``
265
+ Install npm packages from file without reinstalling node.
266
+
267
+ Installation options
268
+ ^^^^^^^^^^^^^^^^^^^^
269
+
270
+ ``--prebuilt``
271
+ Install node.js from prebuilt package (default).
272
+
273
+ ``--source``
274
+ Install node.js from the source (Unix only).
275
+
276
+ ``--mirror=URL``
277
+ Set mirror server of nodejs.org to download from.
278
+
279
+ ``-c, --clean-src``
280
+ Remove "src" directory after installation.
281
+
282
+ NPM options
283
+ ^^^^^^^^^^^
284
+
285
+ ``--npm=NPM_VER``
286
+ The npm version to use, e.g., ``--npm=10.0.0``.
287
+ The default is the last available version (``latest``).
288
+
289
+ ``--with-npm``
290
+ Install npm into the new virtual environment. Required for node.js < 0.6.3.
291
+ By default, the npm included with node.js is used.
292
+
293
+ ``--no-npm-clean``
294
+ Skip the npm 0.x cleanup. Cleanup is enabled by default.
295
+
296
+ Compilation options (Unix only)
297
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
298
+
299
+ ``-j JOBS, --jobs=JOBS``
300
+ Sets number of parallel commands at node.js compilation. The default is 2 jobs.
301
+
302
+ ``--load-average=LOAD``
303
+ Sets maximum load average for executing parallel commands at node.js compilation.
304
+
305
+ ``-m MAKE_PATH, --make=MAKE_PATH``
306
+ Path to make command.
307
+
308
+ ``--without-ssl``
309
+ Build node.js without SSL support.
310
+
311
+ ``--debug``
312
+ Build debug variant of the node.js.
313
+
314
+ ``--profile``
315
+ Enable profiling for node.js.
316
+
317
+ Other options
318
+ ^^^^^^^^^^^^^
319
+
320
+ ``-v, --verbose``
321
+ Verbose mode.
322
+
323
+ ``-q, --quiet``
324
+ Quiet mode.
325
+
326
+ ``-C CONFIG_FILE, --config-file=CONFIG_FILE``
327
+ Load a different config file than ``~/.nodeenvrc``.
328
+ Pass an empty string for no config (use built-in defaults).
329
+
330
+ ``--ignore_ssl_certs``
331
+ Ignore SSL certificates for package downloads. **UNSAFE - use at your own risk**.
332
+
333
+ ``--version``
334
+ Show program version and exit.
335
+
237
336
  Configuration
238
337
  -------------
239
338
  You can use the INI-style file ``~/.nodeenvrc`` to set default values for many options,
@@ -263,7 +362,7 @@ There are several alternatives that create isolated environments:
263
362
  Nave stores all environments in one directory ``~/.nave``. Can create
264
363
  per node version environments using `nave use envname versionname`.
265
364
  Can not pass additional arguments into configure (for example --without-ssl)
266
- Can't run on windows because it relies on bash.
365
+ Can't run on windows because it relies on a POSIX shell.
267
366
 
268
367
  * `nvm <https://github.com/creationix/nvm/blob/master/nvm.sh>`_ - Node Version
269
368
  Manager. It is necessarily to do `nvm sync` for caching available node.js