Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
Node.js JavaScript runtime ✨🐢🚀✨
36,851 Commits 48 Branches 857 Tags 1.8 GiB
JavaScript 61.7%
C++ 22.7%
Python 10.9%
C 3%
HTML 0.7%
Other 0.9%
472edc775d
Go to file
Joyee Cheung 472edc775d
src: disambiguate terms used to refer to builtins and addons 
The term "native module" dates back to some of the oldest code
in the code base. Within the context of Node.js core it usually
refers to modules that are native to Node.js (e.g. fs, http),
but it can cause confusion for people who don't work on this
part of the code base, as "native module" can also refer to
native addons - which is even the case in some of the API
docs and error messages.

This patch tries to make the usage of these terms more consistent.
Now within the context of Node.js core:

- JavaScript scripts that are built-in to Node.js are now referred
  to as "built-in(s)". If they are available as modules,
  they can also be referred to as "built-in module(s)".
- Dynamically-linked shared objects that are loaded into
  the Node.js processes are referred to as "addons".

We will try to avoid using the term "native modules" because it could
be ambiguous.

Changes in this patch:

File names:
- node_native_module.h -> node_builtins.h,
- node_native_module.cc -> node_builtins.cc

C++ binding names:
- `native_module` -> `builtins`

`node::Environment`:
- `native_modules_without_cache` -> `builtins_without_cache`
- `native_modules_with_cache` -> `builtins_with_cache`
- `native_modules_in_snapshot` -> `builtins_in_cache`
- `native_module_require` -> `builtin_module_require`

