[RFC]: Bringing `resolve` Dependency In-House

未关闭
#11,143 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
冷清
领域
backend, tooling

调研方向

首先检查提议的 @stdlib/utils/resolve 结构,然后检查列出的 resolve 使用者,尤其是 modules/pkg-deps 及其 test/test.walk_file.js。在更改依赖项之前运行现有的使用者测试,然后添加包测试并迁移列出的 import。完成的标准是回归测试通过,并移除 resolve 及其传递依赖;手动验证仍标记为 TODO。

由索引模型根据 Issue 内容生成。

描述

Replace resolve Dependency with In-House @stdlib/utils/resolve

Replace the external resolve npm dependency with a new stdlib-native package. This eliminates resolve and its 3 transitive dependencies (is-core-module, path-parse, supports-preserve-symlinks-flag) from the supply chain — removing 4 third-party packages total.

Background

The resolve package implements Node.js's require.resolve() algorithm with configurable basedir and paths options.

Only these features are used:

Feature Used?
resolve(id, {basedir}, cb) (async) ✅ 5 files
resolve.sync(id, {basedir}) ✅ 7 files
resolve.sync(id, {basedir, paths}) ✅ 1 file
All other options (packageFilter, pathFilter, extensions, moduleDirectory, etc.) ❌

Proposed Changes

New Package: @stdlib/utils/resolve
Folder Structure
lib/node_modules/@stdlib/utils/resolve/
├── README.md                      
├── package.json                   
│
├── lib/
│   ├── index.js                   # Entry point: exports async + .sync
│   ├── main.js                    # Async resolve( id, opts, clbk )
│   ├── sync.js                    # Sync resolve( id, opts ) → string
│   ├── validate.js                # Options validation
│   ├── defaults.js                # Default options (basedir, extensions)
│   ├── resolve_path.js            # Core sync resolution algorithm
│   ├── async_resolve_path.js      # Core async resolution algorithm
│   └── is_core_module.js          # Built-in module check via module.builtinModules
│
├── docs/
│   ├── repl.txt                   
│   └── types/
│       ├── index.d.ts             
│       └── test.ts                
│
├── benchmark/
│   └── benchmark.js               # Performance benchmarks (sync vs async)
│
├── examples/
│   └── index.js                   # Usage examples
│
└── test/
    ├── test.js                    # Main export tests
    ├── test.sync.js               # Sync API tests
    ├── test.async.js              # Async API tests
    ├── test.validate.js           # Options validation tests
    ├── test.is_core_module.js     # Core module detection tests
    └── fixtures/
        ├── node_modules/
        │   └── mock-pkg/
        │       ├── package.json   # { "main": "./lib/index.js" }
        │       └── lib/
        │           └── index.js
        ├── index.js               # Mock directory index
        ├── foo.js                 # Mock module
        └── foo.json               # Mock JSON module
Key Implementation Details

lib/index.js — Entry point matching the resolve package's API shape:

var resolve = require( './main.js' );     // async
var sync = require( './sync.js' );        // sync
resolve.sync = sync;
module.exports = resolve;

lib/resolve_path.js— Core Node.js resolution algorithm:

  1. If id is a core module → return id
  2. If id starts with ./ or ../ or / → resolve as file, then as directory
  3. Otherwise → walk node_modules directories upward from basedir; if paths option given, also search those
  4. File resolution: try exact path → .js → .json → .node
  5. Directory resolution: read package.json main field → fallback to index.js → index.json → index.node

lib/is_core_module.js — Zero-dependency replacement for is-core-module:

var builtinModules = require( 'module' ).builtinModules;
function isCoreModule( id ) {
    return builtinModules.indexOf( id ) !== -1;
}

Internal dependencies only — no third-party packages:

  • path (Node.js built-in)
  • fs (Node.js built-in)
  • module (Node.js built-in)
  • @stdlib/assert/is-string (input validation)
  • @stdlib/assert/is-plain-object (options validation)
  • @stdlib/assert/has-own-property (options checking)
  • @stdlib/error/tools/fmtprodmsg (error formatting)

Consumer Migration (13 files)

Each migration is a 1-line require swap. The API shape is identical.

Sync consumers (8 files) — require( 'resolve' ).sync → require( '@stdlib/utils/resolve' ).sync:

# File
1 eslint/require-file-extensions/lib/main.js
2 modules/pkg-deps/lib/walk_file.sync.js
3 pkgs/browser-compatible/lib/resolve.sync.js
4 pkgs/entry-points/lib/resolve.sync.js
5 pkgs/browser-entry-points/lib/resolve.sync.js
6 utils/library-manifest/lib/main.js
7 repl/help/scripts/build.js

Async consumers (6 files) — require( 'resolve' ) → require( '@stdlib/utils/resolve' ):

# File
8 modules/pkg-deps/lib/walk_file.js
9 modules/pkg-deps/test/test.walk_file.js (also update proxyquire mock key)
10 pkgs/browser-compatible/lib/resolve.js
11 pkgs/entry-points/lib/resolve.js
12 pkgs/browser-entry-points/lib/resolve.js
13 lint/namespace-aliases/lib/resolve.js

Dependency Removal
npm uninstall resolve

Verification Plan

Automated Tests

stdlib uses make test:

  • Run new package tests using stdlib's test infrastructure:
make EXAMPLES_FILTER=".*/utils/resolve/.*"" examples

make BENCHMARKS_FILTER=".*/utils/resolve/.*"" benchmark

make TESTS_FILTER=". */utils/resolve/.*"" test
  • Run consumer regression tests (pkg-deps has the most extensive test suite):
make TESTS_FILTER=". */_tools/modules/pkg-deps/.*"" test
Manual Verification

{TODO}

主要语言
JavaScript
星标
6k
派生
1.3k
平均合并
1 天 21 小时
30 天内合并 PR
224

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

stdlib-js/stdlib 的其他 Issue

查看 stdlib-js/stdlib 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。