npm 包 extract-links-from-mdown 使用教程

在前端开发中，链接是非常重要的一部分。而在实现自动化构建等工作中，需要对文本文件中的链接进行提取，这时候就需要使用工具来提升开发效率。 extract-links-from-mdown 是一个 NPM 包，它可以从 Markdown 格式的文件中提取链接。本文将介绍使用 extract-links-from-mdown 的详细步骤和注意点。

安装 extract-links-from-mdown

通过 NPM 安装 extract-links-from-mdown：

npm install extract-links-from-mdown --save-dev

使用 extract-links-from-mdown

基本用法

基本用法非常简单，可以使用 extractLinks 函数来提取 Markdown 文件中的链接：

const extractLinks = require('extract-links-from-mdown');

const links = extractLinks('README.md');

console.log(links);

在上述代码中，我们只需要引入 extractLinks 函数并调用即可提取 README.md 文件中的链接。 extract-links-from-mdown 还支持从字符串中提取链接，只需要将字符串作为参数传递给 extractLinks 函数即可。

进阶用法

extract-links-from-mdown 还支持以下进阶用法：

指定 link 包含的最小字符数

有时候我们只需要获取较为特定的链接，这时设置“最小字符数”可以帮助我们过滤掉不需要的链接。例如其中一条链接可能只是一个网站的 Logo，我们并不需要这样的链接。我们可以通过传递 options 对象来设置“最小字符数”，示例如下：

const extractLinks = require('extract-links-from-mdown');

const links = extractLinks('README.md', { minChars: 5 });

console.log(links);

这样只会提取包含 5 个字符以上的链接。

提取指定类型的链接

如果我们只需要提取特定类型的链接，例如只需要提取 .png 文件的链接，我们可以使用 includeExtensions 选项来实现：

const extractLinks = require('extract-links-from-mdown');

const links = extractLinks('README.md', { includeExtensions: ['png'] });

console.log(links);

这样只会提取 .png 文件的链接。

排除指定类型的链接

如果我们需要排除特定类型的链接，例如排除 .pdf 文件的链接，我们可以使用 excludeExtensions 选项来实现：

const extractLinks = require('extract-links-from-mdown');

const links = extractLinks('README.md', { excludeExtensions: ['pdf'] });

console.log(links);

这样会排除 .pdf 文件的链接。

示例代码

为了更好地理解和使用 extract-links-from-mdown，以下是一些示例代码。

示例一：从字符串中提取链接

const extractLinks = require('extract-links-from-mdown');

const str = '请点击此处访问 http://www.example.com/。';
const links = extractLinks(str);

console.log(links); // ['http://www.example.com/']

示例二：从 Markdown 文件中提取链接

const extractLinks = require('extract-links-from-mdown');

const links = extractLinks('README.md');

console.log(links);

示例三：指定 link 包含的最小字符数

const extractLinks = require('extract-links-from-mdown');

const str = '请点击此处访问 http://www.example.com/。';

const links = extractLinks(str, { minChars: 5 });

console.log(links); // []

示例四：提取指定类型的链接

const extractLinks = require('extract-links-from-mdown');

const str = '请点击此处下载 PDF 文件：http://www.example.com/test.pdf。';

const links = extractLinks(str, { includeExtensions: ['pdf'] });

console.log(links); // ['http://www.example.com/test.pdf']

示例五：排除指定类型的链接

const extractLinks = require('extract-links-from-mdown');

const str = '请点击此处下载 PDF 文件：http://www.example.com/test.pdf。';

const links = extractLinks(str, { excludeExtensions: ['pdf'] });

console.log(links); // []

总结

使用 extract-links-from-mdown 可以帮助我们提取 Markdown 格式文件中的链接，指定特定的链接类型或字符数来提高提取的准确率。熟练掌握这个工具可以帮助我们提高开发效率，减少不必要的手动操作。

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