`node::EnvSerializeInfo`:
- `native_modules` -> `builtins

`node::native_module::NativeModuleLoader`:
- `native_module` namespace -> `builtins` namespace
- `NativeModuleLoader` -> `BuiltinLoader`
- `NativeModuleRecordMap` -> `BuiltinSourceMap`
- `NativeModuleCacheMap` -> `BuiltinCodeCacheMap`
- `ModuleIds` -> `BuiltinIds`
- `ModuleCategories` -> `BuiltinCategories`
- `LoadBuiltinModuleSource` -> `LoadBuiltinSource`

`loader.js`:
- `NativeModule` -> `BuiltinModule` (the `NativeModule` name used in
  `process.moduleLoadList` is kept for compatibility)

And other clarifications in the documentation and comments.

PR-URL: https://github.com/nodejs/node/pull/44135
Fixes: https://github.com/nodejs/node/issues/44036
Reviewed-By: Jacob Smith <jacob@frende.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Jan Krems <jan.krems@gmail.com>
2022-08-09 01:36:49 +08:00
.github src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
benchmark src,lib: print source map error source on demand 2022-07-28 08:09:30 +08:00
deps deps: update undici to 5.8.1 2022-08-08 08:41:22 +00:00
doc src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
lib src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
src src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
test src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
tools src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
typings src: use a typed array internally for process._exiting 2022-07-31 07:32:00 +01:00
.clang-format
.cpplint
.editorconfig
.eslintignore src,lib: print source map error source on demand 2022-07-28 08:09:30 +08:00
.eslintrc.js events: expose CustomEvent on global with CLI flag 2022-07-23 14:39:08 +01:00
.flake8
.gitattributes build: add .gitattributes for npm and other shims 2022-07-19 21:27:49 +01:00
.gitignore build: enable GitPod prebuilds 2022-07-09 12:59:42 +01:00
.gitpod.yml build: make GitPod less noisy 2022-07-14 05:49:31 +01:00
.mailmap meta: update AUTHORS 2022-08-02 05:05:33 +01:00
.nycrc
.yamllint.yaml build: extend yamllint configuration 2022-02-14 19:09:26 +01:00
android-configure build: optimized and fixed building configuration to Android 2022-08-07 11:17:20 +00:00
AUTHORS meta: update AUTHORS 2022-08-07 14:23:31 +00:00
BSDmakefile
BUILDING.md doc: fix Visual Studio 2019 download link 2022-06-21 08:02:56 +01:00
CHANGELOG.md 2022-07-26, Version 18.7.0 (Current) 2022-07-26 18:15:12 -04:00
CODE_OF_CONDUCT.md tools: avoid unnecessary escaping in markdown formatter 2021-10-31 09:36:05 -07:00
codecov.yml
common.gypi deps: V8: cherry-pick 9861ce1deae2 2022-08-05 18:41:31 -04:00
configure
configure.py build: remove dtrace & etw support 2022-07-17 17:33:52 +01:00
CONTRIBUTING.md doc: make contributing info more discoverable 2022-01-18 14:24:30 -05:00
glossary.md doc: add undici to glossary 2022-06-08 17:22:09 -07:00
GOVERNANCE.md doc: make contributing info more discoverable 2022-01-18 14:24:30 -05:00
LICENSE deps,src: use SIMD for normal base64 encoding 2022-07-14 11:41:11 -04:00
Makefile build: clarify missing clang-format tool 2022-07-07 22:17:49 +02:00
node.gyp src: disambiguate terms used to refer to builtins and addons 2022-08-09 01:36:49 +08:00
node.gypi build: fix various shared library build issues 2022-05-06 17:24:46 -04:00
onboarding.md doc: update repository list in onboarding doc 2022-08-03 21:54:36 +00:00
README.md doc: add theanarkh to collaborators 2022-08-04 20:05:37 +08:00
SECURITY.md doc: use ASCII apostrophes consistently 2022-05-17 20:04:51 +01:00
tsconfig.json typings: add more bindings typings 2021-10-31 13:41:45 +01:00
vcbuild.bat build: remove dtrace & etw support 2022-07-17 17:33:52 +01:00

README.md

Node.js

Node.js is an open-source, cross-platform, JavaScript runtime environment.

For information on using Node.js, see the Node.js website.

The Node.js project uses an open governance model. The OpenJS Foundation provides support for the project.

This project has a Code of Conduct.

Table of contents

Support

Looking for help? Check out the instructions for getting support.

Release types

  • Current: Under active development. Code for the Current release is in the branch for its major version number (for example, v15.x). Node.js releases a new major version every 6 months, allowing for breaking changes. This happens in April and October every year. Releases appearing each October have a support life of 8 months. Releases appearing each April convert to LTS (see below) each October.
  • LTS: Releases that receive Long Term Support, with a focus on stability and security. Every even-numbered major version will become an LTS release. LTS releases receive 12 months of Active LTS support and a further 18 months of Maintenance. LTS release lines have alphabetically-ordered code names, beginning with v4 Argon. There are no breaking changes or feature additions, except in some special circumstances.
  • Nightly: Code from the Current branch built every 24-hours when there are changes. Use with caution.

Current and LTS releases follow semantic versioning. A member of the Release Team signs each Current and LTS release. For more information, see the Release README.

Download

Binaries, installers, and source tarballs are available at https://nodejs.org/en/download/.

Current and LTS releases

https://nodejs.org/download/release/

The latest directory is an alias for the latest Current release. The latest-codename directory is an alias for the latest release from an LTS line. For example, the latest-fermium directory contains the latest Fermium (Node.js 14) release.

Nightly releases

https://nodejs.org/download/nightly/

Each directory name and filename contains a date (in UTC) and the commit SHA at the HEAD of the release.

API documentation

Documentation for the latest Current release is at https://nodejs.org/api/. Version-specific documentation is available in each release directory in the docs subdirectory. Version-specific documentation is also at https://nodejs.org/download/docs/.

Verifying binaries

Download directories contain a SHASUMS256.txt file with SHA checksums for the files.

To download SHASUMS256.txt using curl:

$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt

To check that a downloaded file matches the checksum, run it through sha256sum with a command such as:

$ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -

For Current and LTS, the GPG detached signature of SHASUMS256.txt is in SHASUMS256.txt.sig. You can use it with gpg to verify the integrity of SHASUMS256.txt. You will first need to import the GPG keys of individuals authorized to create releases. To import the keys:

$ gpg --keyserver hkps://keys.openpgp.org --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D

See Release keys for a script to import active release keys.

Next, download the SHASUMS256.txt.sig for the release:

$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt.sig

Then use gpg --verify SHASUMS256.txt.sig SHASUMS256.txt to verify the file's signature.

Building Node.js

See BUILDING.md for instructions on how to build Node.js from source and a list of supported platforms.

Security

For information on reporting security vulnerabilities in Node.js, see SECURITY.md.

Contributing to Node.js

Current project team members

For information about the governance of the Node.js project, see GOVERNANCE.md.

TSC (Technical Steering Committee)

Emeriti

TSC emeriti

Collaborators

Emeriti

Collaborator emeriti

Collaborators follow the Collaborator Guide in maintaining the Node.js project.

Triagers

Release keys

Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys):

To import the full set of trusted release keys (including subkeys possibly used to sign releases):

gpg --keyserver hkps://keys.openpgp.org --recv-keys 4ED778F539E3634C779C87C6D7062848A1AB005C
gpg --keyserver hkps://keys.openpgp.org --recv-keys 141F07595B7B3FFE74309A937405533BE57C7D57
gpg --keyserver hkps://keys.openpgp.org --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
gpg --keyserver hkps://keys.openpgp.org --recv-keys 74F12602B6F1C4E913FAA37AD3A89613643B6201
gpg --keyserver hkps://keys.openpgp.org --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
gpg --keyserver hkps://keys.openpgp.org --recv-keys 61FC681DFB92A079F1685E77973F295594EC4689
gpg --keyserver hkps://keys.openpgp.org --recv-keys 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600
gpg --keyserver hkps://keys.openpgp.org --recv-keys C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8
gpg --keyserver hkps://keys.openpgp.org --recv-keys 890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4
gpg --keyserver hkps://keys.openpgp.org --recv-keys C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C
gpg --keyserver hkps://keys.openpgp.org --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D
gpg --keyserver hkps://keys.openpgp.org --recv-keys A48C2BEE680E841632CD4E44F07496B3EB3C1762
gpg --keyserver hkps://keys.openpgp.org --recv-keys 108F52B48DB57BB0CC439B2997B01419BD92F80A
gpg --keyserver hkps://keys.openpgp.org --recv-keys B9E2F5981AA6E0CD28160D9FF13993A75599653C

See Verifying binaries for how to use these keys to verify a downloaded file.

Other keys used to sign some previous releases

Security release stewards

When possible, the commitment to take slots in the security release steward rotation is made by companies in order to ensure individuals who act as security stewards have the support and recognition from their employer to be able to prioritize security releases. Security release stewards manage security releases on a rotation basis as outlined in the security release process.

License

Node.js is available under the MIT license. Node.js also includes external libraries that are available under a variety of licenses. See LICENSE for the full license text.