npm 包 relative-dir.js 使用教程

是什么？

relative-dir.js 是一个用于获取相对路径的 npm 包，它可以让开发者更加便捷地获取当前文件相对于某个目录的路径，并且可以传入多个目录寻找对应的路径。

安装

在终端中输入以下命令，即可安装 relative-dir.js：

npm install relative-dir.js

使用

基本使用

我们可以通过如下代码来获取当前文件相对于项目根目录的路径：

const relativeDir = require('relative-dir.js');

console.log(relativeDir(__dirname, process.cwd())); 

其中，__dirname 为当前文件所在的路径，process.cwd() 为项目根目录的路径。

多个目录的使用

如果我们想要获取当前文件相对于多个目录的路径，我们可以通过传入一个数组来实现：

const relativeDir = require('relative-dir.js');

console.log(relativeDir(__dirname, [process.cwd(), '/usr']))

多个目录将按照传入的顺序进行查找，找到第一个匹配的路径后便会返回，如果都未匹配则返回 null。

过滤不需要的目录

有时候我们并不需要获取某些目录的相对路径，这时可以通过传入一个不需要的路径数组进行过滤：

const relativeDir = require('relative-dir.js');
const filter = ['/usr']

console.log(relativeDir(__dirname, [process.cwd(), '/usr'], filter));

这里我们将 /usr 从目录列表中过滤掉了。

总结

relative-dir.js 是一个非常实用的 npm 包，它可以帮助我们更快地获取目录的相对路径，并且通过传入多个目录和过滤器来满足更多的使用场景。建议大家在开发中充分使用这个工具，以提高开发效率与代码质量。

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