Skip to content

Commit

Permalink
deps: replace is-core-module with node builtin (#224)
Browse files Browse the repository at this point in the history
<!-- What / Why -->
<!-- Describe the request in detail. What it does and why it's being
changed. -->
This PR replaces usage of `is-core-module` with node's built-in
`module.builtinModules`, which was added in node 9.3.0, 8.10.0, and
6.13.0. My plan was to use `module.isBuiltin` but that would be a
breaking change as it got added in node 16.17.0 and 18.6.0. Maybe once
older node versions get dropped :P. This makes `normalize-package-data`
use 3 less dependencies, bringing down the total count to 8. The only
difference this *could* have is that `builtinModules` do not include
`node:` builtins, but it doesn't affect this library as names prefixed
by `node:` already throw as they are not valid names.

Packages such as `is-core-module`'s dependencies are only there for
support with *ancient* node versions (>=0.4) and as such have *many*
polyfills, including one that literally emulates hasOwnProperty, and
overall end up cluttering the whole javascript ecosystem. Since this
package includes an engines field of `^16.14.0 || >=18.0.0`, there's no
real reason in using it over a built-in. `is-core-module` in particular
does have its own use case (checking the list of built-ins of a certain
node version other than the current one), but its use in this library
can be replicated by `module.builtinModules`

## References
https://nodejs.org/api/module.html#modulebuiltinmodules

<!-- Examples:
  Related to #0
  Depends on #0
  Blocked by #0
  Fixes #0
  Closes #0
-->

---------

Co-authored-by: Gar <[email protected]>
  • Loading branch information
SuperchupuDev and wraithgar committed Jun 25, 2024
1 parent 335a295 commit 43bab20
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
4 changes: 2 additions & 2 deletions lib/fixer.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ var isValidSemver = require('semver/functions/valid')
var cleanSemver = require('semver/functions/clean')
var validateLicense = require('validate-npm-package-license')
var hostedGitInfo = require('hosted-git-info')
var isBuiltinModule = require('is-core-module')
var moduleBuiltin = require('node:module')
var depTypes = ['dependencies', 'devDependencies', 'optionalDependencies']
var extractDescription = require('./extract_description')
var url = require('url')
Expand Down Expand Up @@ -231,7 +231,7 @@ module.exports = {
data.name = data.name.trim()
}
ensureValidName(data.name, strict, options.allowLegacyCase)
if (isBuiltinModule(data.name)) {
if (moduleBuiltin.builtinModules.includes(data.name)) {
this.warn('conflictingName', data.name)
}
},
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
},
"dependencies": {
"hosted-git-info": "^7.0.0",
"is-core-module": "^2.8.1",
"semver": "^7.3.5",
"validate-npm-package-license": "^3.0.4"
},
Expand Down

0 comments on commit 43bab20

Please sign in to comment.