pkg 迪尔
查找 Node.js 项目或 npm 包的根目录
安装
npm install pkg-dir
使用量
/
└── Users
└── sindresorhus
└── foo
├── package.json
└── bar
├── baz
└── example.js
// example.js
import {packageDirectory} from 'pkg-dir';
console.log(await packageDirectory());
//=> '/Users/sindresorhus/foo'
API 密码
包头( 选项 )
回返a Promise 用于工程根路径或 undefined 如果找不到的话.
软件包DirectriSync( 选项)
返回工程根路径或 undefined 如果找不到的话.
选项
类型 : object
数据
类型 : string
默认 : process.cwd()
要开始搜索的目录 .
关于 pkg-dir 的常见问题
pkg-dir 是什么？
查找 Node.js 项目或 npm 包的根目录注意：该包已被作者标记为弃用——Renamed to `package-directory`.
如何安装 pkg-dir？
在项目目录运行 npm install pkg-dir，或使用 pnpm add / yarn add / bun add。
pkg-dir 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
pkg-dir 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
pkg-dir 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
pkg-dir 可以商用吗？
pkg-dir 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
pkg-dir 的下载量有多少？
根据 npm 官方下载统计，pkg-dir 在 2026/10/05 – 2026/11/03 这 30 天内被下载 341,858,856 次，日均约 11,395,295 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
pkg-dir 还在维护吗？
最新版本 9.0.0 发布于 2025/06/06（1.4 年前）；至今共发布 12 个版本，其中过去 12 个月发布了 0 个；首次发布于 2015/09/01。作者已将其标记为弃用，新项目建议寻找替代方案。