npm 包 `exists-sync` 使用教程

介绍

在前端开发中，我们经常需要判断某个文件或者目录是否存在。Node.js 内置了 fs 模块，其中有一个 fs.existsSync() 方法可以用来判断文件或目录是否存在。然而，如果你使用了 ES6 的模块化语法，那么可能会遇到以下报错：

ReferenceError: require is not defined

这是因为 fs 模块是 Node.js 原生的模块，而 ES6 的模块化语法并不支持原生的 Node.js 模块。为了解决这个问题，可以使用第三方包 exists-sync。

exists-sync 是一个轻量级的 Node.js 模块，提供了一个 existsSync() 函数用来判断文件或目录是否存在，它可以在 Node.js 和浏览器环境下运行，并且与 ES6 的模块化语法兼容。

安装

在 Node.js 项目中，可以通过 npm 安装 exists-sync：

npm install exists-sync

在浏览器项目中，可以通过 <script> 标签引入 exists-sync 的 UMD 构建版本：

<script src="https://unpkg.com/exists-sync/dist/index.umd.js"></script>

使用方法

判断文件是否存在

首先，让我们看一下如何使用 existsSync() 函数来判断文件是否存在。假设我们要判断 example.txt 文件是否存在，可以这样写：

const { existsSync } = require('exists-sync');

if (existsSync('./example.txt')) {
  console.log('example.txt 存在');
} else {
  console.log('example.txt 不存在');
}

如果你使用的是 ES6 的模块化语法，可以这样写：

import { existsSync } from 'exists-sync';

if (existsSync('./example.txt')) {
  console.log('example.txt 存在');
} else {
  console.log('example.txt 不存在');
}

判断目录是否存在

接下来，让我们看一下如何使用 existsSync() 函数来判断目录是否存在。假设我们要判断 example 目录是否存在，可以这样写：

const { existsSync } = require('exists-sync');

if (existsSync('./example')) {
  console.log('example 目录存在');
} else {
  console.log('example 目录不存在');
}

如果你使用的是 ES6 的模块化语法，可以这样写：

import { existsSync } from 'exists-sync';

if (existsSync('./example')) {
  console.log('example 目录存在');
} else {
  console.log('example 目录不存在');
}

总结

exists-sync 是一个方便的 Node.js 模块，用于判断文件或目录是否存在。它可以在 Node.js 和浏览器环境下运行，并且与 ES6 的模块化语法兼容。使用 exists-sync 可以避免在使用 ES6 的模块化语法时遇到 fs 模块报错的问题。

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