Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 2.3 KB

modules-in-core.md

File metadata and controls

55 lines (43 loc) · 2.3 KB
Raw

To be or not to be in core

Should a module be in core? This question arises every so often. This document explains things to consider when deciding whether a module should be in core or not.

Strong arguments for including a module in core

  1. The module provides functionality that is standardized (such as a Web API) and overlaps with existing functionality.
  2. The module can only be implemented in core.
  3. The module can only be implemented in a performant way in core.
  4. Developer experience is significantly improved if the module is in core.
  5. The module provides functionality that can be expected to solve at least one common use case Node.js users face.
  6. The module requires native bindings. Inclusion in core enables utility across operating systems and architectures without requiring users to have a native compilation toolchain.
  7. Part or all of the module will also be re-used or duplicated in core.

Strong arguments against including a module in core

  1. None of the arguments list in the previous section apply.
  2. The module has a license that prohibits Node.js from including it in core without also changing its own license.
  3. There is already similar functionality in core and adding the module will provide a second API to do the same thing.
  4. A module (or/and the standard it is based on) is deprecated and there is a non-deprecated alternative.
  5. The module is evolving quickly and inclusion in core will require frequent API changes.

Benefits and challenges

When it is unclear whether a module should be included in core, it might be helpful to consider these additional factors.

Benefits

  1. The module will receive more frequent testing with Node.js CI and CITGM.
  2. The module will be integrated into the LTS workflow.
  3. Documentation will be integrated with core.
  4. There is no dependency on npm.

Challenges

  1. Inclusion in core is likely to reduce code merging velocity as the Node.js process for code review and merging is more time-consuming than that of most individual modules.
  2. By being bound to the Node.js release cycle, it is harder and slower to publish patches.
  3. Less flexibility for end users. They can't update the module when they choose without also updating Node.js.