npm 包 whereami 使用教程

在开发前端项目时，我们经常需要知道当前所在的目录或者文件路径，这时候如果手动去查找非常麻烦，而 npm 包 whereami 可以让我们更方便地获取当前所在的目录和文件路径。在本篇文章中，我们将详细介绍如何使用 whereami 这个 npm 包，并提供相应的示例代码。

安装 whereami

安装 whereami 时，可以通过 npm 命令进行安装：

npm install --save-dev whereami

执行完此命令之后，whereami 就会被安装到您的项目中。

使用 whereami 获取当前目录和文件路径

whereami 可以通过 whereami() 函数获取当前目录和文件路径，具体代码如下：

const whereami = require('whereami');
console.log(whereami());

执行此代码，即可获取当前目录和文件路径。

获取当前目录

如果只需要获取当前目录，而不需要获取当前文件路径，可以将 returnFullPath 参数设为 false ，代码示例如下：

const whereami = require('whereami');
console.log(whereami(false));

执行此代码，将只会返回当前所在目录，而不会返回文件路径。

获取父级目录

获取父级目录可以使用 whereamiParent() 函数，代码示例如下：

const whereami = require('whereami');
console.log(whereami.whereamiParent());

以上代码将返回当前所在目录的父级目录。

whereami 配置

whereami 还可以支持一些配置，如是否搜索最近的 package.json 文件以及是否要包含文件后缀名。以下是支持的配置选项：

returnFullPath

• 类型: boolean
• 默认值: true
• 是否返回包含文件路径的完整信息

packageProp

• 类型: string
• 默认值: "whereami"
• Package.json 文件中 search 的属性名

packageJson

• 类型: object
• 默认值: undefined
• 要搜索的 Package.json 对象

includeExtension

• 类型: boolean
• 默认值: true
• 搜索文件时是否要包括文件后缀名

这些配置选项可以通过将新的配置对象传递给 whereami 函数，如以下代码所示：

const whereami = require('whereami');
console.log(whereami({
  returnFullPath: true,
  packageProp: "whereami",
  includeExtension: true
}));

总结

本文介绍了如何使用 npm 包 whereami 获取当前的目录和文件路径，以及如何使用一些配置选项以满足各种不同的需求。无论是在开发过程中快速定位文件位置还是在项目部署中寻找目录路径，whereami 都将是一个非常有用的 npm 包。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006710c8dd3466f61ffe13e