babel-plugin-transform-fs-promises/README.md

A Babel plugin to transform fs promises APIs

# babel-plugin-transform-fs-promises

[![Badge](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg?style=flat-square)](https://996.icu/#/en_US)
[![LICENSE](https://img.shields.io/badge/license-Anti%20996-blue.svg?style=flat-square)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
![Node](https://img.shields.io/badge/node-%3E=14-blue.svg?style=flat-square)
[![npm version](https://badge.fury.io/js/babel-plugin-transform-fs-promises.svg)](https://badge.fury.io/js/babel-plugin-transform-fs-promises)

A Babel plugin to transform `require('fs/promises')` to `require('fs').promises` for compatible with Node.js 14 and below.

Compatible with `Babel@^7.0.0`.

## Installation

```bash
npm install babel-plugin-transform-fs-promises --save
```

## Usage

```js
// import via esm
import babelPluginTransformFsPromises from "babel-plugin-transform-fs-promises";

// import via cjs
const babelPluginTransformFsPromises = require("babel-plugin-transform-fs-promises");
```

```js
import { transformSync } from "@babel/core";
import babelPluginTransformFsPromises from "babel-plugin-transform-fs-promises";

const code = `
import { readFile } from 'fs/promises';
readFile('foo.txt');
`;

const result = transformSync(code, {
    plugins: [babelPluginTransformFsPromises],
});

console.log(result.code);

// Output:

/**

import { promises as _promises } from 'fs';
const { readFile } = _promises;
readFile('foo.txt');

*/
```

## Relative

- [transform-fs-promises-webpack-plugin](https://github.com/axetroy/transform-fs-promises-webpack-plugin)

## License

The [Anti 996 License](LICENSE)