Showing preview only (497K chars total). Download the full file or copy to clipboard to get everything.
Repository: jprichardson/node-fs-extra
Branch: master
Commit: 353a29b18c88
Files: 165
Total size: 456.2 KB
Directory structure:
gitextract_ch38kmlm/
├── .github/
│ ├── issue_template.md
│ └── workflows/
│ └── ci.yml
├── .gitignore
├── .npmrc
├── CHANGELOG.md
├── LICENSE
├── README.md
├── docs/
│ ├── copy-sync.md
│ ├── copy.md
│ ├── emptyDir-sync.md
│ ├── emptyDir.md
│ ├── ensureDir-sync.md
│ ├── ensureDir.md
│ ├── ensureFile-sync.md
│ ├── ensureFile.md
│ ├── ensureLink-sync.md
│ ├── ensureLink.md
│ ├── ensureSymlink-sync.md
│ ├── ensureSymlink.md
│ ├── fs-read-write-writev.md
│ ├── move-sync.md
│ ├── move.md
│ ├── outputFile-sync.md
│ ├── outputFile.md
│ ├── outputJson-sync.md
│ ├── outputJson.md
│ ├── pathExists-sync.md
│ ├── pathExists.md
│ ├── readJson-sync.md
│ ├── readJson.md
│ ├── remove-sync.md
│ ├── remove.md
│ ├── writeJson-sync.md
│ └── writeJson.md
├── lib/
│ ├── __tests__/
│ │ └── promise.test.js
│ ├── copy/
│ │ ├── __tests__/
│ │ │ ├── copy-broken-symlink.test.js
│ │ │ ├── copy-case-insensitive-paths.test.js
│ │ │ ├── copy-dev-null.test.js
│ │ │ ├── copy-gh-89.test.js
│ │ │ ├── copy-permissions.test.js
│ │ │ ├── copy-preserve-timestamp.test.js
│ │ │ ├── copy-prevent-copying-identical.test.js
│ │ │ ├── copy-prevent-copying-into-itself.test.js
│ │ │ ├── copy-readonly-dir.test.js
│ │ │ ├── copy-symlink-same-target.test.js
│ │ │ ├── copy-sync-broken-symlink.test.js
│ │ │ ├── copy-sync-case-insensitive-paths.test.js
│ │ │ ├── copy-sync-dir.test.js
│ │ │ ├── copy-sync-file.test.js
│ │ │ ├── copy-sync-preserve-timestamp.test.js
│ │ │ ├── copy-sync-prevent-copying-identical.test.js
│ │ │ ├── copy-sync-prevent-copying-into-itself.test.js
│ │ │ ├── copy-sync-readonly-dir.test.js
│ │ │ ├── copy-sync-symlink-same-target.test.js
│ │ │ ├── copy-sync-symlink.test.js
│ │ │ ├── copy.test.js
│ │ │ └── ncp/
│ │ │ ├── README.md
│ │ │ ├── broken-symlink.test.js
│ │ │ ├── fixtures/
│ │ │ │ ├── modified-files/
│ │ │ │ │ ├── out/
│ │ │ │ │ │ └── a
│ │ │ │ │ └── src/
│ │ │ │ │ └── a
│ │ │ │ └── regular-fixtures/
│ │ │ │ ├── out/
│ │ │ │ │ ├── a
│ │ │ │ │ ├── b
│ │ │ │ │ ├── c
│ │ │ │ │ ├── d
│ │ │ │ │ ├── e
│ │ │ │ │ ├── f
│ │ │ │ │ └── sub/
│ │ │ │ │ ├── a
│ │ │ │ │ └── b
│ │ │ │ └── src/
│ │ │ │ ├── a
│ │ │ │ ├── b
│ │ │ │ ├── c
│ │ │ │ ├── d
│ │ │ │ ├── e
│ │ │ │ ├── f
│ │ │ │ └── sub/
│ │ │ │ ├── a
│ │ │ │ └── b
│ │ │ ├── ncp-error-perm.test.js
│ │ │ ├── ncp.test.js
│ │ │ └── symlink.test.js
│ │ ├── copy-sync.js
│ │ ├── copy.js
│ │ └── index.js
│ ├── empty/
│ │ ├── __tests__/
│ │ │ ├── empty-dir-sync.test.js
│ │ │ └── empty-dir.test.js
│ │ └── index.js
│ ├── ensure/
│ │ ├── __tests__/
│ │ │ ├── create.test.js
│ │ │ ├── ensure.test.js
│ │ │ ├── link.test.js
│ │ │ ├── symlink-paths.test.js
│ │ │ ├── symlink-type.test.js
│ │ │ └── symlink.test.js
│ │ ├── file.js
│ │ ├── index.js
│ │ ├── link.js
│ │ ├── symlink-paths.js
│ │ ├── symlink-type.js
│ │ └── symlink.js
│ ├── esm.mjs
│ ├── fs/
│ │ ├── __tests__/
│ │ │ ├── copyFile.test.js
│ │ │ ├── fs-integration.test.js
│ │ │ ├── multi-param.test.js
│ │ │ ├── mz.test.js
│ │ │ ├── realpath.test.js
│ │ │ └── rm.test.js
│ │ └── index.js
│ ├── index.js
│ ├── json/
│ │ ├── __tests__/
│ │ │ ├── jsonfile-integration.test.js
│ │ │ ├── output-json-sync.test.js
│ │ │ ├── output-json.test.js
│ │ │ ├── promise-support.test.js
│ │ │ └── read.test.js
│ │ ├── index.js
│ │ ├── jsonfile.js
│ │ ├── output-json-sync.js
│ │ └── output-json.js
│ ├── mkdirs/
│ │ ├── __tests__/
│ │ │ ├── chmod.test.js
│ │ │ ├── clobber.test.js
│ │ │ ├── issue-209.test.js
│ │ │ ├── issue-93.test.js
│ │ │ ├── mkdir.test.js
│ │ │ ├── mkdirp.test.js
│ │ │ ├── opts-undef.test.js
│ │ │ ├── perm.test.js
│ │ │ ├── perm_sync.test.js
│ │ │ ├── race.test.js
│ │ │ ├── rel.test.js
│ │ │ ├── root.test.js
│ │ │ └── sync.test.js
│ │ ├── index.js
│ │ ├── make-dir.js
│ │ └── utils.js
│ ├── move/
│ │ ├── __tests__/
│ │ │ ├── cross-device-utils.js
│ │ │ ├── move-case-insensitive-paths.test.js
│ │ │ ├── move-preserve-timestamp.test.js
│ │ │ ├── move-prevent-moving-identical.test.js
│ │ │ ├── move-prevent-moving-into-itself.test.js
│ │ │ ├── move-sync-case-insensitive-paths.test.js
│ │ │ ├── move-sync-preserve-timestamp.test.js
│ │ │ ├── move-sync-prevent-moving-identical.test.js
│ │ │ ├── move-sync-prevent-moving-into-itself.test.js
│ │ │ ├── move-sync.test.js
│ │ │ └── move.test.js
│ │ ├── index.js
│ │ ├── move-sync.js
│ │ └── move.js
│ ├── output-file/
│ │ ├── __tests__/
│ │ │ └── output.test.js
│ │ └── index.js
│ ├── path-exists/
│ │ ├── __tests__/
│ │ │ ├── path-exists-sync.test.js
│ │ │ └── path-exists.test.js
│ │ └── index.js
│ ├── remove/
│ │ ├── __tests__/
│ │ │ ├── remove-dir.test.js
│ │ │ ├── remove-file.test.js
│ │ │ ├── remove-sync-dir.test.js
│ │ │ ├── remove-sync-file.test.js
│ │ │ └── remove.test.js
│ │ └── index.js
│ └── util/
│ ├── __tests__/
│ │ ├── stat.test.js
│ │ └── utimes.test.js
│ ├── async.js
│ ├── stat.js
│ └── utimes.js
├── package.json
├── test/
│ └── readme.md
├── test.js
└── test.mjs
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/issue_template.md
================================================
<!-- First ensure you installed the latest version of fs-extra -->
<!-- If your bug still exists please fill out the following information if it applies to your issue: -->
<!-- Please check if you have installed a supported version of Node.js as written in "engines" in the package.json -->
- **Operating System:**
- **Node.js version:**
- **`fs-extra` version:**
================================================
FILE: .github/workflows/ci.yml
================================================
name: Node.js CI
on:
push:
branches: master
pull_request:
permissions:
contents: read # to fetch code (actions/checkout)
jobs:
test:
strategy:
matrix:
node: [14.x, 16.x, 18.x, 20.x, 22.x, 24.x]
os: [ubuntu-latest, macos-15-intel, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node }}
- run: npm install
- run: npm test
================================================
FILE: .gitignore
================================================
.nyc_output/
coverage/
node_modules/
.idea
*.iml
npm-debug.log
================================================
FILE: .npmrc
================================================
package-lock=false
================================================
FILE: CHANGELOG.md
================================================
11.3.4 / 2026-03-03
-------------------
- Fix bug where calling `ensureSymlink`/`ensureSymlinkSync` with a relative `srcPath` would fail if the symlink already existed ([#1038](https://github.com/jprichardson/node-fs-extra/issues/1038), [#1064](https://github.com/jprichardson/node-fs-extra/pull/1064))
11.3.3 / 2025-12-18
-------------------
- Fix copying symlink when destination is a symlink to the same target ([#1019](https://github.com/jprichardson/node-fs-extra/issues/1019), [#1060](https://github.com/jprichardson/node-fs-extra/pull/1060))
11.3.2 / 2025-09-15
-------------------
- Fix spurrious `UnhandledPromiseRejectionWarning` that could occur when calling `.copy()` in some cases ([#1056](https://github.com/jprichardson/node-fs-extra/issues/1056), [#1058](https://github.com/jprichardson/node-fs-extra/pull/1058))
11.3.1 / 2025-08-05
-------------------
- Fix case where `move`/`moveSync` could incorrectly think files are identical on Windows ([#1050](https://github.com/jprichardson/node-fs-extra/pull/1050))
11.3.0 / 2025-01-15
-------------------
- Add promise support for newer `fs` methods ([#1044](https://github.com/jprichardson/node-fs-extra/issues/1044), [#1045](https://github.com/jprichardson/node-fs-extra/pull/1045))
- Use `fs.opendir` in `copy()`/`copySync()` for better perf/scalability ([#972](https://github.com/jprichardson/node-fs-extra/issues/972), [#1028](https://github.com/jprichardson/node-fs-extra/pull/1028))
11.2.0 / 2023-11-27
-------------------
- Copy directory contents in parallel for better performance ([#1026](https://github.com/jprichardson/node-fs-extra/pull/1026))
- Refactor internal code to use `async`/`await` ([#1020](https://github.com/jprichardson/node-fs-extra/issues/1020))
11.1.1 / 2023-03-20
-------------------
- Preserve timestamps when moving files across devices ([#992](https://github.com/jprichardson/node-fs-extra/issues/992), [#994](https://github.com/jprichardson/node-fs-extra/pull/994))
11.1.0 / 2022-11-29
-------------------
- Re-add `main` field to `package.json` for better TypeScript compatibility ([#979](https://github.com/jprichardson/node-fs-extra/issues/979), [#981](https://github.com/jprichardson/node-fs-extra/pull/981))
11.0.0 / 2022-11-28
-------------------
### Breaking Changes
- Don't allow requiring `fs-extra/lib/SOMETHING` (switched to `exports`) ([#974](https://github.com/jprichardson/node-fs-extra/pull/974))
- Require Node v14.14+ ([#968](https://github.com/jprichardson/node-fs-extra/issues/968), [#969](https://github.com/jprichardson/node-fs-extra/pull/969))
### New Features
- Add `fs-extra/esm` for ESM named export support; see [docs](https://github.com/jprichardson/node-fs-extra#esm) for details ([#746](https://github.com/jprichardson/node-fs-extra/issues/746), [#974](https://github.com/jprichardson/node-fs-extra/pull/974))
- Add promise support for `fs.readv()` ([#970](https://github.com/jprichardson/node-fs-extra/pull/970))
### Bugfixes
- Don't `stat` filtered items in `copy*` ([#965](https://github.com/jprichardson/node-fs-extra/issues/965), [#971](https://github.com/jprichardson/node-fs-extra/pull/971))
- Remove buggy stats check in `copy` ([#918](https://github.com/jprichardson/node-fs-extra/issues/918), [#976](https://github.com/jprichardson/node-fs-extra/pull/976))
10.1.0 / 2022-04-16
-------------------
- Warn if `fs.realpath.native` does not exist, instead of erroring ([#953](https://github.com/jprichardson/node-fs-extra/pull/953))
- Allow explicitly passing `undefined` options to `move()` ([#947](https://github.com/jprichardson/node-fs-extra/issues/947), [#955](https://github.com/jprichardson/node-fs-extra/pull/955))
- Use `process.emitWarning` instead of `console.warn` ([#954](https://github.com/jprichardson/node-fs-extra/pull/954))
10.0.1 / 2022-02-22
-------------------
- Add `sideEffects: false` to `package.json` ([#941](https://github.com/jprichardson/node-fs-extra/pull/941))
10.0.0 / 2021-05-03
-------------------
### Breaking changes
- Require Node.js v12+ ([#886](https://github.com/jprichardson/node-fs-extra/issues/886), [#893](https://github.com/jprichardson/node-fs-extra/pull/893), [#890](https://github.com/jprichardson/node-fs-extra/pull/890), [#894](https://github.com/jprichardson/node-fs-extra/pull/894), [#895]( https://github.com/jprichardson/node-fs-extra/pull/895))
- Allow copying broken symlinks ([#779](https://github.com/jprichardson/node-fs-extra/pull/779), [#765](https://github.com/jprichardson/node-fs-extra/issues/765), [#638](https://github.com/jprichardson/node-fs-extra/issues/638), [#761](https://github.com/jprichardson/node-fs-extra/issues/761))
**The following changes, although technically semver-major, will not affect the vast majority of users:**
- Ensure correct type when destination exists for `ensureLink*()`/`ensureSymlink*()` ([#826](https://github.com/jprichardson/node-fs-extra/pull/826), [#786](https://github.com/jprichardson/node-fs-extra/issues/786), [#870](https://github.com/jprichardson/node-fs-extra/issues/870))
- Error when attempting to `copy*()` unknown file type ([#880](https://github.com/jprichardson/node-fs-extra/pull/880))
- Remove undocumented options for `remove*()` ([#882](https://github.com/jprichardson/node-fs-extra/pull/882))
### Improvements
- Allow changing case of filenames with `move*()`, even on technically case-insensitive filesystems ([#759](https://github.com/jprichardson/node-fs-extra/issues/759), [#801](https://github.com/jprichardson/node-fs-extra/pull/801))
- Use native `fs.rm*()` for `remove*()` in environments that support it ([#882](https://github.com/jprichardson/node-fs-extra/pull/882), [#806](https://github.com/jprichardson/node-fs-extra/issues/806))
- Improve `emptyDir()` performance ([#885](https://github.com/jprichardson/node-fs-extra/pull/885))
### Bugfixes
- Ensure `copy*()`'s `filter` function is not called more than necessary ([#883](https://github.com/jprichardson/node-fs-extra/pull/883), [#809](https://github.com/jprichardson/node-fs-extra/issues/809))
- Fix `move*()` raising `EPERM` error when moving a file to the root of a drive on Windows ([#897](https://github.com/jprichardson/node-fs-extra/pull/897), [#819](https://github.com/jprichardson/node-fs-extra/issues/819))
### Miscellaneous changes
- Do not use `at-least-node` as a dependency ([#896](https://github.com/jprichardson/node-fs-extra/pull/896))
- Improve documentation ([#888](https://github.com/jprichardson/node-fs-extra/pull/888), [#830](https://github.com/jprichardson/node-fs-extra/issues/830), [#884](https://github.com/jprichardson/node-fs-extra/pull/884), [#843](https://github.com/jprichardson/node-fs-extra/issues/843))
9.1.0 / 2021-01-19
------------------
- Add promise support for `fs.rm()` ([#841](https://github.com/jprichardson/node-fs-extra/issues/841), [#860](https://github.com/jprichardson/node-fs-extra/pull/860))
- Upgrade universalify for performance improvments ([#825](https://github.com/jprichardson/node-fs-extra/pull/825))
9.0.1 / 2020-06-03
------------------
- Fix issue with `ensureFile()` when used with Jest on Windows ([#804](https://github.com/jprichardson/node-fs-extra/issues/804), [#805](https://github.com/jprichardson/node-fs-extra/pull/805))
- Remove unneeded `process.umask()` call ([#791](https://github.com/jprichardson/node-fs-extra/pull/791))
- Docs improvements ([#753](https://github.com/jprichardson/node-fs-extra/pull/753), [#795](https://github.com/jprichardson/node-fs-extra/pull/795), [#797](https://github.com/jprichardson/node-fs-extra/pull/797))
9.0.0 / 2020-03-19
------------------
### Breaking changes
- Requires Node.js version 10 or greater ([#725](https://github.com/jprichardson/node-fs-extra/issues/725), [#751](https://github.com/jprichardson/node-fs-extra/pull/751))
- Switched `ensureDir*` to use a fork of https://github.com/sindresorhus/make-dir to make use of native recursive `fs.mkdir` where possible ([#619](https://github.com/jprichardson/node-fs-extra/issues/619), [#756](https://github.com/jprichardson/node-fs-extra/pull/756))
- Properly preserve `atime` for `copy*` with `preserveTimestamps` option ([#633](https://github.com/jprichardson/node-fs-extra/pull/633))
**The following changes, allthough technically breaking, will not affect the vast majority of users:**
- `outputJson` now outputs objects as they were when the function was called, even if they are mutated later ([#702](https://github.com/jprichardson/node-fs-extra/issues/702), [#768](https://github.com/jprichardson/node-fs-extra/pull/768))
- Cannot pass `null` as an options parameter to `*Json*` methods ([#745](https://github.com/jprichardson/node-fs-extra/issues/745), [#768](https://github.com/jprichardson/node-fs-extra/pull/768))
### Improvements
- Add promise shims for `fs.writev` & `fs.opendir` ([#747](https://github.com/jprichardson/node-fs-extra/pull/747))
- Better errors for `ensureFile` ([#696](https://github.com/jprichardson/node-fs-extra/issues/696), [#744](https://github.com/jprichardson/node-fs-extra/pull/744))
- Better file comparison for older Node versions ([#694](https://github.com/jprichardson/node-fs-extra/pull/694))
### Miscellaneous changes
- Peformance optimizations ([#762](https://github.com/jprichardson/node-fs-extra/issues/762), [#764](https://github.com/jprichardson/node-fs-extra/pull/764))
- Add missing documentation for aliases ([#758](https://github.com/jprichardson/node-fs-extra/issues/758), [#766](https://github.com/jprichardson/node-fs-extra/pull/766))
- Update `universalify` dependency ([#767](https://github.com/jprichardson/node-fs-extra/pull/767))
8.1.0 / 2019-06-28
------------------
- Add support for promisified `fs.realpath.native` in Node v9.2+ ([#650](https://github.com/jprichardson/node-fs-extra/issues/650), [#682](https://github.com/jprichardson/node-fs-extra/pull/682))
- Update `graceful-fs` dependency ([#700](https://github.com/jprichardson/node-fs-extra/pull/700))
- Use `graceful-fs` everywhere ([#700](https://github.com/jprichardson/node-fs-extra/pull/700))
8.0.1 / 2019-05-13
------------------
- Fix bug `Maximum call stack size exceeded` error in `util/stat` ([#679](https://github.com/jprichardson/node-fs-extra/pull/679))
8.0.0 / 2019-05-11
------------------
**NOTE:** Node.js v6 support is deprecated, and will be dropped in the next major release.
- Use `renameSync()` under the hood in `moveSync()`
- Fix bug with bind-mounted directories in `copy*()` ([#613](https://github.com/jprichardson/node-fs-extra/issues/613), [#618](https://github.com/jprichardson/node-fs-extra/pull/618))
- Fix bug in `move()` with case-insensitive file systems
- Use `fs.stat()`'s `bigint` option in `copy*()` & `move*()` where possible ([#657](https://github.com/jprichardson/node-fs-extra/issues/657))
7.0.1 / 2018-11-07
------------------
- Fix `removeSync()` on Windows, in some cases, it would error out with `ENOTEMPTY` ([#646](https://github.com/jprichardson/node-fs-extra/pull/646))
- Document `mode` option for `ensureDir*()` ([#587](https://github.com/jprichardson/node-fs-extra/pull/587))
- Don't include documentation files in npm package tarball ([#642](https://github.com/jprichardson/node-fs-extra/issues/642), [#643](https://github.com/jprichardson/node-fs-extra/pull/643))
7.0.0 / 2018-07-16
------------------
- **BREAKING:** Refine `copy*()` handling of symlinks to properly detect symlinks that point to the same file. ([#582](https://github.com/jprichardson/node-fs-extra/pull/582))
- Fix bug with copying write-protected directories ([#600](https://github.com/jprichardson/node-fs-extra/pull/600))
- Universalify `fs.lchmod()` ([#596](https://github.com/jprichardson/node-fs-extra/pull/596))
- Add `engines` field to `package.json` ([#580](https://github.com/jprichardson/node-fs-extra/pull/580))
6.0.1 / 2018-05-09
------------------
- Fix `fs.promises` `ExperimentalWarning` on Node v10.1.0 ([#578](https://github.com/jprichardson/node-fs-extra/pull/578))
6.0.0 / 2018-05-01
------------------
- Drop support for Node.js versions 4, 5, & 7 ([#564](https://github.com/jprichardson/node-fs-extra/pull/564))
- Rewrite `move` to use `fs.rename` where possible ([#549](https://github.com/jprichardson/node-fs-extra/pull/549))
- Don't convert relative paths to absolute paths for `filter` ([#554](https://github.com/jprichardson/node-fs-extra/pull/554))
- `copy*`'s behavior when `preserveTimestamps` is `false` has been OS-dependent since 5.0.0, but that's now explicitly noted in the docs ([#563](https://github.com/jprichardson/node-fs-extra/pull/563))
- Fix subdirectory detection for `copy*` & `move*` ([#541](https://github.com/jprichardson/node-fs-extra/pull/541))
- Handle case-insensitive paths correctly in `copy*` ([#568](https://github.com/jprichardson/node-fs-extra/pull/568))
5.0.0 / 2017-12-11
------------------
Significant refactor of `copy()` & `copySync()`, including breaking changes. No changes to other functions in this release.
Huge thanks to **[@manidlou](https://github.com/manidlou)** for doing most of the work on this release.
- The `filter` option can no longer be a RegExp (must be a function). This was deprecated since fs-extra v1.0.0. [#512](https://github.com/jprichardson/node-fs-extra/pull/512)
- `copy()`'s `filter` option can now be a function that returns a Promise. [#518](https://github.com/jprichardson/node-fs-extra/pull/518)
- `copy()` & `copySync()` now use `fs.copyFile()`/`fs.copyFileSync()` in environments that support it (currently Node 8.5.0+). Older Node versions still get the old implementation. [#505](https://github.com/jprichardson/node-fs-extra/pull/505)
- Don't allow copying a directory into itself. [#83](https://github.com/jprichardson/node-fs-extra/issues/83)
- Handle copying between identical files. [#198](https://github.com/jprichardson/node-fs-extra/issues/198)
- Error out when copying an empty folder to a path that already exists. [#464](https://github.com/jprichardson/node-fs-extra/issues/464)
- Don't create `dest`'s parent if the `filter` function aborts the `copy()` operation. [#517](https://github.com/jprichardson/node-fs-extra/pull/517)
- Fix `writeStream` not being closed if there was an error in `copy()`. [#516](https://github.com/jprichardson/node-fs-extra/pull/516)
4.0.3 / 2017-12-05
------------------
- Fix wrong `chmod` values in `fs.remove()` [#501](https://github.com/jprichardson/node-fs-extra/pull/501)
- Fix `TypeError` on systems that don't have some `fs` operations like `lchown` [#520](https://github.com/jprichardson/node-fs-extra/pull/520)
4.0.2 / 2017-09-12
------------------
- Added `EOL` option to `writeJson*` & `outputJson*` (via upgrade to jsonfile v4)
- Added promise support to [`fs.copyFile()`](https://nodejs.org/api/fs.html#fs_fs_copyfile_src_dest_flags_callback) in Node 8.5+
- Added `.js` extension to `main` field in `package.json` for better tooling compatibility. [#485](https://github.com/jprichardson/node-fs-extra/pull/485)
4.0.1 / 2017-07-31
------------------
### Fixed
- Previously, `ensureFile()` & `ensureFileSync()` would do nothing if the path was a directory. Now, they error out for consistency with `ensureDir()`. [#465](https://github.com/jprichardson/node-fs-extra/issues/465), [#466](https://github.com/jprichardson/node-fs-extra/pull/466), [#470](https://github.com/jprichardson/node-fs-extra/issues/470)
4.0.0 / 2017-07-14
------------------
### Changed
- **BREAKING:** The promisified versions of `fs.read()` & `fs.write()` now return objects. See [the docs](docs/fs-read-write.md) for details. [#436](https://github.com/jprichardson/node-fs-extra/issues/436), [#449](https://github.com/jprichardson/node-fs-extra/pull/449)
- `fs.move()` now errors out when destination is a subdirectory of source. [#458](https://github.com/jprichardson/node-fs-extra/pull/458)
- Applied upstream fixes from `rimraf` to `fs.remove()` & `fs.removeSync()`. [#459](https://github.com/jprichardson/node-fs-extra/pull/459)
### Fixed
- Got `fs.outputJSONSync()` working again; it was broken due to refactoring. [#428](https://github.com/jprichardson/node-fs-extra/pull/428)
Also clarified the docs in a few places.
3.0.1 / 2017-05-04
------------------
- Fix bug in `move()` & `moveSync()` when source and destination are the same, and source does not exist. [#415](https://github.com/jprichardson/node-fs-extra/pull/415)
3.0.0 / 2017-04-27
------------------
### Added
- **BREAKING:** Added Promise support. All asynchronous native fs methods and fs-extra methods now return a promise if the callback is not passed. [#403](https://github.com/jprichardson/node-fs-extra/pull/403)
- `pathExists()`, a replacement for the deprecated `fs.exists`. `pathExists` has a normal error-first callback signature. Also added `pathExistsSync`, an alias to `fs.existsSync`, for completeness. [#406](https://github.com/jprichardson/node-fs-extra/pull/406)
### Removed
- **BREAKING:** Removed support for setting the default spaces for `writeJson()`, `writeJsonSync()`, `outputJson()`, & `outputJsonSync()`. This was undocumented. [#402](https://github.com/jprichardson/node-fs-extra/pull/402)
### Changed
- Upgraded jsonfile dependency to v3.0.0:
- **BREAKING:** Changed behavior of `throws` option for `readJsonSync()`; now does not throw filesystem errors when `throws` is `false`.
- **BREAKING:** `writeJson()`, `writeJsonSync()`, `outputJson()`, & `outputJsonSync()` now output minified JSON by default for consistency with `JSON.stringify()`; set the `spaces` option to `2` to override this new behavior. [#402](https://github.com/jprichardson/node-fs-extra/pull/402)
- Use `Buffer.allocUnsafe()` instead of `new Buffer()` in environments that support it. [#394](https://github.com/jprichardson/node-fs-extra/pull/394)
### Fixed
- `removeSync()` silently failed on Windows in some cases. Now throws an `EBUSY` error. [#408](https://github.com/jprichardson/node-fs-extra/pull/408)
2.1.2 / 2017-03-16
------------------
### Fixed
- Weird windows bug that resulted in `ensureDir()`'s callback being called twice in some cases. This bug may have also affected `remove()`. See [#392](https://github.com/jprichardson/node-fs-extra/issues/392), [#393](https://github.com/jprichardson/node-fs-extra/pull/393)
2.1.1 / 2017-03-15
------------------
### Fixed
- Reverted [`5597bd`](https://github.com/jprichardson/node-fs-extra/commit/5597bd5b67f7d060f5f5bf26e9635be48330f5d7), this broke compatibility with Node.js versions v4+ but less than `v4.5.0`.
- Remove `Buffer.alloc()` usage in `moveSync()`.
2.1.0 / 2017-03-15
------------------
Thanks to [Mani Maghsoudlou (@manidlou)](https://github.com/manidlou) & [Jan Peer Stöcklmair (@JPeer264)](https://github.com/JPeer264) for their extraordinary help with this release!
### Added
- `moveSync()` See [#309], [#381](https://github.com/jprichardson/node-fs-extra/pull/381). ([@manidlou](https://github.com/manidlou))
- `copy()` and `copySync()`'s `filter` option now gets the destination path passed as the second parameter. [#366](https://github.com/jprichardson/node-fs-extra/pull/366) ([@manidlou](https://github.com/manidlou))
### Changed
- Use `Buffer.alloc()` instead of deprecated `new Buffer()` in `copySync()`. [#380](https://github.com/jprichardson/node-fs-extra/pull/380) ([@manidlou](https://github.com/manidlou))
- Refactored entire codebase to use ES6 features supported by Node.js v4+ [#355](https://github.com/jprichardson/node-fs-extra/issues/355). [(@JPeer264)](https://github.com/JPeer264)
- Refactored docs. ([@manidlou](https://github.com/manidlou))
### Fixed
- `move()` shouldn't error out when source and dest are the same. [#377](https://github.com/jprichardson/node-fs-extra/issues/377), [#378](https://github.com/jprichardson/node-fs-extra/pull/378) ([@jdalton](https://github.com/jdalton))
2.0.0 / 2017-01-16
------------------
### Removed
- **BREAKING:** Removed support for Node `v0.12`. The Node foundation stopped officially supporting it
on Jan 1st, 2017.
- **BREAKING:** Remove `walk()` and `walkSync()`. `walkSync()` was only part of `fs-extra` for a little
over two months. Use [klaw](https://github.com/jprichardson/node-klaw) instead of `walk()`, in fact, `walk()` was just
an alias to klaw. For `walkSync()` use [klaw-sync](https://github.com/mawni/node-klaw-sync). See: [#338], [#339]
### Changed
- **BREAKING:** Renamed `clobber` to `overwrite`. This affects `copy()`, `copySync()`, and `move()`. [#330], [#333]
- Moved docs, to `docs/`. [#340]
### Fixed
- Apply filters to directories in `copySync()` like in `copy()`. [#324]
- A specific condition when disk is under heavy use, `copy()` can fail. [#326]
1.0.0 / 2016-11-01
------------------
After five years of development, we finally have reach the 1.0.0 milestone! Big thanks goes
to [Ryan Zim](https://github.com/RyanZim) for leading the charge on this release!
### Added
- `walkSync()`
### Changed
- **BREAKING**: dropped Node v0.10 support.
- disabled `rimaf` globbing, wasn't used. [#280]
- deprecate `copy()/copySync()` option `filter` if it's a `RegExp`. `filter` should now be a function.
- inline `rimraf`. This is temporary and was done because `rimraf` depended upon the beefy `glob` which `fs-extra` does not use. [#300]
### Fixed
- bug fix proper closing of file handle on `utimesMillis()` [#271]
- proper escaping of files with dollar signs [#291]
- `copySync()` failed if user didn't own file. [#199], [#301]
0.30.0 / 2016-04-28
-------------------
- Brought back Node v0.10 support. I didn't realize there was still demand. Official support will end **2016-10-01**.
0.29.0 / 2016-04-27
-------------------
- **BREAKING**: removed support for Node v0.10. If you still want to use Node v0.10, everything should work except for `ensureLink()/ensureSymlink()`. Node v0.12 is still supported but will be dropped in the near future as well.
0.28.0 / 2016-04-17
-------------------
- **BREAKING**: removed `createOutputStream()`. Use https://www.npmjs.com/package/create-output-stream. See: [#192][#192]
- `mkdirs()/mkdirsSync()` check for invalid win32 path chars. See: [#209][#209], [#237][#237]
- `mkdirs()/mkdirsSync()` if drive not mounted, error. See: [#93][#93]
0.27.0 / 2016-04-15
-------------------
- add `dereference` option to `copySync()`. [#235][#235]
0.26.7 / 2016-03-16
-------------------
- fixed `copy()` if source and dest are the same. [#230][#230]
0.26.6 / 2016-03-15
-------------------
- fixed if `emptyDir()` does not have a callback: [#229][#229]
0.26.5 / 2016-01-27
-------------------
- `copy()` with two arguments (w/o callback) was broken. See: [#215][#215]
0.26.4 / 2016-01-05
-------------------
- `copySync()` made `preserveTimestamps` default consistent with `copy()` which is `false`. See: [#208][#208]
0.26.3 / 2015-12-17
-------------------
- fixed `copy()` hangup in copying blockDevice / characterDevice / `/dev/null`. See: [#193][#193]
0.26.2 / 2015-11-02
-------------------
- fixed `outputJson{Sync}()` spacing adherence to `fs.spaces`
0.26.1 / 2015-11-02
-------------------
- fixed `copySync()` when `clogger=true` and the destination is read only. See: [#190][#190]
0.26.0 / 2015-10-25
-------------------
- extracted the `walk()` function into its own module [`klaw`](https://github.com/jprichardson/node-klaw).
0.25.0 / 2015-10-24
-------------------
- now has a file walker `walk()`
0.24.0 / 2015-08-28
-------------------
- removed alias `delete()` and `deleteSync()`. See: [#171][#171]
0.23.1 / 2015-08-07
-------------------
- Better handling of errors for `move()` when moving across devices. [#170][#170]
- `ensureSymlink()` and `ensureLink()` should not throw errors if link exists. [#169][#169]
0.23.0 / 2015-08-06
-------------------
- added `ensureLink{Sync}()` and `ensureSymlink{Sync}()`. See: [#165][#165]
0.22.1 / 2015-07-09
-------------------
- Prevent calling `hasMillisResSync()` on module load. See: [#149][#149].
Fixes regression that was introduced in `0.21.0`.
0.22.0 / 2015-07-09
-------------------
- preserve permissions / ownership in `copy()`. See: [#54][#54]
0.21.0 / 2015-07-04
-------------------
- add option to preserve timestamps in `copy()` and `copySync()`. See: [#141][#141]
- updated `graceful-fs@3.x` to `4.x`. This brings in features from `amazing-graceful-fs` (much cleaner code / less hacks)
0.20.1 / 2015-06-23
-------------------
- fixed regression caused by latest jsonfile update: See: https://github.com/jprichardson/node-jsonfile/issues/26
0.20.0 / 2015-06-19
-------------------
- removed `jsonfile` aliases with `File` in the name, they weren't documented and probably weren't in use e.g.
this package had both `fs.readJsonFile` and `fs.readJson` that were aliases to each other, now use `fs.readJson`.
- preliminary walker created. Intentionally not documented. If you use it, it will almost certainly change and break your code.
- started moving tests inline
- upgraded to `jsonfile@2.1.0`, can now pass JSON revivers/replacers to `readJson()`, `writeJson()`, `outputJson()`
0.19.0 / 2015-06-08
-------------------
- `fs.copy()` had support for Node v0.8, dropped support
0.18.4 / 2015-05-22
-------------------
- fixed license field according to this: [#136][#136] and https://github.com/npm/npm/releases/tag/v2.10.0
0.18.3 / 2015-05-08
-------------------
- bugfix: handle `EEXIST` when clobbering on some Linux systems. [#134][#134]
0.18.2 / 2015-04-17
-------------------
- bugfix: allow `F_OK` ([#120][#120])
0.18.1 / 2015-04-15
-------------------
- improved windows support for `move()` a bit. https://github.com/jprichardson/node-fs-extra/commit/92838980f25dc2ee4ec46b43ee14d3c4a1d30c1b
- fixed a lot of tests for Windows (appveyor)
0.18.0 / 2015-03-31
-------------------
- added `emptyDir()` and `emptyDirSync()`
0.17.0 / 2015-03-28
-------------------
- `copySync` added `clobber` option (before always would clobber, now if `clobber` is `false` it throws an error if the destination exists).
**Only works with files at the moment.**
- `createOutputStream()` added. See: [#118][#118]
0.16.5 / 2015-03-08
-------------------
- fixed `fs.move` when `clobber` is `true` and destination is a directory, it should clobber. [#114][#114]
0.16.4 / 2015-03-01
-------------------
- `fs.mkdirs` fix infinite loop on Windows. See: See https://github.com/substack/node-mkdirp/pull/74 and https://github.com/substack/node-mkdirp/issues/66
0.16.3 / 2015-01-28
-------------------
- reverted https://github.com/jprichardson/node-fs-extra/commit/1ee77c8a805eba5b99382a2591ff99667847c9c9
0.16.2 / 2015-01-28
-------------------
- fixed `fs.copy` for Node v0.8 (support is temporary and will be removed in the near future)
0.16.1 / 2015-01-28
-------------------
- if `setImmediate` is not available, fall back to `process.nextTick`
0.16.0 / 2015-01-28
-------------------
- bugfix `fs.move()` into itself. Closes [#104]
- bugfix `fs.move()` moving directory across device. Closes [#108]
- added coveralls support
- bugfix: nasty multiple callback `fs.copy()` bug. Closes [#98]
- misc fs.copy code cleanups
0.15.0 / 2015-01-21
-------------------
- dropped `ncp`, imported code in
- because of previous, now supports `io.js`
- `graceful-fs` is now a dependency
0.14.0 / 2015-01-05
-------------------
- changed `copy`/`copySync` from `fs.copy(src, dest, [filters], callback)` to `fs.copy(src, dest, [options], callback)` [#100][#100]
- removed mockfs tests for mkdirp (this may be temporary, but was getting in the way of other tests)
0.13.0 / 2014-12-10
-------------------
- removed `touch` and `touchSync` methods (they didn't handle permissions like UNIX touch)
- updated `"ncp": "^0.6.0"` to `"ncp": "^1.0.1"`
- imported `mkdirp` => `minimist` and `mkdirp` are no longer dependences, should now appease people who wanted `mkdirp` to be `--use_strict` safe. See [#59]([#59][#59])
0.12.0 / 2014-09-22
-------------------
- copy symlinks in `copySync()` [#85][#85]
0.11.1 / 2014-09-02
-------------------
- bugfix `copySync()` preserve file permissions [#80][#80]
0.11.0 / 2014-08-11
-------------------
- upgraded `"ncp": "^0.5.1"` to `"ncp": "^0.6.0"`
- upgrade `jsonfile": "^1.2.0"` to `jsonfile": "^2.0.0"` => on write, json files now have `\n` at end. Also adds `options.throws` to `readJsonSync()`
see https://github.com/jprichardson/node-jsonfile#readfilesyncfilename-options for more details.
0.10.0 / 2014-06-29
------------------
* bugfix: upgaded `"jsonfile": "~1.1.0"` to `"jsonfile": "^1.2.0"`, bumped minor because of `jsonfile` dep change
from `~` to `^`. [#67]
0.9.1 / 2014-05-22
------------------
* removed Node.js `0.8.x` support, `0.9.0` was published moments ago and should have been done there
0.9.0 / 2014-05-22
------------------
* upgraded `ncp` from `~0.4.2` to `^0.5.1`, [#58]
* upgraded `rimraf` from `~2.2.6` to `^2.2.8`
* upgraded `mkdirp` from `0.3.x` to `^0.5.0`
* added methods `ensureFile()`, `ensureFileSync()`
* added methods `ensureDir()`, `ensureDirSync()` [#31]
* added `move()` method. From: https://github.com/andrewrk/node-mv
0.8.1 / 2013-10-24
------------------
* copy failed to return an error to the callback if a file doesn't exist (ulikoehler [#38], [#39])
0.8.0 / 2013-10-14
------------------
* `filter` implemented on `copy()` and `copySync()`. (Srirangan / [#36])
0.7.1 / 2013-10-12
------------------
* `copySync()` implemented (Srirangan / [#33])
* updated to the latest `jsonfile` version `1.1.0` which gives `options` params for the JSON methods. Closes [#32]
0.7.0 / 2013-10-07
------------------
* update readme conventions
* `copy()` now works if destination directory does not exist. Closes [#29]
0.6.4 / 2013-09-05
------------------
* changed `homepage` field in package.json to remove NPM warning
0.6.3 / 2013-06-28
------------------
* changed JSON spacing default from `4` to `2` to follow Node conventions
* updated `jsonfile` dep
* updated `rimraf` dep
0.6.2 / 2013-06-28
------------------
* added .npmignore, [#25]
0.6.1 / 2013-05-14
------------------
* modified for `strict` mode, closes [#24]
* added `outputJson()/outputJsonSync()`, closes [#23]
0.6.0 / 2013-03-18
------------------
* removed node 0.6 support
* added node 0.10 support
* upgraded to latest `ncp` and `rimraf`.
* optional `graceful-fs` support. Closes [#17]
0.5.0 / 2013-02-03
------------------
* Removed `readTextFile`.
* Renamed `readJSONFile` to `readJSON` and `readJson`, same with write.
* Restructured documentation a bit. Added roadmap.
0.4.0 / 2013-01-28
------------------
* Set default spaces in `jsonfile` from 4 to 2.
* Updated `testutil` deps for tests.
* Renamed `touch()` to `createFile()`
* Added `outputFile()` and `outputFileSync()`
* Changed creation of testing diretories so the /tmp dir is not littered.
* Added `readTextFile()` and `readTextFileSync()`.
0.3.2 / 2012-11-01
------------------
* Added `touch()` and `touchSync()` methods.
0.3.1 / 2012-10-11
------------------
* Fixed some stray globals.
0.3.0 / 2012-10-09
------------------
* Removed all CoffeeScript from tests.
* Renamed `mkdir` to `mkdirs`/`mkdirp`.
0.2.1 / 2012-09-11
------------------
* Updated `rimraf` dep.
0.2.0 / 2012-09-10
------------------
* Rewrote module into JavaScript. (Must still rewrite tests into JavaScript)
* Added all methods of [jsonfile](https://github.com/jprichardson/node-jsonfile)
* Added Travis-CI.
0.1.3 / 2012-08-13
------------------
* Added method `readJSONFile`.
0.1.2 / 2012-06-15
------------------
* Bug fix: `deleteSync()` didn't exist.
* Verified Node v0.8 compatibility.
0.1.1 / 2012-06-15
------------------
* Fixed bug in `remove()`/`delete()` that wouldn't execute the function if a callback wasn't passed.
0.1.0 / 2012-05-31
------------------
* Renamed `copyFile()` to `copy()`. `copy()` can now copy directories (recursively) too.
* Renamed `rmrf()` to `remove()`.
* `remove()` aliased with `delete()`.
* Added `mkdirp` capabilities. Named: `mkdir()`. Hides Node.js native `mkdir()`.
* Instead of exporting the native `fs` module with new functions, I now copy over the native methods to a new object and export that instead.
0.0.4 / 2012-03-14
------------------
* Removed CoffeeScript dependency
0.0.3 / 2012-01-11
------------------
* Added methods rmrf and rmrfSync
* Moved tests from Jasmine to Mocha
[#344]: https://github.com/jprichardson/node-fs-extra/issues/344 "Licence Year"
[#343]: https://github.com/jprichardson/node-fs-extra/pull/343 "Add klaw-sync link to readme"
[#342]: https://github.com/jprichardson/node-fs-extra/pull/342 "allow preserveTimestamps when use move"
[#341]: https://github.com/jprichardson/node-fs-extra/issues/341 "mkdirp(path.dirname(dest) in move() logic needs cleaning up [question]"
[#340]: https://github.com/jprichardson/node-fs-extra/pull/340 "Move docs to seperate docs folder [documentation]"
[#339]: https://github.com/jprichardson/node-fs-extra/pull/339 "Remove walk() & walkSync() [feature-walk]"
[#338]: https://github.com/jprichardson/node-fs-extra/issues/338 "Remove walk() and walkSync() [feature-walk]"
[#337]: https://github.com/jprichardson/node-fs-extra/issues/337 "copy doesn't return a yieldable value"
[#336]: https://github.com/jprichardson/node-fs-extra/pull/336 "Docs enhanced walk sync [documentation, feature-walk]"
[#335]: https://github.com/jprichardson/node-fs-extra/pull/335 "Refactor move() tests [feature-move]"
[#334]: https://github.com/jprichardson/node-fs-extra/pull/334 "Cleanup lib/move/index.js [feature-move]"
[#333]: https://github.com/jprichardson/node-fs-extra/pull/333 "Rename clobber to overwrite [feature-copy, feature-move]"
[#332]: https://github.com/jprichardson/node-fs-extra/pull/332 "BREAKING: Drop Node v0.12 & io.js support"
[#331]: https://github.com/jprichardson/node-fs-extra/issues/331 "Add support for chmodr [enhancement, future]"
[#330]: https://github.com/jprichardson/node-fs-extra/pull/330 "BREAKING: Do not error when copy destination exists & clobber: false [feature-copy]"
[#329]: https://github.com/jprichardson/node-fs-extra/issues/329 "Does .walk() scale to large directories? [question]"
[#328]: https://github.com/jprichardson/node-fs-extra/issues/328 "Copying files corrupts [feature-copy, needs-confirmed]"
[#327]: https://github.com/jprichardson/node-fs-extra/pull/327 "Use writeStream 'finish' event instead of 'close' [bug, feature-copy]"
[#326]: https://github.com/jprichardson/node-fs-extra/issues/326 "fs.copy fails with chmod error when disk under heavy use [bug, feature-copy]"
[#325]: https://github.com/jprichardson/node-fs-extra/issues/325 "ensureDir is difficult to promisify [enhancement]"
[#324]: https://github.com/jprichardson/node-fs-extra/pull/324 "copySync() should apply filter to directories like copy() [bug, feature-copy]"
[#323]: https://github.com/jprichardson/node-fs-extra/issues/323 "Support for `dest` being a directory when using `copy*()`?"
[#322]: https://github.com/jprichardson/node-fs-extra/pull/322 "Add fs-promise as fs-extra-promise alternative"
[#321]: https://github.com/jprichardson/node-fs-extra/issues/321 "fs.copy() with clobber set to false return EEXIST error [feature-copy]"
[#320]: https://github.com/jprichardson/node-fs-extra/issues/320 "fs.copySync: Error: EPERM: operation not permitted, unlink "
[#319]: https://github.com/jprichardson/node-fs-extra/issues/319 "Create directory if not exists"
[#318]: https://github.com/jprichardson/node-fs-extra/issues/318 "Support glob patterns [enhancement, future]"
[#317]: https://github.com/jprichardson/node-fs-extra/pull/317 "Adding copy sync test for src file without write perms"
[#316]: https://github.com/jprichardson/node-fs-extra/pull/316 "Remove move()'s broken limit option [feature-move]"
[#315]: https://github.com/jprichardson/node-fs-extra/pull/315 "Fix move clobber tests to work around graceful-fs bug."
[#314]: https://github.com/jprichardson/node-fs-extra/issues/314 "move() limit option [documentation, enhancement, feature-move]"
[#313]: https://github.com/jprichardson/node-fs-extra/pull/313 "Test that remove() ignores glob characters."
[#312]: https://github.com/jprichardson/node-fs-extra/pull/312 "Enhance walkSync() to return items with path and stats [feature-walk]"
[#311]: https://github.com/jprichardson/node-fs-extra/issues/311 "move() not work when dest name not provided [feature-move]"
[#310]: https://github.com/jprichardson/node-fs-extra/issues/310 "Edit walkSync to return items like what walk emits [documentation, enhancement, feature-walk]"
[#309]: https://github.com/jprichardson/node-fs-extra/issues/309 "moveSync support [enhancement, feature-move]"
[#308]: https://github.com/jprichardson/node-fs-extra/pull/308 "Fix incorrect anchor link"
[#307]: https://github.com/jprichardson/node-fs-extra/pull/307 "Fix coverage"
[#306]: https://github.com/jprichardson/node-fs-extra/pull/306 "Update devDeps, fix lint error"
[#305]: https://github.com/jprichardson/node-fs-extra/pull/305 "Re-add Coveralls"
[#304]: https://github.com/jprichardson/node-fs-extra/pull/304 "Remove path-is-absolute [enhancement]"
[#303]: https://github.com/jprichardson/node-fs-extra/pull/303 "Document copySync filter inconsistency [documentation, feature-copy]"
[#302]: https://github.com/jprichardson/node-fs-extra/pull/302 "fix(console): depreciated -> deprecated"
[#301]: https://github.com/jprichardson/node-fs-extra/pull/301 "Remove chmod call from copySync [feature-copy]"
[#300]: https://github.com/jprichardson/node-fs-extra/pull/300 "Inline Rimraf [enhancement, feature-move, feature-remove]"
[#299]: https://github.com/jprichardson/node-fs-extra/pull/299 "Warn when filter is a RegExp [feature-copy]"
[#298]: https://github.com/jprichardson/node-fs-extra/issues/298 "API Docs [documentation]"
[#297]: https://github.com/jprichardson/node-fs-extra/pull/297 "Warn about using preserveTimestamps on 32-bit node"
[#296]: https://github.com/jprichardson/node-fs-extra/pull/296 "Improve EEXIST error message for copySync [enhancement]"
[#295]: https://github.com/jprichardson/node-fs-extra/pull/295 "Depreciate using regular expressions for copy's filter option [documentation]"
[#294]: https://github.com/jprichardson/node-fs-extra/pull/294 "BREAKING: Refactor lib/copy/ncp.js [feature-copy]"
[#293]: https://github.com/jprichardson/node-fs-extra/pull/293 "Update CI configs"
[#292]: https://github.com/jprichardson/node-fs-extra/issues/292 "Rewrite lib/copy/ncp.js [enhancement, feature-copy]"
[#291]: https://github.com/jprichardson/node-fs-extra/pull/291 "Escape '$' in replacement string for async file copying"
[#290]: https://github.com/jprichardson/node-fs-extra/issues/290 "Exclude files pattern while copying using copy.config.js [question]"
[#289]: https://github.com/jprichardson/node-fs-extra/pull/289 "(Closes #271) lib/util/utimes: properly close file descriptors in the event of an error"
[#288]: https://github.com/jprichardson/node-fs-extra/pull/288 "(Closes #271) lib/util/utimes: properly close file descriptors in the event of an error"
[#287]: https://github.com/jprichardson/node-fs-extra/issues/287 "emptyDir() callback arguments are inconsistent [enhancement, feature-remove]"
[#286]: https://github.com/jprichardson/node-fs-extra/pull/286 "Added walkSync function"
[#285]: https://github.com/jprichardson/node-fs-extra/issues/285 "CITGM test failing on s390"
[#284]: https://github.com/jprichardson/node-fs-extra/issues/284 "outputFile method is missing a check to determine if existing item is a folder or not"
[#283]: https://github.com/jprichardson/node-fs-extra/pull/283 "Apply filter also on directories and symlinks for copySync()"
[#282]: https://github.com/jprichardson/node-fs-extra/pull/282 "Apply filter also on directories and symlinks for copySync()"
[#281]: https://github.com/jprichardson/node-fs-extra/issues/281 "remove function executes 'successfully' but doesn't do anything?"
[#280]: https://github.com/jprichardson/node-fs-extra/pull/280 "Disable rimraf globbing"
[#279]: https://github.com/jprichardson/node-fs-extra/issues/279 "Some code is vendored instead of included [awaiting-reply]"
[#278]: https://github.com/jprichardson/node-fs-extra/issues/278 "copy() does not preserve file/directory ownership"
[#277]: https://github.com/jprichardson/node-fs-extra/pull/277 "Mention defaults for clobber and dereference options"
[#276]: https://github.com/jprichardson/node-fs-extra/issues/276 "Cannot connect to Shared Folder [awaiting-reply]"
[#275]: https://github.com/jprichardson/node-fs-extra/issues/275 "EMFILE, too many open files on Mac OS with JSON API"
[#274]: https://github.com/jprichardson/node-fs-extra/issues/274 "Use with memory-fs? [enhancement, future]"
[#273]: https://github.com/jprichardson/node-fs-extra/pull/273 "tests: rename `remote.test.js` to `remove.test.js`"
[#272]: https://github.com/jprichardson/node-fs-extra/issues/272 "Copy clobber flag never err even when true [bug, feature-copy]"
[#271]: https://github.com/jprichardson/node-fs-extra/issues/271 "Unclosed file handle on futimes error"
[#270]: https://github.com/jprichardson/node-fs-extra/issues/270 "copy not working as desired on Windows [feature-copy, platform-windows]"
[#269]: https://github.com/jprichardson/node-fs-extra/issues/269 "Copying with preserveTimeStamps: true is inaccurate using 32bit node [feature-copy]"
[#268]: https://github.com/jprichardson/node-fs-extra/pull/268 "port fix for mkdirp issue #111"
[#267]: https://github.com/jprichardson/node-fs-extra/issues/267 "WARN deprecated wrench@1.5.9: wrench.js is deprecated!"
[#266]: https://github.com/jprichardson/node-fs-extra/issues/266 "fs-extra"
[#265]: https://github.com/jprichardson/node-fs-extra/issues/265 "Link the `fs.stat fs.exists` etc. methods for replace the `fs` module forever?"
[#264]: https://github.com/jprichardson/node-fs-extra/issues/264 "Renaming a file using move fails when a file inside is open (at least on windows) [wont-fix]"
[#263]: https://github.com/jprichardson/node-fs-extra/issues/263 "ENOSYS: function not implemented, link [needs-confirmed]"
[#262]: https://github.com/jprichardson/node-fs-extra/issues/262 "Add .exists() and .existsSync()"
[#261]: https://github.com/jprichardson/node-fs-extra/issues/261 "Cannot read property 'prototype' of undefined"
[#260]: https://github.com/jprichardson/node-fs-extra/pull/260 "use more specific path for method require"
[#259]: https://github.com/jprichardson/node-fs-extra/issues/259 "Feature Request: isEmpty"
[#258]: https://github.com/jprichardson/node-fs-extra/issues/258 "copy files does not preserve file timestamp"
[#257]: https://github.com/jprichardson/node-fs-extra/issues/257 "Copying a file on windows fails"
[#256]: https://github.com/jprichardson/node-fs-extra/pull/256 "Updated Readme "
[#255]: https://github.com/jprichardson/node-fs-extra/issues/255 "Update rimraf required version"
[#254]: https://github.com/jprichardson/node-fs-extra/issues/254 "request for readTree, readTreeSync, walkSync method"
[#253]: https://github.com/jprichardson/node-fs-extra/issues/253 "outputFile does not touch mtime when file exists"
[#252]: https://github.com/jprichardson/node-fs-extra/pull/252 "Fixing problem when copying file with no write permission"
[#251]: https://github.com/jprichardson/node-fs-extra/issues/251 "Just wanted to say thank you"
[#250]: https://github.com/jprichardson/node-fs-extra/issues/250 "`fs.remove()` not removing files (works with `rm -rf`)"
[#249]: https://github.com/jprichardson/node-fs-extra/issues/249 "Just a Question ... Remove Servers"
[#248]: https://github.com/jprichardson/node-fs-extra/issues/248 "Allow option to not preserve permissions for copy"
[#247]: https://github.com/jprichardson/node-fs-extra/issues/247 "Add TypeScript typing directly in the fs-extra package"
[#246]: https://github.com/jprichardson/node-fs-extra/issues/246 "fse.remove() && fse.removeSync() don't throw error on ENOENT file"
[#245]: https://github.com/jprichardson/node-fs-extra/issues/245 "filter for empty dir [enhancement]"
[#244]: https://github.com/jprichardson/node-fs-extra/issues/244 "copySync doesn't apply the filter to directories"
[#243]: https://github.com/jprichardson/node-fs-extra/issues/243 "Can I request fs.walk() to be synchronous?"
[#242]: https://github.com/jprichardson/node-fs-extra/issues/242 "Accidentally truncates file names ending with $$ [bug, feature-copy]"
[#241]: https://github.com/jprichardson/node-fs-extra/pull/241 "Remove link to createOutputStream"
[#240]: https://github.com/jprichardson/node-fs-extra/issues/240 "walkSync request"
[#239]: https://github.com/jprichardson/node-fs-extra/issues/239 "Depreciate regular expressions for copy's filter [documentation, feature-copy]"
[#238]: https://github.com/jprichardson/node-fs-extra/issues/238 "Can't write to files while in a worker thread."
[#237]: https://github.com/jprichardson/node-fs-extra/issues/237 ".ensureDir(..) fails silently when passed an invalid path..."
[#236]: https://github.com/jprichardson/node-fs-extra/issues/236 "[Removed] Filed under wrong repo"
[#235]: https://github.com/jprichardson/node-fs-extra/pull/235 "Adds symlink dereference option to `fse.copySync` (#191)"
[#234]: https://github.com/jprichardson/node-fs-extra/issues/234 "ensureDirSync fails silent when EACCES: permission denied on travis-ci"
[#233]: https://github.com/jprichardson/node-fs-extra/issues/233 "please make sure the first argument in callback is error object [feature-copy]"
[#232]: https://github.com/jprichardson/node-fs-extra/issues/232 "Copy a folder content to its child folder. "
[#231]: https://github.com/jprichardson/node-fs-extra/issues/231 "Adding read/write/output functions for YAML"
[#230]: https://github.com/jprichardson/node-fs-extra/pull/230 "throw error if src and dest are the same to avoid zeroing out + test"
[#229]: https://github.com/jprichardson/node-fs-extra/pull/229 "fix 'TypeError: callback is not a function' in emptyDir"
[#228]: https://github.com/jprichardson/node-fs-extra/pull/228 "Throw error when target is empty so file is not accidentally zeroed out"
[#227]: https://github.com/jprichardson/node-fs-extra/issues/227 "Uncatchable errors when there are invalid arguments [feature-move]"
[#226]: https://github.com/jprichardson/node-fs-extra/issues/226 "Moving to the current directory"
[#225]: https://github.com/jprichardson/node-fs-extra/issues/225 "EBUSY: resource busy or locked, unlink"
[#224]: https://github.com/jprichardson/node-fs-extra/issues/224 "fse.copy ENOENT error"
[#223]: https://github.com/jprichardson/node-fs-extra/issues/223 "Suspicious behavior of fs.existsSync"
[#222]: https://github.com/jprichardson/node-fs-extra/pull/222 "A clearer description of emtpyDir function"
[#221]: https://github.com/jprichardson/node-fs-extra/pull/221 "Update README.md"
[#220]: https://github.com/jprichardson/node-fs-extra/pull/220 "Non-breaking feature: add option 'passStats' to copy methods."
[#219]: https://github.com/jprichardson/node-fs-extra/pull/219 "Add closing parenthesis in copySync example"
[#218]: https://github.com/jprichardson/node-fs-extra/pull/218 "fix #187 #70 options.filter bug"
[#217]: https://github.com/jprichardson/node-fs-extra/pull/217 "fix #187 #70 options.filter bug"
[#216]: https://github.com/jprichardson/node-fs-extra/pull/216 "fix #187 #70 options.filter bug"
[#215]: https://github.com/jprichardson/node-fs-extra/pull/215 "fse.copy throws error when only src and dest provided [bug, documentation, feature-copy]"
[#214]: https://github.com/jprichardson/node-fs-extra/pull/214 "Fixing copySync anchor tag"
[#213]: https://github.com/jprichardson/node-fs-extra/issues/213 "Merge extfs with this repo"
[#212]: https://github.com/jprichardson/node-fs-extra/pull/212 "Update year to 2016 in README.md and LICENSE"
[#211]: https://github.com/jprichardson/node-fs-extra/issues/211 "Not copying all files"
[#210]: https://github.com/jprichardson/node-fs-extra/issues/210 "copy/copySync behave differently when copying a symbolic file [bug, documentation, feature-copy]"
[#209]: https://github.com/jprichardson/node-fs-extra/issues/209 "In Windows invalid directory name causes infinite loop in ensureDir(). [bug]"
[#208]: https://github.com/jprichardson/node-fs-extra/pull/208 "fix options.preserveTimestamps to false in copy-sync by default [feature-copy]"
[#207]: https://github.com/jprichardson/node-fs-extra/issues/207 "Add `compare` suite of functions"
[#206]: https://github.com/jprichardson/node-fs-extra/issues/206 "outputFileSync"
[#205]: https://github.com/jprichardson/node-fs-extra/issues/205 "fix documents about copy/copySync [documentation, feature-copy]"
[#204]: https://github.com/jprichardson/node-fs-extra/pull/204 "allow copy of block and character device files"
[#203]: https://github.com/jprichardson/node-fs-extra/issues/203 "copy method's argument options couldn't be undefined [bug, feature-copy]"
[#202]: https://github.com/jprichardson/node-fs-extra/issues/202 "why there is not a walkSync method?"
[#201]: https://github.com/jprichardson/node-fs-extra/issues/201 "clobber for directories [feature-copy, future]"
[#200]: https://github.com/jprichardson/node-fs-extra/issues/200 "'copySync' doesn't work in sync"
[#199]: https://github.com/jprichardson/node-fs-extra/issues/199 "fs.copySync fails if user does not own file [bug, feature-copy]"
[#198]: https://github.com/jprichardson/node-fs-extra/issues/198 "handle copying between identical files [feature-copy]"
[#197]: https://github.com/jprichardson/node-fs-extra/issues/197 "Missing documentation for `outputFile` `options` 3rd parameter [documentation]"
[#196]: https://github.com/jprichardson/node-fs-extra/issues/196 "copy filter: async function and/or function called with `fs.stat` result [future]"
[#195]: https://github.com/jprichardson/node-fs-extra/issues/195 "How to override with outputFile?"
[#194]: https://github.com/jprichardson/node-fs-extra/pull/194 "allow ensureFile(Sync) to provide data to be written to created file"
[#193]: https://github.com/jprichardson/node-fs-extra/issues/193 "`fs.copy` fails silently if source file is /dev/null [bug, feature-copy]"
[#192]: https://github.com/jprichardson/node-fs-extra/issues/192 "Remove fs.createOutputStream()"
[#191]: https://github.com/jprichardson/node-fs-extra/issues/191 "How to copy symlinks to target as normal folders [feature-copy]"
[#190]: https://github.com/jprichardson/node-fs-extra/pull/190 "copySync to overwrite destination file if readonly and clobber true"
[#189]: https://github.com/jprichardson/node-fs-extra/pull/189 "move.test fix to support CRLF on Windows"
[#188]: https://github.com/jprichardson/node-fs-extra/issues/188 "move.test failing on windows platform"
[#187]: https://github.com/jprichardson/node-fs-extra/issues/187 "Not filter each file, stops on first false [feature-copy]"
[#186]: https://github.com/jprichardson/node-fs-extra/issues/186 "Do you need a .size() function in this module? [future]"
[#185]: https://github.com/jprichardson/node-fs-extra/issues/185 "Doesn't work on NodeJS v4.x"
[#184]: https://github.com/jprichardson/node-fs-extra/issues/184 "CLI equivalent for fs-extra"
[#183]: https://github.com/jprichardson/node-fs-extra/issues/183 "with clobber true, copy and copySync behave differently if destination file is read only [bug, feature-copy]"
[#182]: https://github.com/jprichardson/node-fs-extra/issues/182 "ensureDir(dir, callback) second callback parameter not specified"
[#181]: https://github.com/jprichardson/node-fs-extra/issues/181 "Add ability to remove file securely [enhancement, wont-fix]"
[#180]: https://github.com/jprichardson/node-fs-extra/issues/180 "Filter option doesn't work the same way in copy and copySync [bug, feature-copy]"
[#179]: https://github.com/jprichardson/node-fs-extra/issues/179 "Include opendir"
[#178]: https://github.com/jprichardson/node-fs-extra/issues/178 "ENOTEMPTY is thrown on removeSync "
[#177]: https://github.com/jprichardson/node-fs-extra/issues/177 "fix `remove()` wildcards (introduced by rimraf) [feature-remove]"
[#176]: https://github.com/jprichardson/node-fs-extra/issues/176 "createOutputStream doesn't emit 'end' event"
[#175]: https://github.com/jprichardson/node-fs-extra/issues/175 "[Feature Request].moveSync support [feature-move, future]"
[#174]: https://github.com/jprichardson/node-fs-extra/pull/174 "Fix copy formatting and document options.filter"
[#173]: https://github.com/jprichardson/node-fs-extra/issues/173 "Feature Request: writeJson should mkdirs"
[#172]: https://github.com/jprichardson/node-fs-extra/issues/172 "rename `clobber` flags to `overwrite`"
[#171]: https://github.com/jprichardson/node-fs-extra/issues/171 "remove unnecessary aliases"
[#170]: https://github.com/jprichardson/node-fs-extra/pull/170 "More robust handling of errors moving across virtual drives"
[#169]: https://github.com/jprichardson/node-fs-extra/pull/169 "suppress ensureLink & ensureSymlink dest exists error"
[#168]: https://github.com/jprichardson/node-fs-extra/pull/168 "suppress ensurelink dest exists error"
[#167]: https://github.com/jprichardson/node-fs-extra/pull/167 "Adds basic (string, buffer) support for ensureFile content [future]"
[#166]: https://github.com/jprichardson/node-fs-extra/pull/166 "Adds basic (string, buffer) support for ensureFile content"
[#165]: https://github.com/jprichardson/node-fs-extra/pull/165 "ensure for link & symlink"
[#164]: https://github.com/jprichardson/node-fs-extra/issues/164 "Feature Request: ensureFile to take optional argument for file content"
[#163]: https://github.com/jprichardson/node-fs-extra/issues/163 "ouputJson not formatted out of the box [bug]"
[#162]: https://github.com/jprichardson/node-fs-extra/pull/162 "ensure symlink & link"
[#161]: https://github.com/jprichardson/node-fs-extra/pull/161 "ensure symlink & link"
[#160]: https://github.com/jprichardson/node-fs-extra/pull/160 "ensure symlink & link"
[#159]: https://github.com/jprichardson/node-fs-extra/pull/159 "ensure symlink & link"
[#158]: https://github.com/jprichardson/node-fs-extra/issues/158 "Feature Request: ensureLink and ensureSymlink methods"
[#157]: https://github.com/jprichardson/node-fs-extra/issues/157 "writeJson isn't formatted"
[#156]: https://github.com/jprichardson/node-fs-extra/issues/156 "Promise.promisifyAll doesn't work for some methods"
[#155]: https://github.com/jprichardson/node-fs-extra/issues/155 "Readme"
[#154]: https://github.com/jprichardson/node-fs-extra/issues/154 "/tmp/millis-test-sync"
[#153]: https://github.com/jprichardson/node-fs-extra/pull/153 "Make preserveTimes also work on read-only files. Closes #152"
[#152]: https://github.com/jprichardson/node-fs-extra/issues/152 "fs.copy fails for read-only files with preserveTimestamp=true [feature-copy]"
[#151]: https://github.com/jprichardson/node-fs-extra/issues/151 "TOC does not work correctly on npm [documentation]"
[#150]: https://github.com/jprichardson/node-fs-extra/issues/150 "Remove test file fixtures, create with code."
[#149]: https://github.com/jprichardson/node-fs-extra/issues/149 "/tmp/millis-test-sync"
[#148]: https://github.com/jprichardson/node-fs-extra/issues/148 "split out `Sync` methods in documentation"
[#147]: https://github.com/jprichardson/node-fs-extra/issues/147 "Adding rmdirIfEmpty"
[#146]: https://github.com/jprichardson/node-fs-extra/pull/146 "ensure test.js works"
[#145]: https://github.com/jprichardson/node-fs-extra/issues/145 "Add `fs.exists` and `fs.existsSync` if it doesn't exist."
[#144]: https://github.com/jprichardson/node-fs-extra/issues/144 "tests failing"
[#143]: https://github.com/jprichardson/node-fs-extra/issues/143 "update graceful-fs"
[#142]: https://github.com/jprichardson/node-fs-extra/issues/142 "PrependFile Feature"
[#141]: https://github.com/jprichardson/node-fs-extra/pull/141 "Add option to preserve timestamps"
[#140]: https://github.com/jprichardson/node-fs-extra/issues/140 "Json file reading fails with 'utf8'"
[#139]: https://github.com/jprichardson/node-fs-extra/pull/139 "Preserve file timestamp on copy. Closes #138"
[#138]: https://github.com/jprichardson/node-fs-extra/issues/138 "Preserve timestamps on copying files"
[#137]: https://github.com/jprichardson/node-fs-extra/issues/137 "outputFile/outputJson: Unexpected end of input"
[#136]: https://github.com/jprichardson/node-fs-extra/pull/136 "Update license attribute"
[#135]: https://github.com/jprichardson/node-fs-extra/issues/135 "emptyDir throws Error if no callback is provided"
[#134]: https://github.com/jprichardson/node-fs-extra/pull/134 "Handle EEXIST error when clobbering dir"
[#133]: https://github.com/jprichardson/node-fs-extra/pull/133 "Travis runs with `sudo: false`"
[#132]: https://github.com/jprichardson/node-fs-extra/pull/132 "isDirectory method"
[#131]: https://github.com/jprichardson/node-fs-extra/issues/131 "copySync is not working iojs 1.8.4 on linux [feature-copy]"
[#130]: https://github.com/jprichardson/node-fs-extra/pull/130 "Please review additional features."
[#129]: https://github.com/jprichardson/node-fs-extra/pull/129 "can you review this feature?"
[#128]: https://github.com/jprichardson/node-fs-extra/issues/128 "fsExtra.move(filepath, newPath) broken;"
[#127]: https://github.com/jprichardson/node-fs-extra/issues/127 "consider using fs.access to remove deprecated warnings for fs.exists"
[#126]: https://github.com/jprichardson/node-fs-extra/issues/126 " TypeError: Object #<Object> has no method 'access'"
[#125]: https://github.com/jprichardson/node-fs-extra/issues/125 "Question: What do the *Sync function do different from non-sync"
[#124]: https://github.com/jprichardson/node-fs-extra/issues/124 "move with clobber option 'ENOTEMPTY'"
[#123]: https://github.com/jprichardson/node-fs-extra/issues/123 "Only copy the content of a directory"
[#122]: https://github.com/jprichardson/node-fs-extra/pull/122 "Update section links in README to match current section ids."
[#121]: https://github.com/jprichardson/node-fs-extra/issues/121 "emptyDir is undefined"
[#120]: https://github.com/jprichardson/node-fs-extra/issues/120 "usage bug caused by shallow cloning methods of 'graceful-fs'"
[#119]: https://github.com/jprichardson/node-fs-extra/issues/119 "mkdirs and ensureDir never invoke callback and consume CPU indefinitely if provided a path with invalid characters on Windows"
[#118]: https://github.com/jprichardson/node-fs-extra/pull/118 "createOutputStream"
[#117]: https://github.com/jprichardson/node-fs-extra/pull/117 "Fixed issue with slash separated paths on windows"
[#116]: https://github.com/jprichardson/node-fs-extra/issues/116 "copySync can only copy directories not files [documentation, feature-copy]"
[#115]: https://github.com/jprichardson/node-fs-extra/issues/115 ".Copy & .CopySync [feature-copy]"
[#114]: https://github.com/jprichardson/node-fs-extra/issues/114 "Fails to move (rename) directory to non-empty directory even with clobber: true"
[#113]: https://github.com/jprichardson/node-fs-extra/issues/113 "fs.copy seems to callback early if the destination file already exists"
[#112]: https://github.com/jprichardson/node-fs-extra/pull/112 "Copying a file into an existing directory"
[#111]: https://github.com/jprichardson/node-fs-extra/pull/111 "Moving a file into an existing directory "
[#110]: https://github.com/jprichardson/node-fs-extra/pull/110 "Moving a file into an existing directory"
[#109]: https://github.com/jprichardson/node-fs-extra/issues/109 "fs.move across windows drives fails"
[#108]: https://github.com/jprichardson/node-fs-extra/issues/108 "fse.move directories across multiple devices doesn't work"
[#107]: https://github.com/jprichardson/node-fs-extra/pull/107 "Check if dest path is an existing dir and copy or move source in it"
[#106]: https://github.com/jprichardson/node-fs-extra/issues/106 "fse.copySync crashes while copying across devices D: [feature-copy]"
[#105]: https://github.com/jprichardson/node-fs-extra/issues/105 "fs.copy hangs on iojs"
[#104]: https://github.com/jprichardson/node-fs-extra/issues/104 "fse.move deletes folders [bug]"
[#103]: https://github.com/jprichardson/node-fs-extra/issues/103 "Error: EMFILE with copy"
[#102]: https://github.com/jprichardson/node-fs-extra/issues/102 "touch / touchSync was removed ?"
[#101]: https://github.com/jprichardson/node-fs-extra/issues/101 "fs-extra promisified"
[#100]: https://github.com/jprichardson/node-fs-extra/pull/100 "copy: options object or filter to pass to ncp"
[#99]: https://github.com/jprichardson/node-fs-extra/issues/99 "ensureDir() modes [future]"
[#98]: https://github.com/jprichardson/node-fs-extra/issues/98 "fs.copy() incorrect async behavior [bug]"
[#97]: https://github.com/jprichardson/node-fs-extra/pull/97 "use path.join; fix copySync bug"
[#96]: https://github.com/jprichardson/node-fs-extra/issues/96 "destFolderExists in copySync is always undefined."
[#95]: https://github.com/jprichardson/node-fs-extra/pull/95 "Using graceful-ncp instead of ncp"
[#94]: https://github.com/jprichardson/node-fs-extra/issues/94 "Error: EEXIST, file already exists '../mkdirp/bin/cmd.js' on fs.copySync() [enhancement, feature-copy]"
[#93]: https://github.com/jprichardson/node-fs-extra/issues/93 "Confusing error if drive not mounted [enhancement]"
[#92]: https://github.com/jprichardson/node-fs-extra/issues/92 "Problems with Bluebird"
[#91]: https://github.com/jprichardson/node-fs-extra/issues/91 "fs.copySync('/test', '/haha') is different with 'cp -r /test /haha' [enhancement]"
[#90]: https://github.com/jprichardson/node-fs-extra/issues/90 "Folder creation and file copy is Happening in 64 bit machine but not in 32 bit machine"
[#89]: https://github.com/jprichardson/node-fs-extra/issues/89 "Error: EEXIST using fs-extra's fs.copy to copy a directory on Windows"
[#88]: https://github.com/jprichardson/node-fs-extra/issues/88 "Stacking those libraries"
[#87]: https://github.com/jprichardson/node-fs-extra/issues/87 "createWriteStream + outputFile = ?"
[#86]: https://github.com/jprichardson/node-fs-extra/issues/86 "no moveSync?"
[#85]: https://github.com/jprichardson/node-fs-extra/pull/85 "Copy symlinks in copySync"
[#84]: https://github.com/jprichardson/node-fs-extra/issues/84 "Push latest version to npm ?"
[#83]: https://github.com/jprichardson/node-fs-extra/issues/83 "Prevent copying a directory into itself [feature-copy]"
[#82]: https://github.com/jprichardson/node-fs-extra/pull/82 "README updates for move"
[#81]: https://github.com/jprichardson/node-fs-extra/issues/81 "fd leak after fs.move"
[#80]: https://github.com/jprichardson/node-fs-extra/pull/80 "Preserve file mode in copySync"
[#79]: https://github.com/jprichardson/node-fs-extra/issues/79 "fs.copy only .html file empty"
[#78]: https://github.com/jprichardson/node-fs-extra/pull/78 "copySync was not applying filters to directories"
[#77]: https://github.com/jprichardson/node-fs-extra/issues/77 "Create README reference to bluebird"
[#76]: https://github.com/jprichardson/node-fs-extra/issues/76 "Create README reference to typescript"
[#75]: https://github.com/jprichardson/node-fs-extra/issues/75 "add glob as a dep? [question]"
[#74]: https://github.com/jprichardson/node-fs-extra/pull/74 "including new emptydir module"
[#73]: https://github.com/jprichardson/node-fs-extra/pull/73 "add dependency status in readme"
[#72]: https://github.com/jprichardson/node-fs-extra/pull/72 "Use svg instead of png to get better image quality"
[#71]: https://github.com/jprichardson/node-fs-extra/issues/71 "fse.copy not working on Windows 7 x64 OS, but, copySync does work"
[#70]: https://github.com/jprichardson/node-fs-extra/issues/70 "Not filter each file, stops on first false [bug]"
[#69]: https://github.com/jprichardson/node-fs-extra/issues/69 "How to check if folder exist and read the folder name"
[#68]: https://github.com/jprichardson/node-fs-extra/issues/68 "consider flag to readJsonSync (throw false) [enhancement]"
[#67]: https://github.com/jprichardson/node-fs-extra/issues/67 "docs for readJson incorrectly states that is accepts options"
[#66]: https://github.com/jprichardson/node-fs-extra/issues/66 "ENAMETOOLONG"
[#65]: https://github.com/jprichardson/node-fs-extra/issues/65 "exclude filter in fs.copy"
[#64]: https://github.com/jprichardson/node-fs-extra/issues/64 "Announce: mfs - monitor your fs-extra calls"
[#63]: https://github.com/jprichardson/node-fs-extra/issues/63 "Walk"
[#62]: https://github.com/jprichardson/node-fs-extra/issues/62 "npm install fs-extra doesn't work"
[#61]: https://github.com/jprichardson/node-fs-extra/issues/61 "No longer supports node 0.8 due to use of `^` in package.json dependencies"
[#60]: https://github.com/jprichardson/node-fs-extra/issues/60 "chmod & chown for mkdirs"
[#59]: https://github.com/jprichardson/node-fs-extra/issues/59 "Consider including mkdirp and making fs-extra '--use_strict' safe [question]"
[#58]: https://github.com/jprichardson/node-fs-extra/issues/58 "Stack trace not included in fs.copy error"
[#57]: https://github.com/jprichardson/node-fs-extra/issues/57 "Possible to include wildcards in delete?"
[#56]: https://github.com/jprichardson/node-fs-extra/issues/56 "Crash when have no access to write to destination file in copy "
[#55]: https://github.com/jprichardson/node-fs-extra/issues/55 "Is it possible to have any console output similar to Grunt copy module?"
[#54]: https://github.com/jprichardson/node-fs-extra/issues/54 "`copy` does not preserve file ownership and permissons"
[#53]: https://github.com/jprichardson/node-fs-extra/issues/53 "outputFile() - ability to write data in appending mode"
[#52]: https://github.com/jprichardson/node-fs-extra/pull/52 "This fixes (what I think) is a bug in copySync"
[#51]: https://github.com/jprichardson/node-fs-extra/pull/51 "Add a Bitdeli Badge to README"
[#50]: https://github.com/jprichardson/node-fs-extra/issues/50 "Replace mechanism in createFile"
[#49]: https://github.com/jprichardson/node-fs-extra/pull/49 "update rimraf to v2.2.6"
[#48]: https://github.com/jprichardson/node-fs-extra/issues/48 "fs.copy issue [bug]"
[#47]: https://github.com/jprichardson/node-fs-extra/issues/47 "Bug in copy - callback called on readStream 'close' - Fixed in ncp 0.5.0"
[#46]: https://github.com/jprichardson/node-fs-extra/pull/46 "update copyright year"
[#45]: https://github.com/jprichardson/node-fs-extra/pull/45 "Added note about fse.outputFile() being the one that overwrites"
[#44]: https://github.com/jprichardson/node-fs-extra/pull/44 "Proposal: Stream support"
[#43]: https://github.com/jprichardson/node-fs-extra/issues/43 "Better error reporting "
[#42]: https://github.com/jprichardson/node-fs-extra/issues/42 "Performance issue?"
[#41]: https://github.com/jprichardson/node-fs-extra/pull/41 "There does seem to be a synchronous version now"
[#40]: https://github.com/jprichardson/node-fs-extra/issues/40 "fs.copy throw unexplained error ENOENT, utime "
[#39]: https://github.com/jprichardson/node-fs-extra/pull/39 "Added regression test for copy() return callback on error"
[#38]: https://github.com/jprichardson/node-fs-extra/pull/38 "Return err in copy() fstat cb, because stat could be undefined or null"
[#37]: https://github.com/jprichardson/node-fs-extra/issues/37 "Maybe include a line reader? [enhancement, question]"
[#36]: https://github.com/jprichardson/node-fs-extra/pull/36 "`filter` parameter `fs.copy` and `fs.copySync`"
[#35]: https://github.com/jprichardson/node-fs-extra/pull/35 "`filter` parameter `fs.copy` and `fs.copySync` "
[#34]: https://github.com/jprichardson/node-fs-extra/issues/34 "update docs to include options for JSON methods [enhancement]"
[#33]: https://github.com/jprichardson/node-fs-extra/pull/33 "fs_extra.copySync"
[#32]: https://github.com/jprichardson/node-fs-extra/issues/32 "update to latest jsonfile [enhancement]"
[#31]: https://github.com/jprichardson/node-fs-extra/issues/31 "Add ensure methods [enhancement]"
[#30]: https://github.com/jprichardson/node-fs-extra/issues/30 "update package.json optional dep `graceful-fs`"
[#29]: https://github.com/jprichardson/node-fs-extra/issues/29 "Copy failing if dest directory doesn't exist. Is this intended?"
[#28]: https://github.com/jprichardson/node-fs-extra/issues/28 "homepage field must be a string url. Deleted."
[#27]: https://github.com/jprichardson/node-fs-extra/issues/27 "Update Readme"
[#26]: https://github.com/jprichardson/node-fs-extra/issues/26 "Add readdir recursive method. [enhancement]"
[#25]: https://github.com/jprichardson/node-fs-extra/pull/25 "adding an `.npmignore` file"
[#24]: https://github.com/jprichardson/node-fs-extra/issues/24 "[bug] cannot run in strict mode [bug]"
[#23]: https://github.com/jprichardson/node-fs-extra/issues/23 "`writeJSON()` should create parent directories"
[#22]: https://github.com/jprichardson/node-fs-extra/pull/22 "Add a limit option to mkdirs()"
[#21]: https://github.com/jprichardson/node-fs-extra/issues/21 "touch() in 0.10.0"
[#20]: https://github.com/jprichardson/node-fs-extra/issues/20 "fs.remove yields callback before directory is really deleted"
[#19]: https://github.com/jprichardson/node-fs-extra/issues/19 "fs.copy err is empty array"
[#18]: https://github.com/jprichardson/node-fs-extra/pull/18 "Exposed copyFile Function"
[#17]: https://github.com/jprichardson/node-fs-extra/issues/17 "Use `require('graceful-fs')` if found instead of `require('fs')`"
[#16]: https://github.com/jprichardson/node-fs-extra/pull/16 "Update README.md"
[#15]: https://github.com/jprichardson/node-fs-extra/issues/15 "Implement cp -r but sync aka copySync. [enhancement]"
[#14]: https://github.com/jprichardson/node-fs-extra/issues/14 "fs.mkdirSync is broken in 0.3.1"
[#13]: https://github.com/jprichardson/node-fs-extra/issues/13 "Thoughts on including a directory tree / file watcher? [enhancement, question]"
[#12]: https://github.com/jprichardson/node-fs-extra/issues/12 "copyFile & copyFileSync are global"
[#11]: https://github.com/jprichardson/node-fs-extra/issues/11 "Thoughts on including a file walker? [enhancement, question]"
[#10]: https://github.com/jprichardson/node-fs-extra/issues/10 "move / moveFile API [enhancement]"
[#9]: https://github.com/jprichardson/node-fs-extra/issues/9 "don't import normal fs stuff into fs-extra"
[#8]: https://github.com/jprichardson/node-fs-extra/pull/8 "Update rimraf to latest version"
[#6]: https://github.com/jprichardson/node-fs-extra/issues/6 "Remove CoffeeScript development dependency"
[#5]: https://github.com/jprichardson/node-fs-extra/issues/5 "comments on naming"
[#4]: https://github.com/jprichardson/node-fs-extra/issues/4 "version bump to 0.2"
[#3]: https://github.com/jprichardson/node-fs-extra/pull/3 "Hi! I fixed some code for you!"
[#2]: https://github.com/jprichardson/node-fs-extra/issues/2 "Merge with fs.extra and mkdirp"
[#1]: https://github.com/jprichardson/node-fs-extra/issues/1 "file-extra npm !exist"
================================================
FILE: LICENSE
================================================
(The MIT License)
Copyright (c) 2011-2024 JP Richardson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
(the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: README.md
================================================
Node.js: fs-extra
=================
`fs-extra` adds file system methods that aren't included in the native `fs` module and adds promise support to the `fs` methods. It also uses [`graceful-fs`](https://github.com/isaacs/node-graceful-fs) to prevent `EMFILE` errors. It should be a drop in replacement for `fs`.
[](https://www.npmjs.org/package/fs-extra)
[](https://github.com/jprichardson/node-fs-extra/blob/master/LICENSE)
[](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://www.npmjs.org/package/fs-extra)
[](https://standardjs.com)
Why?
----
I got tired of including `mkdirp`, `rimraf`, and `ncp` in most of my projects.
Installation
------------
npm install fs-extra
Usage
-----
### CommonJS
`fs-extra` is a drop in replacement for native `fs`. All methods in `fs` are attached to `fs-extra`. All `fs` methods return promises if the callback isn't passed.
You don't ever need to include the original `fs` module again:
```js
const fs = require('fs') // this is no longer necessary
```
you can now do this:
```js
const fs = require('fs-extra')
```
or if you prefer to make it clear that you're using `fs-extra` and not `fs`, you may want
to name your `fs` variable `fse` like so:
```js
const fse = require('fs-extra')
```
you can also keep both, but it's redundant:
```js
const fs = require('fs')
const fse = require('fs-extra')
```
**NOTE:** The deprecated constants `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, & `fs.X_OK` are not exported on Node.js v24.0.0+; please use their `fs.constants` equivalents.
### ESM
There is also an `fs-extra/esm` import, that supports both default and named exports. However, note that `fs` methods are not included in `fs-extra/esm`; you still need to import `fs` and/or `fs/promises` seperately:
```js
import { readFileSync } from 'fs'
import { readFile } from 'fs/promises'
import { outputFile, outputFileSync } from 'fs-extra/esm'
```
Default exports are supported:
```js
import fs from 'fs'
import fse from 'fs-extra/esm'
// fse.readFileSync is not a function; must use fs.readFileSync
```
but you probably want to just use regular `fs-extra` instead of `fs-extra/esm` for default exports:
```js
import fs from 'fs-extra'
// both fs and fs-extra methods are defined
```
Sync vs Async vs Async/Await
-------------
Most methods are async by default. All async methods will return a promise if the callback isn't passed.
Sync methods on the other hand will throw if an error occurs.
Also Async/Await will throw an error if one occurs.
Example:
```js
const fs = require('fs-extra')
// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
.then(() => console.log('success!'))
.catch(err => console.error(err))
// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
if (err) return console.error(err)
console.log('success!')
})
// Sync:
try {
fs.copySync('/tmp/myfile', '/tmp/mynewfile')
console.log('success!')
} catch (err) {
console.error(err)
}
// Async/Await:
async function copyFiles () {
try {
await fs.copy('/tmp/myfile', '/tmp/mynewfile')
console.log('success!')
} catch (err) {
console.error(err)
}
}
copyFiles()
```
Methods
-------
### Async
- [copy](docs/copy.md)
- [emptyDir](docs/emptyDir.md)
- [ensureFile](docs/ensureFile.md)
- [ensureDir](docs/ensureDir.md)
- [ensureLink](docs/ensureLink.md)
- [ensureSymlink](docs/ensureSymlink.md)
- [mkdirp](docs/ensureDir.md)
- [mkdirs](docs/ensureDir.md)
- [move](docs/move.md)
- [outputFile](docs/outputFile.md)
- [outputJson](docs/outputJson.md)
- [pathExists](docs/pathExists.md)
- [readJson](docs/readJson.md)
- [remove](docs/remove.md)
- [writeJson](docs/writeJson.md)
### Sync
- [copySync](docs/copy-sync.md)
- [emptyDirSync](docs/emptyDir-sync.md)
- [ensureFileSync](docs/ensureFile-sync.md)
- [ensureDirSync](docs/ensureDir-sync.md)
- [ensureLinkSync](docs/ensureLink-sync.md)
- [ensureSymlinkSync](docs/ensureSymlink-sync.md)
- [mkdirpSync](docs/ensureDir-sync.md)
- [mkdirsSync](docs/ensureDir-sync.md)
- [moveSync](docs/move-sync.md)
- [outputFileSync](docs/outputFile-sync.md)
- [outputJsonSync](docs/outputJson-sync.md)
- [pathExistsSync](docs/pathExists-sync.md)
- [readJsonSync](docs/readJson-sync.md)
- [removeSync](docs/remove-sync.md)
- [writeJsonSync](docs/writeJson-sync.md)
**NOTE:** You can still use the native Node.js methods. They are promisified and copied over to `fs-extra`. See [notes on `fs.read()`, `fs.write()`, & `fs.writev()`](docs/fs-read-write-writev.md)
### What happened to `walk()` and `walkSync()`?
They were removed from `fs-extra` in v2.0.0. If you need the functionality, `walk` and `walkSync` are available as separate packages, [`klaw`](https://github.com/jprichardson/node-klaw) and [`klaw-sync`](https://github.com/manidlou/node-klaw-sync).
Third Party
-----------
### CLI
[fse-cli](https://www.npmjs.com/package/@atao60/fse-cli) allows you to run `fs-extra` from a console or from [npm](https://www.npmjs.com) scripts.
### TypeScript
If you like TypeScript, you can use `fs-extra` with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
### File / Directory Watching
If you want to watch for changes to files or directories, then you should use [chokidar](https://github.com/paulmillr/chokidar).
### Obtain Filesystem (Devices, Partitions) Information
[fs-filesystem](https://github.com/arthurintelligence/node-fs-filesystem) allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.
### Misc.
- [fs-extra-debug](https://github.com/jdxcode/fs-extra-debug) - Send your fs-extra calls to [debug](https://npmjs.org/package/debug).
- [mfs](https://github.com/cadorn/mfs) - Monitor your fs-extra calls.
Hacking on fs-extra
-------------------
Wanna hack on `fs-extra`? Great! Your help is needed! [fs-extra is one of the most depended upon Node.js packages](http://nodei.co/npm/fs-extra.png?downloads=true&downloadRank=true&stars=true). This project
uses [JavaScript Standard Style](https://github.com/feross/standard) - if the name or style choices bother you,
you're gonna have to get over it :) If `standard` is good enough for `npm`, it's good enough for `fs-extra`.
[](https://github.com/feross/standard)
What's needed?
- First, take a look at existing issues. Those are probably going to be where the priority lies.
- More tests for edge cases. Specifically on different platforms. There can never be enough tests.
- Improve test coverage.
Note: If you make any big changes, **you should definitely file an issue for discussion first.**
### Running the Test Suite
fs-extra contains hundreds of tests.
- `npm run lint`: runs the linter ([standard](http://standardjs.com/))
- `npm run unit`: runs the unit tests
- `npm run unit-esm`: runs tests for `fs-extra/esm` exports
- `npm test`: runs the linter and all tests
When running unit tests, set the environment variable `CROSS_DEVICE_PATH` to the absolute path of an empty directory on another device (like a thumb drive) to enable cross-device move tests.
### Windows
If you run the tests on the Windows and receive a lot of symbolic link `EPERM` permission errors, it's
because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's
account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7
However, I didn't have much luck doing this.
Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows.
I open the `Node.js command prompt` and run as `Administrator`. I then map the network drive running the following command:
net use z: "\\vmware-host\Shared Folders"
I can then navigate to my `fs-extra` directory and run the tests.
Naming
------
I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:
* https://github.com/jprichardson/node-fs-extra/issues/2
* https://github.com/flatiron/utile/issues/11
* https://github.com/ryanmcgrath/wrench-js/issues/29
* https://github.com/substack/node-mkdirp/issues/17
First, I believe that in as many cases as possible, the [Node.js naming schemes](http://nodejs.org/api/fs.html) should be chosen. However, there are problems with the Node.js own naming schemes.
For example, `fs.readFile()` and `fs.readdir()`: the **F** is capitalized in *File* and the **d** is not capitalized in *dir*. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: `fs.mkdir()`, `fs.rmdir()`, `fs.chown()`, etc.
We have a dilemma though. How do you consistently name methods that perform the following POSIX commands: `cp`, `cp -r`, `mkdir -p`, and `rm -rf`?
My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too.
So, if you want to remove a file or a directory regardless of whether it has contents, just call `fs.remove(path)`. If you want to copy a file or a directory whether it has contents, just call `fs.copy(source, destination)`. If you want to create a directory regardless of whether its parent directories exist, just call `fs.mkdirs(path)` or `fs.mkdirp(path)`.
Credit
------
`fs-extra` wouldn't be possible without using the modules from the following authors:
- [Isaac Shlueter](https://github.com/isaacs)
- [Charlie McConnel](https://github.com/avianflu)
- [James Halliday](https://github.com/substack)
- [Andrew Kelley](https://github.com/andrewrk)
License
-------
Licensed under MIT
Copyright (c) 2011-2024 [JP Richardson](https://github.com/jprichardson)
[1]: http://nodejs.org/docs/latest/api/fs.html
[jsonfile]: https://github.com/jprichardson/node-jsonfile
================================================
FILE: docs/copy-sync.md
================================================
# copySync(src, dest[, options])
Copy a file or directory. The directory can have contents.
- `src` `<String>` Note that if `src` is a directory it will copy everything inside of this directory, not the entire directory itself (see [issue #537](https://github.com/jprichardson/node-fs-extra/issues/537)).
- `dest` `<String>` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)).
- `options` `<Object>`
- `overwrite` `<boolean>`: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior.
- `errorOnExist` `<boolean>`: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`.
- `dereference` `<boolean>`: dereference symlinks, default is `false`.
- `preserveTimestamps` `<boolean>`: When true, will set last modification and access times to the ones of the original source files. When false, timestamp behavior is OS-dependent. Default is `false`.
- `filter` `<Function>`: Function to filter copied files/directories. Return `true` to copy the item, `false` to ignore it.
## Example:
```js
const fs = require('fs-extra')
// copy file
fs.copySync('/tmp/myfile', '/tmp/mynewfile')
// copy directory, even if it has subdirectories or files
fs.copySync('/tmp/mydir', '/tmp/mynewdir')
```
**Using filter function**
```js
const fs = require('fs-extra')
const filterFunc = (src, dest) => {
// your logic here
// it will be copied if return true
}
fs.copySync('/tmp/mydir', '/tmp/mynewdir', { filter: filterFunc })
```
================================================
FILE: docs/copy.md
================================================
# copy(src, dest[, options][, callback])
Copy a file or directory. The directory can have contents.
- `src` `<String>` Note that if `src` is a directory it will copy everything inside of this directory, not the entire directory itself (see [issue #537](https://github.com/jprichardson/node-fs-extra/issues/537)).
- `dest` `<String>` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)).
- `options` `<Object>`
- `overwrite` `<boolean>`: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior.
- `errorOnExist` `<boolean>`: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`.
- `dereference` `<boolean>`: dereference symlinks, default is `false`.
- `preserveTimestamps` `<boolean>`: When true, will set last modification and access times to the ones of the original source files. When false, timestamp behavior is OS-dependent. Default is `false`.
- `filter` `<Function>`: Function to filter copied files/directories. Return `true` to copy the item, `false` to ignore it. Can also return a `Promise` that resolves to `true` or `false` (or pass in an `async` function).
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
// With a callback:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
if (err) return console.error(err)
console.log('success!')
}) // copies file
fs.copy('/tmp/mydir', '/tmp/mynewdir', err => {
if (err) return console.error(err)
console.log('success!')
}) // copies directory, even if it has subdirectories or files
// With Promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example () {
try {
await fs.copy('/tmp/myfile', '/tmp/mynewfile')
console.log('success!')
} catch (err) {
console.error(err)
}
}
example()
```
**Using filter function**
```js
const fs = require('fs-extra')
const filterFunc = (src, dest) => {
// your logic here
// it will be copied if return true
}
fs.copy('/tmp/mydir', '/tmp/mynewdir', { filter: filterFunc }, err => {
if (err) return console.error(err)
console.log('success!')
})
```
================================================
FILE: docs/emptyDir-sync.md
================================================
# emptyDirSync(dir)
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
**Alias:** `emptydirSync()`
- `dir` `<String>`
## Example:
```js
const fs = require('fs-extra')
// assume this directory has a lot of files and folders
fs.emptyDirSync('/tmp/some/dir')
```
================================================
FILE: docs/emptyDir.md
================================================
# emptyDir(dir[, callback])
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
**Alias:** `emptydir()`
- `dir` `<String>`
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
// assume this directory has a lot of files and folders
// With a callback:
fs.emptyDir('/tmp/some/dir', err => {
if (err) return console.error(err)
console.log('success!')
})
// With Promises:
fs.emptyDir('/tmp/some/dir')
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example () {
try {
await fs.emptyDir('/tmp/some/dir')
console.log('success!')
} catch (err) {
console.error(err)
}
}
example()
```
================================================
FILE: docs/ensureDir-sync.md
================================================
# ensureDirSync(dir[,options])
Ensures that the directory exists. If the directory structure does not exist, it is created. If provided, options may specify the desired mode for the directory.
**Aliases:** `mkdirsSync()`, `mkdirpSync()`
- `dir` `<String>`
- `options` `<Integer> | <Object>`
- If it is `Integer`, it will be `mode`.
- If it is `Object`, it will be `{ mode: <Integer> }`.
## Example:
```js
const fs = require('fs-extra')
const dir = '/tmp/this/path/does/not/exist'
const desiredMode = 0o2775
const options = {
mode: 0o2775
}
fs.ensureDirSync(dir)
// dir has now been created, including the directory it is to be placed in
fs.ensureDirSync(dir, desiredMode)
// dir has now been created, including the directory it is to be placed in with permission 0o2775
fs.ensureDirSync(dir, options)
// dir has now been created, including the directory it is to be placed in with permission 0o2775
```
================================================
FILE: docs/ensureDir.md
================================================
# ensureDir(dir[,options][,callback])
Ensures that the directory exists. If the directory structure does not exist, it is created.
**Aliases:** `mkdirs()`, `mkdirp()`
- `dir` `<String>`
- `options` `<Integer> | <Object>`
- If it is `Integer`, it will be `mode`.
- If it is `Object`, it will be `{ mode: <Integer> }`.
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const dir = '/tmp/this/path/does/not/exist'
const desiredMode = 0o2775
const options = {
mode: 0o2775
}
// With a callback:
fs.ensureDir(dir, err => {
console.log(err) // => null
// dir has now been created, including the directory it is to be placed in
})
// With a callback and a mode integer
fs.ensureDir(dir, desiredMode, err => {
console.log(err) // => null
// dir has now been created with mode 0o2775, including the directory it is to be placed in
})
// With Promises:
fs.ensureDir(dir)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With Promises and a mode integer:
fs.ensureDir(dir, desiredMode)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (directory) {
try {
await fs.ensureDir(directory)
console.log('success!')
} catch (err) {
console.error(err)
}
}
example(dir)
// With async/await and an options object, containing mode:
async function exampleMode (directory) {
try {
await fs.ensureDir(directory, options)
console.log('success!')
} catch (err) {
console.error(err)
}
}
exampleMode(dir)
```
================================================
FILE: docs/ensureFile-sync.md
================================================
# ensureFileSync(file)
Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is **NOT MODIFIED**.
**Alias:** `createFileSync()`
- `file` `<String>`
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.txt'
fs.ensureFileSync(file)
// file has now been created, including the directory it is to be placed in
```
================================================
FILE: docs/ensureFile.md
================================================
# ensureFile(file[, callback])
Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is **NOT MODIFIED**.
**Alias:** `createFile()`
- `file` `<String>`
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.ensureFile(file, err => {
console.log(err) // => null
// file has now been created, including the directory it is to be placed in
})
// With Promises:
fs.ensureFile(file)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (f) {
try {
await fs.ensureFile(f)
console.log('success!')
} catch (err) {
console.error(err)
}
}
example(file)
```
================================================
FILE: docs/ensureLink-sync.md
================================================
# ensureLinkSync(srcPath, destPath)
Ensures that the link exists. If the directory structure does not exist, it is created.
**Alias:** `createLinkSync()`
- `srcPath` `<String>`
- `destPath` `<String>`
## Example:
```js
const fs = require('fs-extra')
const srcPath = '/tmp/file.txt'
const destPath = '/tmp/this/path/does/not/exist/file.txt'
fs.ensureLinkSync(srcPath, destPath)
// link has now been created, including the directory it is to be placed in
```
================================================
FILE: docs/ensureLink.md
================================================
# ensureLink(srcPath, destPath[, callback])
Ensures that the link exists. If the directory structure does not exist, it is created.
**Alias:** `createLink()`
- `srcPath` `<String>`
- `destPath` `<String>`
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const srcPath = '/tmp/file.txt'
const destPath = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.ensureLink(srcPath, destPath, err => {
console.log(err) // => null
// link has now been created, including the directory it is to be placed in
})
// With Promises:
fs.ensureLink(srcPath, destPath)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (src, dest) {
try {
await fs.ensureLink(src, dest)
console.log('success!')
} catch (err) {
console.error(err)
}
}
example(srcPath, destPath)
```
================================================
FILE: docs/ensureSymlink-sync.md
================================================
# ensureSymlinkSync(srcPath, destPath[, type])
Ensures that the symlink exists. If the directory structure does not exist, it is created.
**Alias:** `createSymlinkSync()`
- `srcPath` `<String>`
- `destPath` `<String>`
- `type` `<String>` It is only available on Windows and ignored on other platforms. It can be set to `dir`, `file`, or `junction`.
## Example:
```js
const fs = require('fs-extra')
const srcPath = '/tmp/file.txt'
const destPath = '/tmp/this/path/does/not/exist/file.txt'
fs.ensureSymlinkSync(srcPath, destPath)
// symlink has now been created, including the directory it is to be placed in
```
================================================
FILE: docs/ensureSymlink.md
================================================
# ensureSymlink(srcPath, destPath[, type][, callback])
Ensures that the symlink exists. If the directory structure does not exist, it is created.
**Alias:** `createSymlink()`
- `srcPath` `<String>`
- `destPath` `<String>`
- `type` `<String>` It is only available on Windows and ignored on other platforms. It can be set to `dir`, `file`, or `junction`.
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const srcPath = '/tmp/file.txt'
const destPath = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.ensureSymlink(srcPath, destPath, err => {
console.log(err) // => null
// symlink has now been created, including the directory it is to be placed in
})
// With Promises:
fs.ensureSymlink(srcPath, destPath)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (src, dest) {
try {
await fs.ensureSymlink(src, dest)
console.log('success!')
} catch (err) {
console.error(err)
}
}
example(srcPath, destPath)
```
================================================
FILE: docs/fs-read-write-writev.md
================================================
# About `fs.read()` & `fs.write()`
[`fs.read()`](https://nodejs.org/api/fs.html#fs_fs_read_fd_buffer_offset_length_position_callback), [`fs.write()`](https://nodejs.org/api/fs.html#fs_fs_write_fd_buffer_offset_length_position_callback), & [`fs.writev()`](https://nodejs.org/api/fs.html#fs_fs_writev_fd_buffers_position_callback) are different from other `fs` methods in that their callbacks are called with 3 arguments instead of the usual 2 arguments.
If you're using them with callbacks, they will behave as usual. However, their promise usage is a little different. `fs-extra` promisifies these methods like [`util.promisify()`](https://nodejs.org/api/util.html#util_util_promisify_original) (only available in Node 8+) does.
Here's the example promise usage:
## `fs.read()`
```js
// With Promises:
fs.read(fd, buffer, offset, length, position)
.then(results => {
console.log(results)
// { bytesRead: 20, buffer: <Buffer 0f 34 5d ...> }
})
// With async/await:
async function example () {
const { bytesRead, buffer } = await fs.read(fd, Buffer.alloc(length), offset, length, position)
}
```
## `fs.write()`
```js
// With Promises:
fs.write(fd, buffer, offset, length, position)
.then(results => {
console.log(results)
// { bytesWritten: 20, buffer: <Buffer 0f 34 5d ...> }
})
// With async/await:
async function example () {
const { bytesWritten, buffer } = await fs.write(fd, Buffer.alloc(length), offset, length, position)
}
```
## `fs.writev()`
```js
// With async/await:
async function example () {
const { bytesWritten, buffers } = await fs.writev(fd, buffers, position)
}
```
================================================
FILE: docs/move-sync.md
================================================
# moveSync(src, dest[, options])
Moves a file or directory, even across devices.
- `src` `<String>`
- `dest` `<String>` Note: When `src` is a file, `dest` must be a file and when `src` is a directory, `dest` must be a directory.
- `options` `<Object>`
- `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
## Example:
```js
const fs = require('fs-extra')
fs.moveSync('/tmp/somefile', '/tmp/does/not/exist/yet/somefile')
```
**Using `overwrite` option**
```js
const fs = require('fs-extra')
fs.moveSync('/tmp/somedir', '/tmp/may/already/exist/somedir', { overwrite: true })
```
================================================
FILE: docs/move.md
================================================
# move(src, dest[, options][, callback])
Moves a file or directory, even across devices.
- `src` `<String>`
- `dest` `<String>` Note: When `src` is a file, `dest` must be a file and when `src` is a directory, `dest` must be a directory.
- `options` `<Object>`
- `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const src = '/tmp/file.txt'
const dest = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.move(src, dest, err => {
if (err) return console.error(err)
console.log('success!')
})
// With Promises:
fs.move(src, dest)
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (src, dest) {
try {
await fs.move(src, dest)
console.log('success!')
} catch (err) {
console.error(err)
}
}
example(src, dest)
```
**Using `overwrite` option**
```js
const fs = require('fs-extra')
fs.move('/tmp/somedir', '/tmp/may/already/exist/somedir', { overwrite: true }, err => {
if (err) return console.error(err)
console.log('success!')
})
```
================================================
FILE: docs/outputFile-sync.md
================================================
# outputFileSync(file, data[, options])
Almost the same as `writeFileSync` (i.e. it overwrites), except that if the parent directory does not exist, it's created. `file` must be a file path (a buffer or a file descriptor is not allowed).
- `file` `<String>`
- `data` `<String> | <Buffer> | <Uint8Array>`
- `options` `<Object> | <String>` (the same as [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options))
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.txt'
fs.outputFileSync(file, 'hello!')
const data = fs.readFileSync(file, 'utf8')
console.log(data) // => hello!
```
================================================
FILE: docs/outputFile.md
================================================
# outputFile(file, data[, options][, callback])
Almost the same as `writeFile` (i.e. it overwrites), except that if the parent directory does not exist, it's created. `file` must be a file path (a buffer or a file descriptor is not allowed).
- `file` `<String>`
- `data` `<String> | <Buffer> | <Uint8Array>`
- `options` `<Object> | <String>` (the same as [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback))
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.outputFile(file, 'hello!', err => {
console.log(err) // => null
fs.readFile(file, 'utf8', (err, data) => {
if (err) return console.error(err)
console.log(data) // => hello!
})
})
// With Promises:
fs.outputFile(file, 'hello!')
.then(() => fs.readFile(file, 'utf8'))
.then(data => {
console.log(data) // => hello!
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (f) {
try {
await fs.outputFile(f, 'hello!')
const data = await fs.readFile(f, 'utf8')
console.log(data) // => hello!
} catch (err) {
console.error(err)
}
}
example(file)
```
================================================
FILE: docs/outputJson-sync.md
================================================
# outputJsonSync(file, object[, options])
Almost the same as [`writeJsonSync`](writeJson-sync.md), except that if the directory does not exist, it's created.
**Alias:** `outputJSONSync()`
- `file` `<String>`
- `object` `<Object>`
- `options` `<Object>`
- `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
- `EOL` `<String>` Set EOL character. Default is `\n`.
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
- Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.json'
fs.outputJsonSync(file, {name: 'JP'})
const data = fs.readJsonSync(file)
console.log(data.name) // => JP
```
================================================
FILE: docs/outputJson.md
================================================
# outputJson(file, object[, options][, callback])
Almost the same as [`writeJson`](writeJson.md), except that if the directory does not exist, it's created.
**Alias:** `outputJSON()`
- `file` `<String>`
- `object` `<Object>`
- `options` `<Object>`
- `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
- `EOL` `<String>` Set EOL character. Default is `\n`.
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
- Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.json'
// With a callback:
fs.outputJson(file, {name: 'JP'}, err => {
console.log(err) // => null
fs.readJson(file, (err, data) => {
if (err) return console.error(err)
console.log(data.name) // => JP
})
})
// With Promises:
fs.outputJson(file, {name: 'JP'})
.then(() => fs.readJson(file))
.then(data => {
console.log(data.name) // => JP
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (f) {
try {
await fs.outputJson(f, {name: 'JP'})
const data = await fs.readJson(f)
console.log(data.name) // => JP
} catch (err) {
console.error(err)
}
}
example(file)
```
================================================
FILE: docs/pathExists-sync.md
================================================
# pathExistsSync(file)
An alias for [`fs.existsSync()`](https://nodejs.org/api/fs.html#fs_fs_existssync_path), created for consistency with [`pathExists()`](pathExists.md).
================================================
FILE: docs/pathExists.md
================================================
# pathExists(file[, callback])
Test whether or not the given path exists by checking with the file system. Like [`fs.exists`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback), but with a normal callback signature (err, exists). Uses `fs.access` under the hood.
- `file` `<String>`
- `callback` `<Function>`
- `err` `<Error>`
- `exists` `<boolean>`
## Example:
```js
const fs = require('fs-extra')
const file = '/tmp/this/path/does/not/exist/file.txt'
// With a callback:
fs.pathExists(file, (err, exists) => {
console.log(err) // => null
console.log(exists) // => false
})
// Promise usage:
fs.pathExists(file)
.then(exists => console.log(exists)) // => false
// With async/await:
async function example (f) {
const exists = await fs.pathExists(f)
console.log(exists) // => false
}
example(file)
```
================================================
FILE: docs/readJson-sync.md
================================================
# readJsonSync(file[, options])
Reads a JSON file and then parses it into an object.
**Alias:** `readJSONSync()`
- `file` `<String>`
- `options` `<Object>` (the same as [`jsonFile.readFileSync()` options](https://github.com/jprichardson/node-jsonfile#readfilesyncfilename-options))
## Example:
```js
const fs = require('fs-extra')
const packageObj = fs.readJsonSync('./package.json')
console.log(packageObj.version) // => 2.0.0
```
---
`readJsonSync()` can take a `throws` option set to `false` and it won't throw if the JSON is invalid. Example:
```js
const fs = require('fs-extra')
const file = '/tmp/some-invalid.json'
const data = '{not valid JSON'
fs.writeFileSync(file, data)
const obj = fs.readJsonSync(file, { throws: false })
console.log(obj) // => null
```
================================================
FILE: docs/readJson.md
================================================
# readJson(file[, options][, callback])
Reads a JSON file and then parses it into an object.
**Alias:** `readJSON()`
- `file` `<String>`
- `options` `<Object>` (the same as [`jsonFile.readFile()` options](https://github.com/jprichardson/node-jsonfile#readfilefilename-options-callback))
- `callback` `<Function>`
- `err` `<Error>`
- `obj` `<Object>`
## Example:
```js
const fs = require('fs-extra')
// With a callback:
fs.readJson('./package.json', (err, packageObj) => {
if (err) console.error(err)
console.log(packageObj.version) // => 0.1.3
})
// With Promises:
fs.readJson('./package.json')
.then(packageObj => {
console.log(packageObj.version) // => 0.1.3
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example () {
try {
const packageObj = await fs.readJson('./package.json')
console.log(packageObj.version) // => 0.1.3
} catch (err) {
console.error(err)
}
}
example()
```
---
`readJson()` can take a `throws` option set to `false` and it won't throw if the JSON is invalid. Example:
```js
const fs = require('fs-extra')
const file = '/tmp/some-invalid.json'
const data = '{not valid JSON'
fs.writeFileSync(file, data)
// With a callback:
fs.readJson(file, { throws: false }, (err, obj) => {
if (err) console.error(err)
console.log(obj) // => null
})
// With Promises:
fs.readJson(file, { throws: false })
.then(obj => {
console.log(obj) // => null
})
.catch(err => {
console.error(err) // Not called
})
// With async/await:
async function example (f) {
const obj = await fs.readJson(f, { throws: false })
console.log(obj) // => null
}
example(file)
```
================================================
FILE: docs/remove-sync.md
================================================
# removeSync(path)
Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing.
- `path` `<String>`
## Example:
```js
const fs = require('fs-extra')
// remove file
fs.removeSync('/tmp/myfile')
fs.removeSync('/home/jprichardson') // I just deleted my entire HOME directory.
```
================================================
FILE: docs/remove.md
================================================
# remove(path[, callback])
Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing.
- `path` `<String>`
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
// remove file
// With a callback:
fs.remove('/tmp/myfile', err => {
if (err) return console.error(err)
console.log('success!')
})
fs.remove('/home/jprichardson', err => {
if (err) return console.error(err)
console.log('success!') // I just deleted my entire HOME directory.
})
// With Promises:
fs.remove('/tmp/myfile')
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example (src, dest) {
try {
await fs.remove('/tmp/myfile')
console.log('success!')
} catch (err) {
console.error(err)
}
}
example()
```
================================================
FILE: docs/writeJson-sync.md
================================================
# writeJsonSync(file, object[, options])
Writes an object to a JSON file.
**Alias:** `writeJSONSync()`
- `file` `<String>`
- `object` `<Object>`
- `options` `<Object>`
- `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
- `EOL` `<String>` Set EOL character. Default is `\n`.
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
- Also accepts [`fs.writeFileSync()` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options)
## Example:
```js
const fs = require('fs-extra')
fs.writeJsonSync('./package.json', {name: 'fs-extra'})
```
---
**See also:** [`outputJsonSync()`](outputJson-sync.md)
================================================
FILE: docs/writeJson.md
================================================
# writeJson(file, object[, options][, callback])
Writes an object to a JSON file.
**Alias:** `writeJSON()`
- `file` `<String>`
- `object` `<Object>`
- `options` `<Object>`
- `spaces` `<Number> | <String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
- `EOL` `<String>` Set EOL character. Default is `\n`.
- `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
- Also accepts [`fs.writeFile()` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)
- `callback` `<Function>`
- `err` `<Error>`
## Example:
```js
const fs = require('fs-extra')
// With a callback:
fs.writeJson('./package.json', {name: 'fs-extra'}, err => {
if (err) return console.error(err)
console.log('success!')
})
// With Promises:
fs.writeJson('./package.json', {name: 'fs-extra'})
.then(() => {
console.log('success!')
})
.catch(err => {
console.error(err)
})
// With async/await:
async function example () {
try {
await fs.writeJson('./package.json', {name: 'fs-extra'})
console.log('success!')
} catch (err) {
console.error(err)
}
}
example()
```
---
**See also:** [`outputJson()`](outputJson.md)
================================================
FILE: lib/__tests__/promise.test.js
================================================
'use strict'
/* eslint-env mocha */
const assert = require('assert')
const fse = require('..')
const methods = [
'emptyDir',
'ensureFile',
'ensureDir',
'mkdirs',
'readJson',
'readJSON',
'remove'
]
describe('promise support', () => {
methods.forEach(method => {
it(method, done => {
fse[method]().catch(() => done())
})
})
it('provides fse.promises API', () => {
assert.ok(fse.promises)
assert.strictEqual(typeof fse.promises.writeFile, 'function')
})
})
================================================
FILE: lib/copy/__tests__/copy-broken-symlink.test.js
================================================
'use strict'
const fs = require('fs')
const os = require('os')
const fse = require('../..')
const path = require('path')
const assert = require('assert')
const { copy } = require('../')
/* global afterEach, beforeEach, describe, it */
describe('copy / broken symlink', () => {
const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-broken-symlink')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
beforeEach(done => {
fse.emptyDir(TEST_DIR, err => {
assert.ifError(err)
createFixtures(src, done)
})
})
afterEach(done => fse.remove(TEST_DIR, done))
describe('when symlink is broken', () => {
it('should not throw error if dereference is false', done => {
copy(src, dest, err => {
assert.strictEqual(err, null)
done()
})
})
it('should throw error if dereference is true', done => {
copy(src, dest, { dereference: true }, err => {
assert.strictEqual(err.code, 'ENOENT')
done()
})
})
})
})
function createFixtures (srcDir, callback) {
fs.mkdir(srcDir, err => {
let brokenFile
let brokenFileLink
if (err) return callback(err)
try {
brokenFile = path.join(srcDir, 'does-not-exist')
brokenFileLink = path.join(srcDir, 'broken-symlink')
fs.writeFileSync(brokenFile, 'does not matter')
fs.symlinkSync(brokenFile, brokenFileLink, 'file')
} catch (err) {
callback(err)
}
// break the symlink now
fse.remove(brokenFile, callback)
})
}
================================================
FILE: lib/copy/__tests__/copy-case-insensitive-paths.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const platform = os.platform()
/* global beforeEach, afterEach, describe, it */
describe('+ copy() - case insensitive paths', () => {
let TEST_DIR = ''
let src = ''
let dest = ''
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-case-insensitive-paths')
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when src is a directory', () => {
it('should behave correctly based on the OS', done => {
src = path.join(TEST_DIR, 'srcdir')
fs.outputFileSync(path.join(src, 'subdir', 'file.txt'), 'some data')
dest = path.join(TEST_DIR, 'srcDir')
fs.copy(src, dest, err => {
if (platform === 'linux') {
assert.ifError(err)
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(path.join(dest, 'subdir', 'file.txt'), 'utf8'), 'some data')
}
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
done()
})
})
})
describe('> when src is a file', () => {
it('should behave correctly based on the OS', done => {
src = path.join(TEST_DIR, 'srcfile')
fs.outputFileSync(src, 'some data')
dest = path.join(TEST_DIR, 'srcFile')
fs.copy(src, dest, err => {
if (platform === 'linux') {
assert.ifError(err)
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(dest, 'utf8'), 'some data')
}
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
done()
})
})
})
describe('> when src is a symlink', () => {
it('should behave correctly based on the OS, symlink dir', done => {
src = path.join(TEST_DIR, 'srcdir')
fs.outputFileSync(path.join(src, 'subdir', 'file.txt'), 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
dest = path.join(TEST_DIR, 'src-Symlink')
fs.copy(srcLink, dest, err => {
if (platform === 'linux') {
assert.ifError(err)
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(path.join(dest, 'subdir', 'file.txt'), 'utf8'), 'some data')
const destLink = fs.readlinkSync(dest)
assert.strictEqual(destLink, src)
}
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
done()
})
})
it('should behave correctly based on the OS, symlink file', done => {
src = path.join(TEST_DIR, 'srcfile')
fs.outputFileSync(src, 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'file')
dest = path.join(TEST_DIR, 'src-Symlink')
fs.copy(srcLink, dest, err => {
if (platform === 'linux') {
assert.ifError(err)
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(dest, 'utf8'), 'some data')
const destLink = fs.readlinkSync(dest)
assert.strictEqual(destLink, src)
}
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
done()
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-dev-null.test.js
================================================
'use strict'
const fs = require('fs')
const os = require('os')
const fse = require('../../')
const path = require('path')
const assert = require('assert')
/* global afterEach, beforeEach, describe, it */
let TEST_DIR = ''
describe('+ copy() - copy /dev/null', () => {
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'test', 'fs-extra', 'copy-dev-null')
fse.emptyDir(TEST_DIR, done)
})
afterEach(done => fse.remove(TEST_DIR, done))
describe('> when src is /dev/null', () => {
it('should copy successfully', done => {
// no /dev/null on windows
if (process.platform === 'win32') return done()
const tmpFile = path.join(TEST_DIR, 'foo')
fse.copy('/dev/null', tmpFile, err => {
assert.ifError(err)
const stats = fs.lstatSync(tmpFile)
assert.strictEqual(stats.size, 0)
done()
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-gh-89.test.js
================================================
'use strict'
// relevant: https://github.com/jprichardson/node-fs-extra/issues/89
// come up with better file name
const fs = require('fs')
const os = require('os')
const fse = require('../../')
const path = require('path')
const assert = require('assert')
/* global afterEach, beforeEach, describe, it */
describe('copy() - gh #89', () => {
const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-gh-89')
beforeEach(done => {
fse.emptyDir(TEST_DIR, done)
})
afterEach(done => {
fse.remove(TEST_DIR, done)
})
it('should copy successfully', done => {
const A = path.join(TEST_DIR, 'A')
const B = path.join(TEST_DIR, 'B')
fs.mkdirSync(A)
fs.mkdirSync(B)
const one = path.join(A, 'one.txt')
const two = path.join(A, 'two.txt')
const three = path.join(B, 'three.txt')
const four = path.join(B, 'four.txt')
fs.writeFileSync(one, '1')
fs.writeFileSync(two, '2')
fs.writeFileSync(three, '3')
fs.writeFileSync(four, '4')
const C = path.join(TEST_DIR, 'C')
fse.copy(A, C, err => {
if (err) return done(err)
fse.copy(B, C, err => {
if (err) return done(err)
assert(fs.existsSync(path.join(C, 'one.txt')))
assert(fs.existsSync(path.join(C, 'two.txt')))
assert(fs.existsSync(path.join(C, 'three.txt')))
assert(fs.existsSync(path.join(C, 'four.txt')))
done()
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-permissions.test.js
================================================
'use strict'
const fs = require('fs')
const os = require('os')
const fse = require('../../')
const path = require('path')
const assert = require('assert')
/* global beforeEach, describe, it */
describe('copy', () => {
let TEST_DIR
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy')
fse.emptyDir(TEST_DIR, done)
})
// pretty UNIX specific, may not pass on windows... only tested on Mac OS X 10.9
it('should maintain file permissions and ownership', done => {
if (process.platform === 'win32') return done()
// var userid = require('userid')
// http://man7.org/linux/man-pages/man2/stat.2.html
const S_IFREG = 0o100000 // regular file
const S_IFDIR = 0o40000 // directory
// these are Mac specific I think (at least staff), should find Linux equivalent
let gidWheel
let gidStaff
try {
gidWheel = process.getgid() // userid.gid('wheel')
} catch {
gidWheel = process.getgid()
}
try {
gidStaff = process.getgid() // userid.gid('staff')
} catch {
gidStaff = process.getgid()
}
const permDir = path.join(TEST_DIR, 'perms')
fs.mkdirSync(permDir)
const srcDir = path.join(permDir, 'src')
fs.mkdirSync(srcDir)
const f1 = path.join(srcDir, 'f1.txt')
fs.writeFileSync(f1, '')
fs.chmodSync(f1, 0o666)
fs.chownSync(f1, process.getuid(), gidWheel)
const f1stats = fs.lstatSync(f1)
assert.strictEqual(f1stats.mode - S_IFREG, 0o666)
const d1 = path.join(srcDir, 'somedir')
fs.mkdirSync(d1)
fs.chmodSync(d1, 0o777)
fs.chownSync(d1, process.getuid(), gidStaff)
const d1stats = fs.lstatSync(d1)
assert.strictEqual(d1stats.mode - S_IFDIR, 0o777)
const f2 = path.join(d1, 'f2.bin')
fs.writeFileSync(f2, '')
fs.chmodSync(f2, 0o777)
fs.chownSync(f2, process.getuid(), gidStaff)
const f2stats = fs.lstatSync(f2)
assert.strictEqual(f2stats.mode - S_IFREG, 0o777)
const d2 = path.join(srcDir, 'crazydir')
fs.mkdirSync(d2)
fs.chmodSync(d2, 0o444)
fs.chownSync(d2, process.getuid(), gidWheel)
const d2stats = fs.lstatSync(d2)
assert.strictEqual(d2stats.mode - S_IFDIR, 0o444)
const destDir = path.join(permDir, 'dest')
fse.copy(srcDir, destDir, err => {
assert.ifError(err)
const newf1stats = fs.lstatSync(path.join(permDir, 'dest/f1.txt'))
const newd1stats = fs.lstatSync(path.join(permDir, 'dest/somedir'))
const newf2stats = fs.lstatSync(path.join(permDir, 'dest/somedir/f2.bin'))
const newd2stats = fs.lstatSync(path.join(permDir, 'dest/crazydir'))
assert.strictEqual(newf1stats.mode, f1stats.mode)
assert.strictEqual(newd1stats.mode, d1stats.mode)
assert.strictEqual(newf2stats.mode, f2stats.mode)
assert.strictEqual(newd2stats.mode, d2stats.mode)
assert.strictEqual(newf1stats.gid, f1stats.gid)
assert.strictEqual(newd1stats.gid, d1stats.gid)
assert.strictEqual(newf2stats.gid, f2stats.gid)
assert.strictEqual(newd2stats.gid, d2stats.gid)
assert.strictEqual(newf1stats.uid, f1stats.uid)
assert.strictEqual(newd1stats.uid, d1stats.uid)
assert.strictEqual(newf2stats.uid, f2stats.uid)
assert.strictEqual(newd2stats.uid, d2stats.uid)
done()
})
})
})
================================================
FILE: lib/copy/__tests__/copy-preserve-timestamp.test.js
================================================
'use strict'
const fs = require('../../')
const os = require('os')
const path = require('path')
const { copy } = require('../')
const utimesSync = require('../../util/utimes').utimesMillisSync
const assert = require('assert')
/* global beforeEach, afterEach, describe, it */
if (process.arch === 'ia32') console.warn('32 bit arch; skipping copy timestamp tests')
const describeIfPractical = process.arch === 'ia32' ? describe.skip : describe
describeIfPractical('copy() - preserve timestamp', () => {
let TEST_DIR, SRC, DEST, FILES
function setupFixture (readonly) {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-preserve-timestamp')
SRC = path.join(TEST_DIR, 'src')
DEST = path.join(TEST_DIR, 'dest')
FILES = ['a-file', path.join('a-folder', 'another-file'), path.join('a-folder', 'another-folder', 'file3')]
const timestamp = Date.now() / 1000 - 5
FILES.forEach(f => {
const filePath = path.join(SRC, f)
fs.ensureFileSync(filePath)
// rewind timestamps to make sure that coarser OS timestamp resolution
// does not alter results
utimesSync(filePath, timestamp, timestamp)
if (readonly) {
fs.chmodSync(filePath, 0o444)
}
})
}
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when preserveTimestamps option is true', () => {
;[
{ subcase: 'writable', readonly: false },
{ subcase: 'readonly', readonly: true }
].forEach(params => {
describe(`>> with ${params.subcase} source files`, () => {
beforeEach(() => setupFixture(params.readonly))
it('should have the same timestamps on copy', done => {
copy(SRC, DEST, { preserveTimestamps: true }, (err) => {
if (err) return done(err)
FILES.forEach(testFile({ preserveTimestamps: true }))
done()
})
})
})
})
})
function testFile (options) {
return function (file) {
const a = path.join(SRC, file)
const b = path.join(DEST, file)
const fromStat = fs.statSync(a)
const toStat = fs.statSync(b)
if (options.preserveTimestamps) {
// Windows sub-second precision fixed: https://github.com/nodejs/io.js/issues/2069
assert.strictEqual(toStat.mtime.getTime(), fromStat.mtime.getTime(), 'different mtime values')
assert.strictEqual(toStat.atime.getTime(), fromStat.atime.getTime(), 'different atime values')
} else {
// the access time might actually be the same, so check only modification time
assert.notStrictEqual(toStat.mtime.getTime(), fromStat.mtime.getTime(), 'same mtime values')
}
}
}
})
================================================
FILE: lib/copy/__tests__/copy-prevent-copying-identical.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const klawSync = require('klaw-sync')
/* global beforeEach, afterEach, describe, it */
describe('+ copy() - prevent copying identical files and dirs', () => {
let TEST_DIR = ''
let src = ''
let dest = ''
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-prevent-copying-identical')
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => fs.remove(TEST_DIR, done))
it('should return an error if src and dest are the same', done => {
const fileSrc = path.join(TEST_DIR, 'TEST_fs-extra_copy')
const fileDest = path.join(TEST_DIR, 'TEST_fs-extra_copy')
fs.ensureFileSync(fileSrc)
fs.copy(fileSrc, fileDest, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
done()
})
})
describe('dest with parent symlink', () => {
describe('first parent is symlink', () => {
it('should error when src is file', done => {
const src = path.join(TEST_DIR, 'a', 'file.txt')
const dest = path.join(TEST_DIR, 'b', 'file.txt')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureFileSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
fs.copy(src, dest, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
assert(fs.existsSync(src))
done()
})
})
it('should error when src is directory', done => {
const src = path.join(TEST_DIR, 'a', 'foo')
const dest = path.join(TEST_DIR, 'b', 'foo')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureDirSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
fs.copy(src, dest, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
assert(fs.existsSync(src))
done()
})
})
})
describe('nested dest', () => {
it('should error when src is file', done => {
const src = path.join(TEST_DIR, 'a', 'dir', 'file.txt')
const dest = path.join(TEST_DIR, 'b', 'dir', 'file.txt')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureFileSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
fs.copy(src, dest, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
assert(fs.existsSync(src))
done()
})
})
it('should error when src is directory', done => {
const src = path.join(TEST_DIR, 'a', 'dir', 'foo')
const dest = path.join(TEST_DIR, 'b', 'dir', 'foo')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureDirSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
fs.copy(src, dest, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
assert(fs.existsSync(src))
done()
})
})
})
})
// src is directory:
// src is regular, dest is symlink
// src is symlink, dest is regular
// src is symlink, dest is symlink
describe('> when src is a directory', () => {
describe('>> when src is regular and dest is a symlink that points to src', () => {
it('should error if dereference is true', done => {
src = path.join(TEST_DIR, 'src')
fs.mkdirsSync(src)
const subdir = path.join(TEST_DIR, 'src', 'subdir')
fs.mkdirsSync(subdir)
fs.writeFileSync(path.join(subdir, 'file.txt'), 'some data')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const oldlen = klawSync(src).length
fs.copy(src, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const newlen = klawSync(src).length
assert.strictEqual(newlen, oldlen)
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
done()
})
})
})
describe('>> when src is a symlink that points to a regular dest', () => {
it('should throw error', done => {
dest = path.join(TEST_DIR, 'dest')
fs.mkdirsSync(dest)
const subdir = path.join(TEST_DIR, 'dest', 'subdir')
fs.mkdirsSync(subdir)
fs.writeFileSync(path.join(subdir, 'file.txt'), 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(dest, srcLink, 'dir')
const oldlen = klawSync(dest).length
fs.copy(srcLink, dest, err => {
assert.ok(err)
// assert nothing copied
const newlen = klawSync(dest).length
assert.strictEqual(newlen, oldlen)
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, dest)
done()
})
})
})
describe('>> when src and dest are symlinks that point to the exact same path', () => {
it('should error src and dest are the same and dereference is true', done => {
src = path.join(TEST_DIR, 'src')
fs.mkdirsSync(src)
const srcLink = path.join(TEST_DIR, 'src_symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest_symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(srcLink).length
const destlenBefore = klawSync(destLink).length
fs.copy(srcLink, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const srclenAfter = klawSync(srcLink).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const destlenAfter = klawSync(destLink).length
assert.strictEqual(destlenAfter, destlenBefore, 'dest length should not change')
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
done()
})
})
})
})
// src is file:
// src is regular, dest is symlink
// src is symlink, dest is regular
// src is symlink, dest is symlink
describe('> when src is a file', () => {
describe('>> when src is regular and dest is a symlink that points to src', () => {
it('should error', done => {
src = path.join(TEST_DIR, 'src.txt')
fs.outputFileSync(src, 'some data')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'file')
fs.copy(src, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
done()
})
})
})
describe('>> when src is a symlink that points to a regular dest', () => {
it('should throw error if dereference is true', done => {
dest = path.join(TEST_DIR, 'dest', 'somefile.txt')
fs.outputFileSync(dest, 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(dest, srcLink, 'file')
fs.copy(srcLink, dest, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, dest)
assert(fs.readFileSync(link, 'utf8'), 'some data')
done()
})
})
})
describe('>> when src and dest are symlinks that point to the exact same path', () => {
it('should error src and dest are the same and dereferene is true', done => {
src = path.join(TEST_DIR, 'src', 'srcfile.txt')
fs.outputFileSync(src, 'src data')
const srcLink = path.join(TEST_DIR, 'src_symlink')
fs.symlinkSync(src, srcLink, 'file')
const destLink = path.join(TEST_DIR, 'dest_symlink')
fs.symlinkSync(src, destLink, 'file')
fs.copy(srcLink, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
assert(fs.readFileSync(srcln, 'utf8'), 'src data')
assert(fs.readFileSync(destln, 'utf8'), 'src data')
done()
})
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-prevent-copying-into-itself.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const klawSync = require('klaw-sync')
/* global beforeEach, afterEach, describe, it */
// these files are used for all tests
const FILES = [
'file0.txt',
path.join('dir1', 'file1.txt'),
path.join('dir1', 'dir2', 'file2.txt'),
path.join('dir1', 'dir2', 'dir3', 'file3.txt')
]
const dat0 = 'file0'
const dat1 = 'file1'
const dat2 = 'file2'
const dat3 = 'file3'
describe('+ copy() - prevent copying into itself', () => {
let TEST_DIR, src
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-prevent-copying-into-itself')
src = path.join(TEST_DIR, 'src')
fs.mkdirpSync(src)
fs.outputFileSync(path.join(src, FILES[0]), dat0)
fs.outputFileSync(path.join(src, FILES[1]), dat1)
fs.outputFileSync(path.join(src, FILES[2]), dat2)
fs.outputFileSync(path.join(src, FILES[3]), dat3)
done()
})
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when source is a file', () => {
it('should copy the file successfully even if dest parent is a subdir of src', done => {
const srcFile = path.join(TEST_DIR, 'src', 'srcfile.txt')
const destFile = path.join(TEST_DIR, 'src', 'dest', 'destfile.txt')
fs.writeFileSync(srcFile, dat0)
fs.copy(srcFile, destFile, err => {
assert.ifError(err)
assert(fs.existsSync(destFile, 'file copied'))
const out = fs.readFileSync(destFile, 'utf8')
assert.strictEqual(out, dat0, 'file contents matched')
done()
})
})
})
// test for these cases:
// - src is directory, dest is directory
// - src is directory, dest is symlink
// - src is symlink, dest is directory
// - src is symlink, dest is symlink
describe('> when source is a directory', () => {
describe('>> when dest is a directory', () => {
it('of not itself', done => {
const dest = path.join(TEST_DIR, src.replace(/^\w:/, ''))
return testSuccess(src, dest, done)
})
it('of itself', done => {
const dest = path.join(src, 'dest')
return testError(src, dest, done)
})
it("should copy the directory successfully when dest is 'src_dest'", done => {
const dest = path.join(TEST_DIR, 'src_dest')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'src-dest'", done => {
const dest = path.join(TEST_DIR, 'src-dest')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'dest_src'", done => {
const dest = path.join(TEST_DIR, 'dest_src')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'src_dest/src'", done => {
const dest = path.join(TEST_DIR, 'src_dest', 'src')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'src-dest/src'", done => {
const dest = path.join(TEST_DIR, 'src-dest', 'src')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'dest_src/src'", done => {
const dest = path.join(TEST_DIR, 'dest_src', 'src')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'src_src/dest'", done => {
const dest = path.join(TEST_DIR, 'src_src', 'dest')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'src-src/dest'", done => {
const dest = path.join(TEST_DIR, 'src-src', 'dest')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'srcsrc/dest'", done => {
const dest = path.join(TEST_DIR, 'srcsrc', 'dest')
return testSuccess(src, dest, done)
})
it("should copy the directory successfully when dest is 'dest/src'", done => {
const dest = path.join(TEST_DIR, 'dest', 'src')
return testSuccess(src, dest, done)
})
it('should copy the directory successfully when dest is very nested that all its parents need to be created', done => {
const dest = path.join(TEST_DIR, 'dest', 'src', 'foo', 'bar', 'baz', 'qux', 'quux', 'waldo',
'grault', 'garply', 'fred', 'plugh', 'thud', 'some', 'highly', 'deeply',
'badly', 'nasty', 'crazy', 'mad', 'nested', 'dest')
return testSuccess(src, dest, done)
})
it("should error when dest is 'src/dest'", done => {
const dest = path.join(TEST_DIR, 'src', 'dest')
return testError(src, dest, done)
})
it("should error when dest is 'src/src_dest'", done => {
const dest = path.join(TEST_DIR, 'src', 'src_dest')
return testError(src, dest, done)
})
it("should error when dest is 'src/dest_src'", done => {
const dest = path.join(TEST_DIR, 'src', 'dest_src')
return testError(src, dest, done)
})
it("should error when dest is 'src/dest/src'", done => {
const dest = path.join(TEST_DIR, 'src', 'dest', 'src')
return testError(src, dest, done)
})
})
describe('>> when dest is a symlink', () => {
it('should error when dest points exactly to src and dereference is true', done => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
fs.copy(src, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
done()
})
})
it('should error when dest is a subdirectory of src (bind-mounted directory with subdirectory)', done => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
const dest = path.join(destLink, 'dir1')
assert(fs.existsSync(dest))
fs.copy(src, dest, err => {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${dest}'.`)
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
done()
})
})
it('should error when dest is a subdirectory of src (more than one level depth)', done => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
const dest = path.join(destLink, 'dir1', 'dir2')
assert(fs.existsSync(dest))
fs.copy(src, dest, err => {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${path.join(destLink, 'dir1')}'.`)
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
done()
})
})
it('should copy the directory successfully when src is a subdir of resolved dest path and dereference is true', done => {
const srcInDest = path.join(TEST_DIR, 'dest', 'some', 'nested', 'src')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.copySync(src, srcInDest) // put some stuff in srcInDest
const dest = path.join(TEST_DIR, 'dest')
fs.symlinkSync(dest, destLink, 'dir')
const srclen = klawSync(srcInDest).length
const destlenBefore = klawSync(dest).length
assert(srclen > 2)
fs.copy(srcInDest, destLink, { dereference: true }, err => {
assert.ifError(err)
const destlenAfter = klawSync(dest).length
// assert dest length is oldlen + length of stuff copied from src
assert.strictEqual(destlenAfter, destlenBefore + srclen, 'dest length should be equal to old length + copied legnth')
FILES.forEach(f => assert(fs.existsSync(path.join(dest, f)), 'file copied'))
const o0 = fs.readFileSync(path.join(dest, FILES[0]), 'utf8')
const o1 = fs.readFileSync(path.join(dest, FILES[1]), 'utf8')
const o2 = fs.readFileSync(path.join(dest, FILES[2]), 'utf8')
const o3 = fs.readFileSync(path.join(dest, FILES[3]), 'utf8')
assert.strictEqual(o0, dat0, 'files contents matched')
assert.strictEqual(o1, dat1, 'files contents matched')
assert.strictEqual(o2, dat2, 'files contents matched')
assert.strictEqual(o3, dat3, 'files contents matched')
done()
})
})
})
})
describe('> when source is a symlink', () => {
describe('>> when dest is a directory', () => {
it('should error when resolved src path points to dest', done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src')
fs.copy(srcLink, dest, err => {
assert(err)
// assert source not affected
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, src)
done()
})
})
it('should error when dest is a subdir of resolved src path', done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src', 'some', 'nested', 'dest')
fs.mkdirsSync(dest)
fs.copy(srcLink, dest, err => {
assert(err)
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, src)
done()
})
})
it('should error when resolved src path is a subdir of dest', done => {
const dest = path.join(TEST_DIR, 'dest')
const resolvedSrcPath = path.join(dest, 'contains', 'src')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.copySync(src, resolvedSrcPath)
// make symlink that points to a subdir in dest
fs.symlinkSync(resolvedSrcPath, srcLink, 'dir')
fs.copy(srcLink, dest, err => {
assert(err)
done()
})
})
it("should copy the directory successfully when dest is 'src_src/dest'", done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src_src', 'dest')
testSuccess(srcLink, dest, () => {
const link = fs.readlinkSync(dest)
assert.strictEqual(link, src)
done()
})
})
it("should copy the directory successfully when dest is 'srcsrc/dest'", done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'srcsrc', 'dest')
testSuccess(srcLink, dest, () => {
const link = fs.readlinkSync(dest)
assert.strictEqual(link, src)
done()
})
})
})
describe('>> when dest is a symlink', () => {
it('should error when resolved dest path is exactly the same as resolved src path and dereference is true', done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(srcLink).length
const destlenBefore = klawSync(destLink).length
assert(srclenBefore > 2)
assert(destlenBefore > 2)
fs.copy(srcLink, destLink, { dereference: true }, err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
const srclenAfter = klawSync(srcLink).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const destlenAfter = klawSync(destLink).length
assert.strictEqual(destlenAfter, destlenBefore, 'dest length should not change')
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
done()
})
})
it('should error when resolved dest path is a subdir of resolved src path', done => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest-symlink')
const resolvedDestPath = path.join(TEST_DIR, 'src', 'some', 'nested', 'dest')
fs.ensureFileSync(path.join(resolvedDestPath, 'subdir', 'somefile.txt'))
fs.symlinkSync(resolvedDestPath, destLink, 'dir')
fs.copy(srcLink, destLink, err => {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${resolvedDestPath}'.`)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, resolvedDestPath)
done()
})
})
})
})
})
function testSuccess (src, dest, done) {
const srclen = klawSync(src).length
assert(srclen > 2)
fs.copy(src, dest, err => {
assert.ifError(err)
FILES.forEach(f => assert(fs.existsSync(path.join(dest, f)), 'file copied'))
const o0 = fs.readFileSync(path.join(dest, FILES[0]), 'utf8')
const o1 = fs.readFileSync(path.join(dest, FILES[1]), 'utf8')
const o2 = fs.readFileSync(path.join(dest, FILES[2]), 'utf8')
const o3 = fs.readFileSync(path.join(dest, FILES[3]), 'utf8')
assert.strictEqual(o0, dat0, 'file contents matched')
assert.strictEqual(o1, dat1, 'file contents matched')
assert.strictEqual(o2, dat2, 'file contents matched')
assert.strictEqual(o3, dat3, 'file contents matched')
done()
})
}
function testError (src, dest, done) {
fs.copy(src, dest, err => {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${dest}'.`)
done()
})
}
================================================
FILE: lib/copy/__tests__/copy-readonly-dir.test.js
================================================
'use strict'
// relevant: https://github.com/jprichardson/node-fs-extra/issues/599
const fs = require('../../')
const os = require('os')
const fse = require('../../')
const path = require('path')
const assert = require('assert')
const klawSync = require('klaw-sync')
/* global afterEach, beforeEach, describe, it */
let TEST_DIR = ''
const FILES = [
path.join('dir1', 'file1.txt'),
path.join('dir1', 'dir2', 'file2.txt'),
path.join('dir1', 'dir2', 'dir3', 'file3.txt')
]
describe('+ copy() - copy a readonly directory with content', () => {
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'test', 'fs-extra', 'copy-readonly-dir')
fse.emptyDir(TEST_DIR, done)
})
afterEach(done => {
klawSync(TEST_DIR).forEach(data => fs.chmodSync(data.path, 0o777))
fse.remove(TEST_DIR, done)
})
describe('> when src is readonly directory with content', () => {
it('should copy successfully', done => {
FILES.forEach(file => {
fs.outputFileSync(path.join(TEST_DIR, file), file)
})
const sourceDir = path.join(TEST_DIR, 'dir1')
const sourceHierarchy = klawSync(sourceDir)
sourceHierarchy.forEach(source => fs.chmodSync(source.path, source.stats.isDirectory() ? 0o555 : 0o444))
const targetDir = path.join(TEST_DIR, 'target')
fse.copy(sourceDir, targetDir, err => {
assert.ifError(err)
// Make sure copy was made and mode was preserved
assert(fs.existsSync(targetDir))
const targetHierarchy = klawSync(targetDir)
assert(targetHierarchy.length === sourceHierarchy.length)
targetHierarchy.forEach(target => assert(target.stats.mode === target.stats.isDirectory() ? 0o555 : 0o444))
done()
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-symlink-same-target.test.js
================================================
'use strict'
const os = require('os')
const fs = require('../..')
const path = require('path')
const assert = require('assert')
/* global afterEach, beforeEach, describe, it */
describe('copy() / symlink same target', () => {
const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-symlink-same-target')
beforeEach(done => {
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => {
fs.remove(TEST_DIR, done)
})
describe('> when copying directory containing symlink', () => {
it('should copy symlink when dest has no existing symlink', done => {
const target = path.join(TEST_DIR, 'target')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
// Setup
fs.mkdirpSync(target)
fs.writeFileSync(path.join(target, 'file.txt'), 'content')
fs.mkdirpSync(src)
fs.symlinkSync(target, path.join(src, 'link'), 'dir')
// Copy
fs.copy(src, dest, err => {
assert.ifError(err)
// Verify symlink was copied
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target)
done()
})
})
// Also tests issue #1027
it('should overwrite symlink when dest has existing symlink pointing to SAME target', done => {
const target = path.join(TEST_DIR, 'target')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
// Setup
fs.mkdirpSync(target)
fs.writeFileSync(path.join(target, 'file.txt'), 'content')
fs.mkdirpSync(src)
fs.mkdirpSync(dest)
// Create symlinks pointing to the same target
fs.symlinkSync(target, path.join(src, 'link'), 'dir')
fs.symlinkSync(target, path.join(dest, 'link'), 'dir')
// Copy should work - two different symlinks pointing to same target are NOT the same file
fs.copy(src, dest)
.then(() => {
// Verify symlink was copied/overwritten
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target)
done()
})
.catch(done)
})
it('should overwrite symlink when dest has existing symlink pointing to DIFFERENT target', done => {
const target1 = path.join(TEST_DIR, 'target1')
const target2 = path.join(TEST_DIR, 'target2')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
// Setup
fs.mkdirpSync(target1)
fs.mkdirpSync(target2)
fs.writeFileSync(path.join(target1, 'file.txt'), 'content1')
fs.writeFileSync(path.join(target2, 'file.txt'), 'content2')
fs.mkdirpSync(src)
fs.mkdirpSync(dest)
// Create symlinks pointing to different targets
fs.symlinkSync(target1, path.join(src, 'link'), 'dir')
fs.symlinkSync(target2, path.join(dest, 'link'), 'dir')
// Copy should work
fs.copy(src, dest, err => {
assert.ifError(err)
// Verify symlink was copied/overwritten to point to target1
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target1)
done()
})
})
})
describe('> when copying file symlinks', () => {
it('should overwrite file symlink when dest has existing symlink pointing to SAME target', done => {
const target = path.join(TEST_DIR, 'target.txt')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
// Setup
fs.writeFileSync(target, 'content')
fs.mkdirpSync(src)
fs.mkdirpSync(dest)
// Create file symlinks pointing to the same target
fs.symlinkSync(target, path.join(src, 'link'), 'file')
fs.symlinkSync(target, path.join(dest, 'link'), 'file')
// Copy should work
fs.copy(src, dest)
.then(() => {
// Verify symlink was copied/overwritten
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target)
done()
})
.catch(done)
})
it('should overwrite file symlink when dest has existing symlink pointing to DIFFERENT target', done => {
const target1 = path.join(TEST_DIR, 'target1.txt')
const target2 = path.join(TEST_DIR, 'target2.txt')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
// Setup
fs.writeFileSync(target1, 'content1')
fs.writeFileSync(target2, 'content2')
fs.mkdirpSync(src)
fs.mkdirpSync(dest)
// Create file symlinks pointing to different targets
fs.symlinkSync(target1, path.join(src, 'link'), 'file')
fs.symlinkSync(target2, path.join(dest, 'link'), 'file')
// Copy should work
fs.copy(src, dest, err => {
assert.ifError(err)
// Verify symlink was copied/overwritten to point to target1
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target1)
done()
})
})
})
describe('> when copying symlink directly to another symlink (issue #1019)', () => {
it('should copy symlink to another symlink pointing to same target', done => {
const target = path.join(TEST_DIR, 'target.txt')
const srcLink = path.join(TEST_DIR, 'srcLink')
const destLink = path.join(TEST_DIR, 'destLink')
// Setup - two different symlinks pointing to the same file
fs.writeFileSync(target, 'content')
fs.symlinkSync(target, srcLink, 'file')
fs.symlinkSync(target, destLink, 'file')
// Copy should work - these are different symlinks even though they point to the same target
fs.copy(srcLink, destLink)
.then(() => {
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target)
done()
})
.catch(done)
})
})
describe('> edge cases', () => {
it('should still prevent copying a symlink to itself', done => {
const target = path.join(TEST_DIR, 'target')
const link = path.join(TEST_DIR, 'link')
// Setup
fs.mkdirpSync(target)
fs.symlinkSync(target, link, 'dir')
// Copying a symlink to itself should fail
fs.copy(link, link)
.then(() => {
done(new Error('Expected error to be thrown'))
})
.catch(err => {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
done()
})
})
it('should allow copying symlink to subdirectory of its target (symlink copy, not recursive)', done => {
// When copying a symlink (not dereferencing), we just copy the link itself
// This should be allowed because we're not recursively copying the target's contents
const target = path.join(TEST_DIR, 'target')
const src = path.join(TEST_DIR, 'src')
// Setup
fs.mkdirpSync(target)
fs.mkdirpSync(path.join(target, 'subdir'))
fs.mkdirpSync(src)
fs.symlinkSync(target, path.join(src, 'link'), 'dir')
// Dest is inside src's resolved target
const dest = path.join(target, 'subdir', 'dest')
// This should work - we're just copying the symlink, not following it
fs.copy(src, dest)
.then(() => {
// Verify symlink was copied
const destLink = path.join(dest, 'link')
assert.ok(fs.lstatSync(destLink).isSymbolicLink())
assert.strictEqual(fs.readlinkSync(destLink), target)
done()
})
.catch(done)
})
})
})
================================================
FILE: lib/copy/__tests__/copy-sync-broken-symlink.test.js
================================================
'use strict'
const fs = require('fs')
const os = require('os')
const fse = require('../..')
const path = require('path')
const assert = require('assert')
const copySync = require('../copy-sync')
/* global afterEach, beforeEach, describe, it */
describe('copy-sync / broken symlink', () => {
const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-broken-symlink')
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'dest')
beforeEach(done => {
fse.emptyDir(TEST_DIR, err => {
assert.ifError(err)
createFixtures(src, done)
})
})
afterEach(done => fse.remove(TEST_DIR, done))
describe('when symlink is broken', () => {
it('should not throw error if dereference is false', () => {
let err = null
try {
copySync(src, dest)
} catch (e) {
err = e
}
assert.strictEqual(err, null)
})
it('should throw error if dereference is true', () => {
assert.throws(() => copySync(src, dest, { dereference: true }), err => err.code === 'ENOENT')
})
})
})
function createFixtures (srcDir, callback) {
fs.mkdir(srcDir, err => {
let brokenFile
let brokenFileLink
if (err) return callback(err)
try {
brokenFile = path.join(srcDir, 'does-not-exist')
brokenFileLink = path.join(srcDir, 'broken-symlink')
fs.writeFileSync(brokenFile, 'does not matter')
fs.symlinkSync(brokenFile, brokenFileLink, 'file')
} catch (err) {
callback(err)
}
// break the symlink now
fse.remove(brokenFile, callback)
})
}
================================================
FILE: lib/copy/__tests__/copy-sync-case-insensitive-paths.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const platform = os.platform()
/* global beforeEach, afterEach, describe, it */
describe('+ copySync() - case insensitive paths', () => {
let TEST_DIR = ''
let src = ''
let dest = ''
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-case-insensitive-paths')
fs.emptyDir(TEST_DIR, done)
})
afterEach(() => fs.removeSync(TEST_DIR))
describe('> when src is a directory', () => {
it('should behave correctly based on the OS', () => {
src = path.join(TEST_DIR, 'srcdir')
fs.outputFileSync(path.join(src, 'subdir', 'file.txt'), 'some data')
dest = path.join(TEST_DIR, 'srcDir')
let errThrown = false
try {
fs.copySync(src, dest)
} catch (err) {
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
errThrown = true
}
}
if (platform === 'darwin' || platform === 'win32') assert(errThrown)
if (platform === 'linux') {
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(path.join(dest, 'subdir', 'file.txt'), 'utf8'), 'some data')
assert(!errThrown)
}
})
})
describe('> when src is a file', () => {
it('should behave correctly based on the OS', () => {
src = path.join(TEST_DIR, 'srcfile')
fs.outputFileSync(src, 'some data')
dest = path.join(TEST_DIR, 'srcFile')
let errThrown = false
try {
fs.copySync(src, dest)
} catch (err) {
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
errThrown = true
}
}
if (platform === 'darwin' || platform === 'win32') assert(errThrown)
if (platform === 'linux') {
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(dest, 'utf8'), 'some data')
assert(!errThrown)
}
})
})
describe('> when src is a symlink', () => {
it('should behave correctly based on the OS, symlink dir', () => {
src = path.join(TEST_DIR, 'srcdir')
fs.outputFileSync(path.join(src, 'subdir', 'file.txt'), 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
dest = path.join(TEST_DIR, 'src-Symlink')
let errThrown = false
try {
fs.copySync(srcLink, dest)
} catch (err) {
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
errThrown = true
}
}
if (platform === 'darwin' || platform === 'win32') assert(errThrown)
if (platform === 'linux') {
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(path.join(dest, 'subdir', 'file.txt'), 'utf8'), 'some data')
const destLink = fs.readlinkSync(dest)
assert.strictEqual(destLink, src)
assert(!errThrown)
}
})
it('should behave correctly based on the OS, symlink file', () => {
src = path.join(TEST_DIR, 'srcfile')
fs.outputFileSync(src, 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'file')
dest = path.join(TEST_DIR, 'src-Symlink')
let errThrown = false
try {
fs.copySync(srcLink, dest)
} catch (err) {
if (platform === 'darwin' || platform === 'win32') {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
errThrown = true
}
}
if (platform === 'darwin' || platform === 'win32') assert(errThrown)
if (platform === 'linux') {
assert(fs.existsSync(dest))
assert.strictEqual(fs.readFileSync(dest, 'utf8'), 'some data')
const destLink = fs.readlinkSync(dest)
assert.strictEqual(destLink, src)
assert(!errThrown)
}
})
})
})
================================================
FILE: lib/copy/__tests__/copy-sync-dir.test.js
================================================
'use strict'
const fs = require('../../')
const os = require('os')
const path = require('path')
const assert = require('assert')
const crypto = require('crypto')
/* global beforeEach, afterEach, describe, it */
describe('+ copySync() / dir', () => {
const SIZE = 16 * 64 * 1024 + 7
let TEST_DIR
let src, dest
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-dir')
src = path.join(TEST_DIR, 'src')
dest = path.join(TEST_DIR, 'dest')
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when src is a directory', () => {
describe('> when dest exists and is a file', () => {
it('should throw error', () => {
const src = path.join(TEST_DIR, 'src')
const dest = path.join(TEST_DIR, 'file.txt')
fs.mkdirSync(src)
fs.ensureFileSync(dest)
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, `Cannot overwrite non-directory '${dest}' with directory '${src}'.`)
}
})
})
it('should copy the directory synchronously', () => {
const FILES = 2
src = path.join(TEST_DIR, 'src')
dest = path.join(TEST_DIR, 'dest')
fs.mkdirSync(src)
for (let i = 0; i < FILES; ++i) {
fs.writeFileSync(path.join(src, i.toString()), crypto.randomBytes(SIZE))
}
const subdir = path.join(src, 'subdir')
fs.mkdirSync(subdir)
for (let i = 0; i < FILES; ++i) {
fs.writeFileSync(path.join(subdir, i.toString()), crypto.randomBytes(SIZE))
}
fs.copySync(src, dest)
assert(fs.existsSync(dest))
for (let i = 0; i < FILES; ++i) {
assert(fs.existsSync(path.join(dest, i.toString())))
}
const destSub = path.join(dest, 'subdir')
for (let j = 0; j < FILES; ++j) {
assert(fs.existsSync(path.join(destSub, j.toString())))
}
})
it('should preserve symbolic links', () => {
const srcTarget = path.join(TEST_DIR, 'destination')
fs.mkdirSync(src)
fs.mkdirSync(srcTarget)
fs.symlinkSync(srcTarget, path.join(src, 'symlink'), 'dir')
fs.copySync(src, dest)
const link = fs.readlinkSync(path.join(dest, 'symlink'))
assert.strictEqual(link, srcTarget)
})
describe('> when the destination dir does not exist', () => {
it('should create the destination directory and copy the file', () => {
const src = path.join(TEST_DIR, 'data/')
fs.mkdirSync(src)
const d1 = 'file1'
const d2 = 'file2'
fs.writeFileSync(path.join(src, 'f1.txt'), d1)
fs.writeFileSync(path.join(src, 'f2.txt'), d2)
const dest = path.join(TEST_DIR, 'this/path/does/not/exist/outputDir')
fs.copySync(src, dest)
const o1 = fs.readFileSync(path.join(dest, 'f1.txt'), 'utf8')
const o2 = fs.readFileSync(path.join(dest, 'f2.txt'), 'utf8')
assert.strictEqual(d1, o1)
assert.strictEqual(d2, o2)
})
})
})
describe('> when filter is used', () => {
it('should do nothing if filter fails', () => {
const srcDir = path.join(TEST_DIR, 'src')
const srcFile = path.join(srcDir, 'srcfile.css')
fs.outputFileSync(srcFile, 'src contents')
const destDir = path.join(TEST_DIR, 'dest')
const destFile = path.join(destDir, 'destfile.css')
const filter = s => path.extname(s) !== '.css' && !fs.statSync(s).isDirectory()
fs.copySync(srcFile, destFile, filter)
assert(!fs.existsSync(destDir))
})
it('should apply filter recursively', () => {
const FILES = 2
// Don't match anything that ends with a digit higher than 0:
const filter = s => /(0|\D)$/i.test(s)
fs.mkdirSync(src)
for (let i = 0; i < FILES; ++i) {
fs.writeFileSync(path.join(src, i.toString()), crypto.randomBytes(SIZE))
}
const subdir = path.join(src, 'subdir')
fs.mkdirSync(subdir)
for (let i = 0; i < FILES; ++i) {
fs.writeFileSync(path.join(subdir, i.toString()), crypto.randomBytes(SIZE))
}
fs.copySync(src, dest, filter)
assert(fs.existsSync(dest))
assert(FILES > 1)
for (let i = 0; i < FILES; ++i) {
if (i === 0) {
assert(fs.existsSync(path.join(dest, i.toString())))
} else {
assert(!fs.existsSync(path.join(dest, i.toString())))
}
}
const destSub = path.join(dest, 'subdir')
for (let j = 0; j < FILES; ++j) {
if (j === 0) {
assert(fs.existsSync(path.join(destSub, j.toString())))
} else {
assert(!fs.existsSync(path.join(destSub, j.toString())))
}
}
})
it('should apply the filter to directory names', () => {
const IGNORE = 'ignore'
const filter = p => !~p.indexOf(IGNORE)
fs.mkdirSync(src)
const ignoreDir = path.join(src, IGNORE)
fs.mkdirSync(ignoreDir)
fs.writeFileSync(path.join(ignoreDir, 'file'), crypto.randomBytes(SIZE))
fs.copySync(src, dest, filter)
assert(!fs.existsSync(path.join(dest, IGNORE)), 'directory was not ignored')
assert(!fs.existsSync(path.join(dest, IGNORE, 'file')), 'file was not ignored')
})
it('should apply filter when it is applied only to dest', done => {
const timeCond = new Date().getTime()
const filter = (s, d) => fs.statSync(d).mtime.getTime() < timeCond
const dest = path.join(TEST_DIR, 'dest')
setTimeout(() => {
fs.outputFileSync(path.join(src, 'somefile.html'), 'some data')
fs.mkdirSync(dest)
fs.copySync(src, dest, filter)
assert(!fs.existsSync(path.join(dest, 'somefile.html')))
done()
}, 1000)
})
it('should apply filter when it is applied to both src and dest', done => {
const timeCond = new Date().getTime()
const filter = (s, d) => s.split('.').pop() !== 'css' && fs.statSync(path.dirname(d)).mtime.getTime() > timeCond
const dest = path.join(TEST_DIR, 'dest')
setTimeout(() => {
const srcFile1 = path.join(TEST_DIR, '1.html')
const srcFile2 = path.join(TEST_DIR, '2.css')
const srcFile3 = path.join(TEST_DIR, '3.jade')
fs.writeFileSync(srcFile1, '')
fs.writeFileSync(srcFile2, '')
fs.writeFileSync(srcFile3, '')
const destFile1 = path.join(dest, 'dest1.html')
const destFile2 = path.join(dest, 'dest2.css')
const destFile3 = path.join(dest, 'dest3.jade')
fs.mkdirSync(dest)
fs.copySync(srcFile1, destFile1, filter)
fs.copySync(srcFile2, destFile2, filter)
fs.copySync(srcFile3, destFile3, filter)
assert(fs.existsSync(destFile1))
assert(!fs.existsSync(destFile2))
assert(fs.existsSync(destFile3))
done()
}, 1000)
})
})
})
================================================
FILE: lib/copy/__tests__/copy-sync-file.test.js
================================================
'use strict'
const fs = require('../../')
const os = require('os')
const path = require('path')
const assert = require('assert')
const crypto = require('crypto')
/* global afterEach, beforeEach, describe, it */
const SIZE = 16 * 64 * 1024 + 7
describe('+ copySync() / file', () => {
let TEST_DIR
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-file')
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when src is a file', () => {
describe('> when dest exists and is a directory', () => {
it('should throw error', () => {
const src = path.join(TEST_DIR, 'file.txt')
const dest = path.join(TEST_DIR, 'dir')
fs.ensureFileSync(src)
fs.ensureDirSync(dest)
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, `Cannot overwrite directory '${dest}' with non-directory '${src}'.`)
}
})
})
it('should copy the file synchronously', () => {
const fileSrc = path.join(TEST_DIR, 'TEST_fs-extra_src')
const fileDest = path.join(TEST_DIR, 'TEST_fs-extra_copy')
fs.writeFileSync(fileSrc, crypto.randomBytes(SIZE))
const srcMd5 = crypto.createHash('md5').update(fs.readFileSync(fileSrc)).digest('hex')
let destMd5 = ''
fs.copySync(fileSrc, fileDest)
destMd5 = crypto.createHash('md5').update(fs.readFileSync(fileDest)).digest('hex')
assert.strictEqual(srcMd5, destMd5)
})
it('should follow symlinks', () => {
const fileSrc = path.join(TEST_DIR, 'TEST_fs-extra_src')
const fileDest = path.join(TEST_DIR, 'TEST_fs-extra_copy')
const linkSrc = path.join(TEST_DIR, 'TEST_fs-extra_copy_link')
fs.writeFileSync(fileSrc, crypto.randomBytes(SIZE))
const srcMd5 = crypto.createHash('md5').update(fs.readFileSync(fileSrc)).digest('hex')
let destMd5 = ''
fs.symlinkSync(fileSrc, linkSrc)
fs.copySync(linkSrc, fileDest)
destMd5 = crypto.createHash('md5').update(fs.readFileSync(fileDest)).digest('hex')
assert.strictEqual(srcMd5, destMd5)
})
it('should maintain file mode', () => {
const fileSrc = path.join(TEST_DIR, 'TEST_fs-extra_src')
const fileDest = path.join(TEST_DIR, 'TEST_fs-extra_copy')
fs.writeFileSync(fileSrc, crypto.randomBytes(SIZE))
fs.chmodSync(fileSrc, 0o750)
fs.copySync(fileSrc, fileDest)
const statSrc = fs.statSync(fileSrc)
const statDest = fs.statSync(fileDest)
assert.strictEqual(statSrc.mode, statDest.mode)
})
it('should only copy files allowed by filter fn', () => {
const srcFile1 = path.join(TEST_DIR, '1.html')
const srcFile2 = path.join(TEST_DIR, '2.css')
const srcFile3 = path.join(TEST_DIR, '3.jade')
fs.writeFileSync(srcFile1, '')
fs.writeFileSync(srcFile2, '')
fs.writeFileSync(srcFile3, '')
const destFile1 = path.join(TEST_DIR, 'dest1.html')
const destFile2 = path.join(TEST_DIR, 'dest2.css')
const destFile3 = path.join(TEST_DIR, 'dest3.jade')
const filter = s => s.split('.').pop() !== 'css'
fs.copySync(srcFile1, destFile1, filter)
fs.copySync(srcFile2, destFile2, filter)
fs.copySync(srcFile3, destFile3, filter)
assert(fs.existsSync(destFile1))
assert(!fs.existsSync(destFile2))
assert(fs.existsSync(destFile3))
})
it('should not call filter fn more than needed', () => {
const src = path.join(TEST_DIR, 'foo')
fs.writeFileSync(src, '')
const dest = path.join(TEST_DIR, 'bar')
let filterCallCount = 0
const filter = () => {
filterCallCount++
return true
}
fs.copySync(src, dest, filter)
assert.strictEqual(filterCallCount, 1)
assert(fs.existsSync(dest))
})
describe('> when the destination dir does not exist', () => {
it('should create the destination directory and copy the file', () => {
const src = path.join(TEST_DIR, 'file.txt')
const dest = path.join(TEST_DIR, 'this/path/does/not/exist/copied.txt')
const data = 'did it copy?\n'
fs.writeFileSync(src, data, 'utf8')
fs.copySync(src, dest)
const data2 = fs.readFileSync(dest, 'utf8')
assert.strictEqual(data, data2)
})
})
describe('> when src file does not have write permissions', () => {
it('should be able to copy contents of file', () => {
const fileSrc = path.join(TEST_DIR, 'file.txt')
const fileDest = path.join(TEST_DIR, 'file-copy.txt')
const data = 'did it copy?'
fs.writeFileSync(fileSrc, data, 'utf8')
fs.chmodSync(fileSrc, '0444')
fs.copySync(fileSrc, fileDest)
const data2 = fs.readFileSync(fileDest, 'utf8')
assert.strictEqual(data, data2)
})
})
describe('> when overwrite option is passed', () => {
const srcData = 'some src data'
let src, dest
beforeEach(() => {
src = path.join(TEST_DIR, 'src-file')
dest = path.join(TEST_DIR, 'des-file')
// source file must always exist in these cases
fs.writeFileSync(src, srcData)
})
describe('> when destination file does NOT exist', () => {
describe('> when overwrite is true', () => {
it('should copy the file and not throw an error', () => {
fs.copySync(src, dest, { overwrite: true })
const destData = fs.readFileSync(dest, 'utf8')
assert.strictEqual(srcData, destData)
})
})
describe('> when overwrite is false', () => {
it('should copy the file and not throw an error', () => {
fs.copySync(src, dest, { overwrite: false })
const destData = fs.readFileSync(dest, 'utf8')
assert.strictEqual(srcData, destData)
})
})
})
describe('when destination file does exist', () => {
let destData
beforeEach(() => {
destData = 'some dest data'
fs.writeFileSync(dest, destData)
})
describe('> when overwrite is true', () => {
it('should copy the file and not throw an error', () => {
fs.copySync(src, dest, { overwrite: true })
destData = fs.readFileSync(dest, 'utf8')
assert.strictEqual(srcData, destData)
})
})
describe('> when overwrite is false', () => {
it('should not throw an error', () => {
fs.copySync(src, dest, { overwrite: false })
// copy never happened
const destDataNew = fs.readFileSync(dest, 'utf8')
assert.strictEqual(destData, destDataNew)
})
it('should throw an error when errorOnExist is true', () => {
assert.throws(() => fs.copySync(src, dest, { overwrite: false, errorOnExist: true }))
// copy never happened
const destDataNew = fs.readFileSync(dest, 'utf8')
assert.strictEqual(destData, destDataNew)
})
})
describe('> when overwrite is true and dest is readonly', () => {
it('should copy the file and not throw an error', () => {
try {
fs.chmodSync(dest, 0o444)
fs.copySync(src, dest, { overwrite: true })
destData = fs.readFileSync(dest, 'utf8')
assert.strictEqual(srcData, destData)
} finally {
// destination file is readonly so just remove it so we don't affect other tests
fs.unlinkSync(dest)
}
})
})
})
})
describe('clobber', () => {
let src, dest, srcData, destData
beforeEach(() => {
src = path.join(TEST_DIR, 'src-file')
dest = path.join(TEST_DIR, 'des-file')
srcData = 'some src data'
destData = 'some dest data'
fs.writeFileSync(src, srcData)
fs.writeFileSync(dest, destData)
})
it('is an alias for overwrite', () => {
fs.copySync(src, dest, { clobber: false })
// copy never happened
const destDataNew = fs.readFileSync(dest, 'utf8')
assert.strictEqual(destData, destDataNew)
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-sync-preserve-timestamp.test.js
================================================
'use strict'
const fs = require('../../')
const os = require('os')
const path = require('path')
const copySync = require('../copy-sync')
const utimesSync = require('../../util/utimes').utimesMillisSync
const assert = require('assert')
/* global beforeEach, afterEach, describe, it */
if (process.arch === 'ia32') console.warn('32 bit arch; skipping copySync timestamp tests')
const describeIfPractical = process.arch === 'ia32' ? describe.skip : describe
describeIfPractical('copySync() - preserveTimestamps option', () => {
let TEST_DIR, SRC, DEST, FILES
function setupFixture (readonly) {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-preserve-timestamp')
SRC = path.join(TEST_DIR, 'src')
DEST = path.join(TEST_DIR, 'dest')
FILES = ['a-file', path.join('a-folder', 'another-file'), path.join('a-folder', 'another-folder', 'file3')]
const timestamp = Date.now() / 1000 - 5
FILES.forEach(f => {
const filePath = path.join(SRC, f)
fs.ensureFileSync(filePath)
// rewind timestamps to make sure that coarser OS timestamp resolution
// does not alter results
utimesSync(filePath, timestamp, timestamp)
if (readonly) {
fs.chmodSync(filePath, 0o444)
}
})
}
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when preserveTimestamps option is true', () => {
;[
{ subcase: 'writable', readonly: false },
{ subcase: 'readonly', readonly: true }
].forEach(params => {
describe(`>> with ${params.subcase} source files`, () => {
beforeEach(() => setupFixture(params.readonly))
it('should have the same timestamps on copy', () => {
copySync(SRC, DEST, { preserveTimestamps: true })
FILES.forEach(testFile({ preserveTimestamps: true }))
})
})
})
})
function testFile (options) {
return function (file) {
const a = path.join(SRC, file)
const b = path.join(DEST, file)
const fromStat = fs.statSync(a)
const toStat = fs.statSync(b)
if (options.preserveTimestamps) {
// Windows sub-second precision fixed: https://github.com/nodejs/io.js/issues/2069
assert.strictEqual(toStat.mtime.getTime(), fromStat.mtime.getTime(), 'different mtime values')
assert.strictEqual(toStat.atime.getTime(), fromStat.atime.getTime(), 'different atime values')
} else {
// the access time might actually be the same, so check only modification time
assert.notStrictEqual(toStat.mtime.getTime(), fromStat.mtime.getTime(), 'same mtime values')
}
}
}
})
================================================
FILE: lib/copy/__tests__/copy-sync-prevent-copying-identical.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const klawSync = require('klaw-sync')
/* global beforeEach, afterEach, describe, it */
describe('+ copySync() - prevent copying identical files and dirs', () => {
let TEST_DIR = ''
let src = ''
let dest = ''
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-prevent-copying-identical')
fs.emptyDir(TEST_DIR, done)
})
afterEach(done => fs.remove(TEST_DIR, done))
it('should return an error if src and dest are the same', () => {
const fileSrc = path.join(TEST_DIR, 'TEST_fs-extra_copy_sync')
const fileDest = path.join(TEST_DIR, 'TEST_fs-extra_copy_sync')
fs.ensureFileSync(fileSrc)
try {
fs.copySync(fileSrc, fileDest)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
})
describe('dest with parent symlink', () => {
describe('first parent is symlink', () => {
it('should error when src is file', () => {
const src = path.join(TEST_DIR, 'a', 'file.txt')
const dest = path.join(TEST_DIR, 'b', 'file.txt')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureFileSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
} finally {
assert(fs.existsSync(src))
}
})
it('should error when src is directory', () => {
const src = path.join(TEST_DIR, 'a', 'foo')
const dest = path.join(TEST_DIR, 'b', 'foo')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureDirSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
} finally {
assert(fs.existsSync(src))
}
})
})
describe('nested dest', () => {
it('should error when src is file', () => {
const src = path.join(TEST_DIR, 'a', 'dir', 'file.txt')
const dest = path.join(TEST_DIR, 'b', 'dir', 'file.txt')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureFileSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
} finally {
assert(fs.existsSync(src))
}
})
it('should error when src is directory', () => {
const src = path.join(TEST_DIR, 'a', 'dir', 'foo')
const dest = path.join(TEST_DIR, 'b', 'dir', 'foo')
const srcParent = path.join(TEST_DIR, 'a')
const destParent = path.join(TEST_DIR, 'b')
fs.ensureDirSync(src)
fs.ensureSymlinkSync(srcParent, destParent, 'dir')
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
} finally {
assert(fs.existsSync(src))
}
})
})
})
// src is directory:
// src is regular, dest is symlink
// src is symlink, dest is regular
// src is symlink, dest is symlink
describe('> when src is a directory', () => {
describe('>> when src is regular and dest is a symlink that points to src', () => {
it('should error if dereference is true', () => {
src = path.join(TEST_DIR, 'src')
fs.mkdirsSync(src)
const subdir = path.join(TEST_DIR, 'src', 'subdir')
fs.mkdirsSync(subdir)
fs.writeFileSync(path.join(subdir, 'file.txt'), 'some data')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const oldlen = klawSync(src).length
try {
fs.copySync(src, destLink, { dereference: true })
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
const newlen = klawSync(src).length
assert.strictEqual(newlen, oldlen)
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
})
})
describe('>> when src is a symlink that points to a regular dest', () => {
it('should throw error', () => {
dest = path.join(TEST_DIR, 'dest')
fs.mkdirsSync(dest)
const subdir = path.join(TEST_DIR, 'dest', 'subdir')
fs.mkdirsSync(subdir)
fs.writeFileSync(path.join(subdir, 'file.txt'), 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(dest, srcLink, 'dir')
const oldlen = klawSync(dest).length
try {
fs.copySync(srcLink, dest)
} catch (err) {
assert(err)
}
// assert nothing copied
const newlen = klawSync(dest).length
assert.strictEqual(newlen, oldlen)
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, dest)
})
})
describe('>> when src and dest are symlinks that point to the exact same path', () => {
it('should error if src and dest are the same and dereferene is true', () => {
src = path.join(TEST_DIR, 'src')
fs.mkdirsSync(src)
const srcLink = path.join(TEST_DIR, 'src_symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest_symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(srcLink).length
const destlenBefore = klawSync(destLink).length
try {
fs.copySync(srcLink, destLink, { dereference: true })
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
const srclenAfter = klawSync(srcLink).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const destlenAfter = klawSync(destLink).length
assert.strictEqual(destlenAfter, destlenBefore, 'dest length should not change')
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
})
})
})
// src is file:
// src is regular, dest is symlink
// src is symlink, dest is regular
// src is symlink, dest is symlink
describe('> when src is a file', () => {
describe('>> when src is regular and dest is a symlink that points to src', () => {
it('should error if dereference is true', () => {
src = path.join(TEST_DIR, 'src', 'somefile.txt')
fs.ensureFileSync(src)
fs.writeFileSync(src, 'some data')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'file')
try {
fs.copySync(src, destLink, { dereference: true })
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
assert(fs.readFileSync(link, 'utf8'), 'some data')
})
})
describe('>> when src is a symlink that points to a regular dest', () => {
it('should throw error', () => {
dest = path.join(TEST_DIR, 'dest', 'somefile.txt')
fs.outputFileSync(dest, 'some data')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(dest, srcLink, 'file')
try {
fs.copySync(srcLink, dest)
} catch (err) {
assert.ok(err)
}
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, dest)
assert(fs.readFileSync(link, 'utf8'), 'some data')
})
})
describe('>> when src and dest are symlinks that point to the exact same path', () => {
it('should error if src and dest are the same and dereference is true', () => {
src = path.join(TEST_DIR, 'src', 'srcfile.txt')
fs.outputFileSync(src, 'src data')
const srcLink = path.join(TEST_DIR, 'src_symlink')
fs.symlinkSync(src, srcLink, 'file')
const destLink = path.join(TEST_DIR, 'dest_symlink')
fs.symlinkSync(src, destLink, 'file')
try {
fs.copySync(srcLink, destLink, { dereference: true })
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
assert(fs.readFileSync(srcln, 'utf8'), 'src data')
assert(fs.readFileSync(destln, 'utf8'), 'src data')
})
})
})
})
================================================
FILE: lib/copy/__tests__/copy-sync-prevent-copying-into-itself.test.js
================================================
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const klawSync = require('klaw-sync')
/* global beforeEach, afterEach, describe, it */
// these files are used for all tests
const FILES = [
'file0.txt',
path.join('dir1', 'file1.txt'),
path.join('dir1', 'dir2', 'file2.txt'),
path.join('dir1', 'dir2', 'dir3', 'file3.txt')
]
const dat0 = 'file0'
const dat1 = 'file1'
const dat2 = 'file2'
const dat3 = 'file3'
describe('+ copySync() - prevent copying into itself', ()
gitextract_ch38kmlm/ ├── .github/ │ ├── issue_template.md │ └── workflows/ │ └── ci.yml ├── .gitignore ├── .npmrc ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs/ │ ├── copy-sync.md │ ├── copy.md │ ├── emptyDir-sync.md │ ├── emptyDir.md │ ├── ensureDir-sync.md │ ├── ensureDir.md │ ├── ensureFile-sync.md │ ├── ensureFile.md │ ├── ensureLink-sync.md │ ├── ensureLink.md │ ├── ensureSymlink-sync.md │ ├── ensureSymlink.md │ ├── fs-read-write-writev.md │ ├── move-sync.md │ ├── move.md │ ├── outputFile-sync.md │ ├── outputFile.md │ ├── outputJson-sync.md │ ├── outputJson.md │ ├── pathExists-sync.md │ ├── pathExists.md │ ├── readJson-sync.md │ ├── readJson.md │ ├── remove-sync.md │ ├── remove.md │ ├── writeJson-sync.md │ └── writeJson.md ├── lib/ │ ├── __tests__/ │ │ └── promise.test.js │ ├── copy/ │ │ ├── __tests__/ │ │ │ ├── copy-broken-symlink.test.js │ │ │ ├── copy-case-insensitive-paths.test.js │ │ │ ├── copy-dev-null.test.js │ │ │ ├── copy-gh-89.test.js │ │ │ ├── copy-permissions.test.js │ │ │ ├── copy-preserve-timestamp.test.js │ │ │ ├── copy-prevent-copying-identical.test.js │ │ │ ├── copy-prevent-copying-into-itself.test.js │ │ │ ├── copy-readonly-dir.test.js │ │ │ ├── copy-symlink-same-target.test.js │ │ │ ├── copy-sync-broken-symlink.test.js │ │ │ ├── copy-sync-case-insensitive-paths.test.js │ │ │ ├── copy-sync-dir.test.js │ │ │ ├── copy-sync-file.test.js │ │ │ ├── copy-sync-preserve-timestamp.test.js │ │ │ ├── copy-sync-prevent-copying-identical.test.js │ │ │ ├── copy-sync-prevent-copying-into-itself.test.js │ │ │ ├── copy-sync-readonly-dir.test.js │ │ │ ├── copy-sync-symlink-same-target.test.js │ │ │ ├── copy-sync-symlink.test.js │ │ │ ├── copy.test.js │ │ │ └── ncp/ │ │ │ ├── README.md │ │ │ ├── broken-symlink.test.js │ │ │ ├── fixtures/ │ │ │ │ ├── modified-files/ │ │ │ │ │ ├── out/ │ │ │ │ │ │ └── a │ │ │ │ │ └── src/ │ │ │ │ │ └── a │ │ │ │ └── regular-fixtures/ │ │ │ │ ├── out/ │ │ │ │ │ ├── a │ │ │ │ │ ├── b │ │ │ │ │ ├── c │ │ │ │ │ ├── d │ │ │ │ │ ├── e │ │ │ │ │ ├── f │ │ │ │ │ └── sub/ │ │ │ │ │ ├── a │ │ │ │ │ └── b │ │ │ │ └── src/ │ │ │ │ ├── a │ │ │ │ ├── b │ │ │ │ ├── c │ │ │ │ ├── d │ │ │ │ ├── e │ │ │ │ ├── f │ │ │ │ └── sub/ │ │ │ │ ├── a │ │ │ │ └── b │ │ │ ├── ncp-error-perm.test.js │ │ │ ├── ncp.test.js │ │ │ └── symlink.test.js │ │ ├── copy-sync.js │ │ ├── copy.js │ │ └── index.js │ ├── empty/ │ │ ├── __tests__/ │ │ │ ├── empty-dir-sync.test.js │ │ │ └── empty-dir.test.js │ │ └── index.js │ ├── ensure/ │ │ ├── __tests__/ │ │ │ ├── create.test.js │ │ │ ├── ensure.test.js │ │ │ ├── link.test.js │ │ │ ├── symlink-paths.test.js │ │ │ ├── symlink-type.test.js │ │ │ └── symlink.test.js │ │ ├── file.js │ │ ├── index.js │ │ ├── link.js │ │ ├── symlink-paths.js │ │ ├── symlink-type.js │ │ └── symlink.js │ ├── esm.mjs │ ├── fs/ │ │ ├── __tests__/ │ │ │ ├── copyFile.test.js │ │ │ ├── fs-integration.test.js │ │ │ ├── multi-param.test.js │ │ │ ├── mz.test.js │ │ │ ├── realpath.test.js │ │ │ └── rm.test.js │ │ └── index.js │ ├── index.js │ ├── json/ │ │ ├── __tests__/ │ │ │ ├── jsonfile-integration.test.js │ │ │ ├── output-json-sync.test.js │ │ │ ├── output-json.test.js │ │ │ ├── promise-support.test.js │ │ │ └── read.test.js │ │ ├── index.js │ │ ├── jsonfile.js │ │ ├── output-json-sync.js │ │ └── output-json.js │ ├── mkdirs/ │ │ ├── __tests__/ │ │ │ ├── chmod.test.js │ │ │ ├── clobber.test.js │ │ │ ├── issue-209.test.js │ │ │ ├── issue-93.test.js │ │ │ ├── mkdir.test.js │ │ │ ├── mkdirp.test.js │ │ │ ├── opts-undef.test.js │ │ │ ├── perm.test.js │ │ │ ├── perm_sync.test.js │ │ │ ├── race.test.js │ │ │ ├── rel.test.js │ │ │ ├── root.test.js │ │ │ └── sync.test.js │ │ ├── index.js │ │ ├── make-dir.js │ │ └── utils.js │ ├── move/ │ │ ├── __tests__/ │ │ │ ├── cross-device-utils.js │ │ │ ├── move-case-insensitive-paths.test.js │ │ │ ├── move-preserve-timestamp.test.js │ │ │ ├── move-prevent-moving-identical.test.js │ │ │ ├── move-prevent-moving-into-itself.test.js │ │ │ ├── move-sync-case-insensitive-paths.test.js │ │ │ ├── move-sync-preserve-timestamp.test.js │ │ │ ├── move-sync-prevent-moving-identical.test.js │ │ │ ├── move-sync-prevent-moving-into-itself.test.js │ │ │ ├── move-sync.test.js │ │ │ └── move.test.js │ │ ├── index.js │ │ ├── move-sync.js │ │ └── move.js │ ├── output-file/ │ │ ├── __tests__/ │ │ │ └── output.test.js │ │ └── index.js │ ├── path-exists/ │ │ ├── __tests__/ │ │ │ ├── path-exists-sync.test.js │ │ │ └── path-exists.test.js │ │ └── index.js │ ├── remove/ │ │ ├── __tests__/ │ │ │ ├── remove-dir.test.js │ │ │ ├── remove-file.test.js │ │ │ ├── remove-sync-dir.test.js │ │ │ ├── remove-sync-file.test.js │ │ │ └── remove.test.js │ │ └── index.js │ └── util/ │ ├── __tests__/ │ │ ├── stat.test.js │ │ └── utimes.test.js │ ├── async.js │ ├── stat.js │ └── utimes.js ├── package.json ├── test/ │ └── readme.md ├── test.js └── test.mjs
SYMBOL INDEX (136 symbols across 48 files)
FILE: lib/copy/__tests__/copy-broken-symlink.test.js
function createFixtures (line 43) | function createFixtures (srcDir, callback) {
FILE: lib/copy/__tests__/copy-dev-null.test.js
constant TEST_DIR (line 11) | let TEST_DIR = ''
FILE: lib/copy/__tests__/copy-preserve-timestamp.test.js
function setupFixture (line 19) | function setupFixture (readonly) {
function testFile (line 58) | function testFile (options) {
FILE: lib/copy/__tests__/copy-prevent-copying-into-itself.test.js
constant FILES (line 12) | const FILES = [
function testSuccess (line 371) | function testSuccess (src, dest, done) {
function testError (line 392) | function testError (src, dest, done) {
FILE: lib/copy/__tests__/copy-readonly-dir.test.js
constant TEST_DIR (line 14) | let TEST_DIR = ''
constant FILES (line 16) | const FILES = [
FILE: lib/copy/__tests__/copy-sync-broken-symlink.test.js
function createFixtures (line 43) | function createFixtures (srcDir, callback) {
FILE: lib/copy/__tests__/copy-sync-file.test.js
constant SIZE (line 11) | const SIZE = 16 * 64 * 1024 + 7
FILE: lib/copy/__tests__/copy-sync-preserve-timestamp.test.js
function setupFixture (line 19) | function setupFixture (readonly) {
function testFile (line 55) | function testFile (options) {
FILE: lib/copy/__tests__/copy-sync-prevent-copying-into-itself.test.js
constant FILES (line 12) | const FILES = [
function testSuccess (line 398) | function testSuccess (src, dest) {
function testError (line 417) | function testError (src, dest) {
FILE: lib/copy/__tests__/copy-sync-readonly-dir.test.js
constant TEST_DIR (line 13) | let TEST_DIR = ''
constant FILES (line 15) | const FILES = [
FILE: lib/copy/__tests__/copy-sync-symlink.test.js
function createFixtures (line 53) | function createFixtures (srcDir, callback) {
FILE: lib/copy/__tests__/copy.test.js
constant SIZE (line 12) | const SIZE = 16 * 64 * 1024 + 7
constant TEST_DIR (line 13) | let TEST_DIR = ''
FILE: lib/copy/__tests__/ncp/broken-symlink.test.js
function createFixtures (line 41) | function createFixtures (srcDir, callback) {
FILE: lib/copy/__tests__/ncp/ncp.test.js
function filter (line 43) | function filter (files) {
function copyAssertAndCount (line 151) | function copyAssertAndCount (callback) {
function next (line 172) | function next () {
FILE: lib/copy/__tests__/ncp/symlink.test.js
function createFixtures (line 54) | function createFixtures (srcDir, callback) {
FILE: lib/copy/copy-sync.js
function copySync (line 9) | function copySync (src, dest, opts) {
function getStats (line 35) | function getStats (destStat, src, dest, opts) {
function onFile (line 49) | function onFile (srcStat, destStat, src, dest, opts) {
function mayCopyFile (line 54) | function mayCopyFile (srcStat, src, dest, opts) {
function copyFile (line 63) | function copyFile (srcStat, src, dest, opts) {
function handleTimestamps (line 69) | function handleTimestamps (srcMode, src, dest) {
function fileIsNotWritable (line 77) | function fileIsNotWritable (srcMode) {
function makeFileWritable (line 81) | function makeFileWritable (dest, srcMode) {
function setDestMode (line 85) | function setDestMode (dest, srcMode) {
function setDestTimestamps (line 89) | function setDestTimestamps (src, dest) {
function onDir (line 97) | function onDir (srcStat, destStat, src, dest, opts) {
function mkDirAndCopy (line 102) | function mkDirAndCopy (srcMode, src, dest, opts) {
function copyDir (line 108) | function copyDir (src, dest, opts) {
function copyDirItem (line 122) | function copyDirItem (item, src, dest, opts) {
function onLink (line 130) | function onLink (destStat, src, dest, opts) {
function copyLink (line 171) | function copyLink (resolvedSrc, dest) {
FILE: lib/copy/copy.js
function copy (line 11) | async function copy (src, dest, opts = {}) {
function runFilter (line 46) | async function runFilter (src, dest, opts) {
function getStatsAndPerformCopy (line 51) | async function getStatsAndPerformCopy (destStat, src, dest, opts) {
function onFile (line 69) | async function onFile (srcStat, destStat, src, dest, opts) {
function copyFile (line 81) | async function copyFile (srcStat, src, dest, opts) {
function fileIsNotWritable (line 103) | function fileIsNotWritable (srcMode) {
function makeFileWritable (line 107) | function makeFileWritable (dest, srcMode) {
function onDir (line 111) | async function onDir (srcStat, destStat, src, dest, opts) {
function onLink (line 137) | async function onLink (destStat, src, dest, opts) {
FILE: lib/empty/index.js
function emptyDirSync (line 20) | function emptyDirSync (dir) {
FILE: lib/ensure/__tests__/link.test.js
constant CWD (line 3) | const CWD = process.cwd()
function fileSuccess (line 70) | function fileSuccess (args, fn) {
function fileError (line 95) | function fileError (args, fn) {
function fileSuccessSync (line 113) | function fileSuccessSync (args, fn) {
function fileErrorSync (line 131) | function fileErrorSync (args, fn) {
FILE: lib/ensure/__tests__/symlink-paths.test.js
constant CWD (line 3) | const CWD = process.cwd()
constant TEST_DIR (line 13) | const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'ensure-symlink')
FILE: lib/ensure/__tests__/symlink-type.test.js
constant CWD (line 3) | const CWD = process.cwd()
constant TEST_DIR (line 13) | const TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'ensure-symlink')
FILE: lib/ensure/__tests__/symlink.test.js
constant CWD (line 3) | const CWD = process.cwd()
constant TEST_DIR (line 17) | let TEST_DIR
function fileSuccess (line 87) | function fileSuccess (args, fn) {
function fileBroken (line 109) | function fileBroken (args, fn) {
function fileError (line 128) | function fileError (args, fn) {
function dirSuccess (line 144) | function dirSuccess (args, fn) {
function dirBroken (line 166) | function dirBroken (args, fn) {
function dirError (line 185) | function dirError (args, fn) {
function fileSuccessSync (line 201) | function fileSuccessSync (args, fn) {
function fileBrokenSync (line 219) | function fileBrokenSync (args, fn) {
function fileErrorSync (line 234) | function fileErrorSync (args, fn) {
function dirSuccessSync (line 251) | function dirSuccessSync (args, fn) {
function dirBrokenSync (line 269) | function dirBrokenSync (args, fn) {
function dirErrorSync (line 284) | function dirErrorSync (args, fn) {
FILE: lib/ensure/file.js
function createFile (line 8) | async function createFile (file) {
function createFileSync (line 40) | function createFileSync (file) {
FILE: lib/ensure/link.js
function createLink (line 10) | async function createLink (srcpath, dstpath) {
function createLinkSync (line 39) | function createLinkSync (srcpath, dstpath) {
FILE: lib/ensure/symlink-paths.js
function symlinkPaths (line 31) | async function symlinkPaths (srcpath, dstpath) {
function symlinkPathsSync (line 70) | function symlinkPathsSync (srcpath, dstpath) {
FILE: lib/ensure/symlink-type.js
function symlinkType (line 6) | async function symlinkType (srcpath, type) {
function symlinkTypeSync (line 19) | function symlinkTypeSync (srcpath, type) {
FILE: lib/ensure/symlink.js
function createSymlink (line 16) | async function createSymlink (srcpath, dstpath, type) {
function createSymlinkSync (line 54) | function createSymlinkSync (srcpath, dstpath, type) {
FILE: lib/fs/__tests__/multi-param.test.js
constant SIZE (line 9) | const SIZE = 1000
FILE: lib/json/output-json-sync.js
function outputJsonSync (line 6) | function outputJsonSync (file, data, options) {
FILE: lib/json/output-json.js
function outputJson (line 6) | async function outputJson (file, data, options = {}) {
FILE: lib/mkdirs/__tests__/race.test.js
function mk (line 40) | function mk (file, callback) {
FILE: lib/mkdirs/__tests__/rel.test.js
constant CWD (line 3) | const CWD = process.cwd()
FILE: lib/move/__tests__/move-preserve-timestamp.test.js
function setupFixture (line 20) | function setupFixture (readonly) {
function testFile (line 70) | function testFile (options, originalTimestamps) {
FILE: lib/move/__tests__/move-prevent-moving-into-itself.test.js
constant FILES (line 12) | const FILES = [
function testSuccessFile (line 317) | function testSuccessFile (src, destFile, done) {
function testSuccessDir (line 329) | function testSuccessDir (src, dest, done) {
function testError (line 354) | function testError (src, dest, done) {
FILE: lib/move/__tests__/move-sync-preserve-timestamp.test.js
function setupFixture (line 20) | function setupFixture (readonly) {
function testFile (line 67) | function testFile (options, originalTimestamps) {
FILE: lib/move/__tests__/move-sync-prevent-moving-into-itself.test.js
constant FILES (line 12) | const FILES = [
function testSuccessFile (line 357) | function testSuccessFile (src, destFile) {
function testSuccessDir (line 366) | function testSuccessDir (src, dest) {
function testError (line 388) | function testError (src, dest) {
FILE: lib/move/__tests__/move-sync.test.js
function createSyncErrFn (line 16) | function createSyncErrFn (errCode) {
function setUpMockFs (line 27) | function setUpMockFs (errCode) {
function tearDownMockFs (line 31) | function tearDownMockFs () {
FILE: lib/move/__tests__/move.test.js
function createAsyncErrFn (line 14) | function createAsyncErrFn (errCode) {
function setUpMockFs (line 28) | function setUpMockFs (errCode) {
function tearDownMockFs (line 32) | function tearDownMockFs () {
FILE: lib/move/move-sync.js
function moveSync (line 10) | function moveSync (src, dest, opts) {
function isParentRoot (line 20) | function isParentRoot (dest) {
function doRename (line 26) | function doRename (src, dest, overwrite, isChangingCase) {
function rename (line 36) | function rename (src, dest, overwrite) {
function moveAcrossDevice (line 45) | function moveAcrossDevice (src, dest, overwrite) {
FILE: lib/move/move.js
function move (line 11) | async function move (src, dest, opts = {}) {
function doRename (line 28) | async function doRename (src, dest, overwrite, isChangingCase) {
function moveAcrossDevice (line 48) | async function moveAcrossDevice (src, dest, overwrite) {
FILE: lib/output-file/index.js
function outputFile (line 9) | async function outputFile (file, data, encoding = 'utf-8') {
function outputFileSync (line 19) | function outputFileSync (file, ...args) {
FILE: lib/path-exists/index.js
function pathExists (line 5) | function pathExists (path) {
FILE: lib/remove/__tests__/remove.test.js
constant TEST_DIR (line 12) | let TEST_DIR
function buildFixtureDir (line 14) | function buildFixtureDir () {
FILE: lib/remove/index.js
function remove (line 6) | function remove (path, callback) {
function removeSync (line 10) | function removeSync (path) {
FILE: lib/util/__tests__/utimes.test.js
function hasMillisResSync (line 17) | function hasMillisResSync () {
FILE: lib/util/async.js
function asyncIteratorConcurrentProcess (line 8) | async function asyncIteratorConcurrentProcess (iterator, fn) {
FILE: lib/util/stat.js
function getStats (line 7) | function getStats (src, dest, opts) {
function getStatsSync (line 20) | function getStatsSync (src, dest, opts) {
function checkPaths (line 35) | async function checkPaths (src, dest, funcName, opts) {
function checkPathsSync (line 63) | function checkPathsSync (src, dest, funcName, opts) {
function checkParentPaths (line 95) | async function checkParentPaths (src, srcStat, dest, funcName) {
function checkParentPathsSync (line 115) | function checkParentPathsSync (src, srcStat, dest, funcName) {
function areIdentical (line 132) | function areIdentical (srcStat, destStat) {
function isSrcSubdir (line 139) | function isSrcSubdir (src, dest) {
function errMsg (line 145) | function errMsg (src, dest, funcName) {
FILE: lib/util/utimes.js
function utimesMillis (line 6) | async function utimesMillis (path, atime, mtime) {
function utimesMillisSync (line 27) | function utimesMillisSync (path, atime, mtime) {
Condensed preview — 165 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (492K chars).
[
{
"path": ".github/issue_template.md",
"chars": 364,
"preview": "<!-- First ensure you installed the latest version of fs-extra -->\n<!-- If your bug still exists please fill out the fol"
},
{
"path": ".github/workflows/ci.yml",
"chars": 533,
"preview": "name: Node.js CI\non:\n push:\n branches: master\n pull_request:\n\npermissions:\n contents: read # to fetch code (actio"
},
{
"path": ".gitignore",
"chars": 64,
"preview": ".nyc_output/\ncoverage/\nnode_modules/\n\n.idea\n*.iml\nnpm-debug.log\n"
},
{
"path": ".npmrc",
"chars": 19,
"preview": "package-lock=false\n"
},
{
"path": "CHANGELOG.md",
"chars": 72178,
"preview": "11.3.4 / 2026-03-03\n-------------------\n\n- Fix bug where calling `ensureSymlink`/`ensureSymlinkSync` with a relative `sr"
},
{
"path": "LICENSE",
"chars": 1084,
"preview": "(The MIT License)\n\nCopyright (c) 2011-2024 JP Richardson\n\nPermission is hereby granted, free of charge, to any person ob"
},
{
"path": "README.md",
"chars": 10773,
"preview": "Node.js: fs-extra\n=================\n\n`fs-extra` adds file system methods that aren't included in the native `fs` module "
},
{
"path": "docs/copy-sync.md",
"chars": 1710,
"preview": "# copySync(src, dest[, options])\n\nCopy a file or directory. The directory can have contents.\n\n- `src` `<String>` Note th"
},
{
"path": "docs/copy.md",
"chars": 2436,
"preview": "# copy(src, dest[, options][, callback])\n\nCopy a file or directory. The directory can have contents.\n\n- `src` `<String>`"
},
{
"path": "docs/emptyDir-sync.md",
"chars": 393,
"preview": "# emptyDirSync(dir)\n\nEnsures that a directory is empty. Deletes directory contents if the directory is not empty. If the"
},
{
"path": "docs/emptyDir.md",
"chars": 848,
"preview": "# emptyDir(dir[, callback])\n\nEnsures that a directory is empty. Deletes directory contents if the directory is not empty"
},
{
"path": "docs/ensureDir-sync.md",
"chars": 920,
"preview": "# ensureDirSync(dir[,options])\n\nEnsures that the directory exists. If the directory structure does not exist, it is crea"
},
{
"path": "docs/ensureDir.md",
"chars": 1602,
"preview": "# ensureDir(dir[,options][,callback])\n\nEnsures that the directory exists. If the directory structure does not exist, it "
},
{
"path": "docs/ensureFile-sync.md",
"chars": 480,
"preview": "# ensureFileSync(file)\n\nEnsures that the file exists. If the file that is requested to be created is in directories that"
},
{
"path": "docs/ensureFile.md",
"chars": 889,
"preview": "# ensureFile(file[, callback])\n\nEnsures that the file exists. If the file that is requested to be created is in director"
},
{
"path": "docs/ensureLink-sync.md",
"chars": 463,
"preview": "# ensureLinkSync(srcPath, destPath)\n\nEnsures that the link exists. If the directory structure does not exist, it is crea"
},
{
"path": "docs/ensureLink.md",
"chars": 914,
"preview": "# ensureLink(srcPath, destPath[, callback])\n\nEnsures that the link exists. If the directory structure does not exist, it"
},
{
"path": "docs/ensureSymlink-sync.md",
"chars": 617,
"preview": "# ensureSymlinkSync(srcPath, destPath[, type])\n\nEnsures that the symlink exists. If the directory structure does not exi"
},
{
"path": "docs/ensureSymlink.md",
"chars": 1074,
"preview": "# ensureSymlink(srcPath, destPath[, type][, callback])\n\nEnsures that the symlink exists. If the directory structure does"
},
{
"path": "docs/fs-read-write-writev.md",
"chars": 1626,
"preview": "# About `fs.read()` & `fs.write()`\n\n[`fs.read()`](https://nodejs.org/api/fs.html#fs_fs_read_fd_buffer_offset_length_posi"
},
{
"path": "docs/move-sync.md",
"chars": 618,
"preview": "# moveSync(src, dest[, options])\n\nMoves a file or directory, even across devices.\n\n- `src` `<String>`\n- `dest` `<String>"
},
{
"path": "docs/move.md",
"chars": 1187,
"preview": "# move(src, dest[, options][, callback])\n\nMoves a file or directory, even across devices.\n\n- `src` `<String>`\n- `dest` `"
},
{
"path": "docs/outputFile-sync.md",
"chars": 674,
"preview": "# outputFileSync(file, data[, options])\n\nAlmost the same as `writeFileSync` (i.e. it overwrites), except that if the par"
},
{
"path": "docs/outputFile.md",
"chars": 1255,
"preview": "# outputFile(file, data[, options][, callback])\n\nAlmost the same as `writeFile` (i.e. it overwrites), except that if the"
},
{
"path": "docs/outputJson-sync.md",
"chars": 1083,
"preview": "# outputJsonSync(file, object[, options])\n\nAlmost the same as [`writeJsonSync`](writeJson-sync.md), except that if the d"
},
{
"path": "docs/outputJson.md",
"chars": 1649,
"preview": "# outputJson(file, object[, options][, callback])\n\nAlmost the same as [`writeJson`](writeJson.md), except that if the di"
},
{
"path": "docs/pathExists-sync.md",
"chars": 174,
"preview": "# pathExistsSync(file)\n\nAn alias for [`fs.existsSync()`](https://nodejs.org/api/fs.html#fs_fs_existssync_path), created "
},
{
"path": "docs/pathExists.md",
"chars": 834,
"preview": "# pathExists(file[, callback])\n\nTest whether or not the given path exists by checking with the file system. Like [`fs.ex"
},
{
"path": "docs/readJson-sync.md",
"chars": 778,
"preview": "# readJsonSync(file[, options])\n\nReads a JSON file and then parses it into an object.\n\n**Alias:** `readJSONSync()`\n\n- `f"
},
{
"path": "docs/readJson.md",
"chars": 1649,
"preview": "# readJson(file[, options][, callback])\n\nReads a JSON file and then parses it into an object.\n\n**Alias:** `readJSON()`\n\n"
},
{
"path": "docs/remove-sync.md",
"chars": 335,
"preview": "# removeSync(path)\n\nRemoves a file or directory. The directory can have contents. If the path does not exist, silently d"
},
{
"path": "docs/remove.md",
"chars": 866,
"preview": "# remove(path[, callback])\n\nRemoves a file or directory. The directory can have contents. If the path does not exist, si"
},
{
"path": "docs/writeJson-sync.md",
"chars": 952,
"preview": "# writeJsonSync(file, object[, options])\n\nWrites an object to a JSON file.\n\n**Alias:** `writeJSONSync()`\n\n- `file` `<Str"
},
{
"path": "docs/writeJson.md",
"chars": 1444,
"preview": "# writeJson(file, object[, options][, callback])\n\nWrites an object to a JSON file.\n\n**Alias:** `writeJSON()`\n\n- `file` `"
},
{
"path": "lib/__tests__/promise.test.js",
"chars": 503,
"preview": "'use strict'\n\n/* eslint-env mocha */\n\nconst assert = require('assert')\nconst fse = require('..')\n\nconst methods = [\n 'e"
},
{
"path": "lib/copy/__tests__/copy-broken-symlink.test.js",
"chars": 1543,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/copy/__tests__/copy-case-insensitive-paths.test.js",
"chars": 3635,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-dev-null.test.js",
"chars": 886,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require('path"
},
{
"path": "lib/copy/__tests__/copy-gh-89.test.js",
"chars": 1420,
"preview": "'use strict'\n\n// relevant: https://github.com/jprichardson/node-fs-extra/issues/89\n// come up with better file name\n\ncon"
},
{
"path": "lib/copy/__tests__/copy-permissions.test.js",
"chars": 3302,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require('path"
},
{
"path": "lib/copy/__tests__/copy-preserve-timestamp.test.js",
"chars": 2655,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst { copy } = requir"
},
{
"path": "lib/copy/__tests__/copy-prevent-copying-identical.test.js",
"chars": 8902,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-prevent-copying-into-itself.test.js",
"chars": 14656,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-readonly-dir.test.js",
"chars": 1751,
"preview": "'use strict'\n\n// relevant: https://github.com/jprichardson/node-fs-extra/issues/599\n\nconst fs = require('../../')\nconst "
},
{
"path": "lib/copy/__tests__/copy-symlink-same-target.test.js",
"chars": 7886,
"preview": "'use strict'\n\nconst os = require('os')\nconst fs = require('../..')\nconst path = require('path')\nconst assert = require('"
},
{
"path": "lib/copy/__tests__/copy-sync-broken-symlink.test.js",
"chars": 1581,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/copy/__tests__/copy-sync-case-insensitive-paths.test.js",
"chars": 4160,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-sync-dir.test.js",
"chars": 6900,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst assert = require("
},
{
"path": "lib/copy/__tests__/copy-sync-file.test.js",
"chars": 8302,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst assert = require("
},
{
"path": "lib/copy/__tests__/copy-sync-preserve-timestamp.test.js",
"chars": 2603,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst copySync = requir"
},
{
"path": "lib/copy/__tests__/copy-sync-prevent-copying-identical.test.js",
"chars": 9211,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-sync-prevent-copying-into-itself.test.js",
"chars": 15368,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/copy/__tests__/copy-sync-readonly-dir.test.js",
"chars": 1652,
"preview": "'use strict'\n\n// relevant: https://github.com/jprichardson/node-fs-extra/issues/599\n\nconst os = require('os')\nconst fs ="
},
{
"path": "lib/copy/__tests__/copy-sync-symlink-same-target.test.js",
"chars": 7553,
"preview": "'use strict'\n\nconst os = require('os')\nconst fs = require('../..')\nconst path = require('path')\nconst assert = require('"
},
{
"path": "lib/copy/__tests__/copy-sync-symlink.test.js",
"chars": 2272,
"preview": "'use strict'\n\nconst os = require('os')\nconst fs = require('../..')\nconst path = require('path')\nconst assert = require('"
},
{
"path": "lib/copy/__tests__/copy.test.js",
"chars": 15170,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require('path"
},
{
"path": "lib/copy/__tests__/ncp/README.md",
"chars": 71,
"preview": "These tests came from: https://github.com/AvianFlu/ncp/tree/v1.0.1/test"
},
{
"path": "lib/copy/__tests__/ncp/broken-symlink.test.js",
"chars": 1485,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../..')\nconst { copy: ncp } = re"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/modified-files/out/a",
"chars": 5,
"preview": "test2"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/modified-files/src/a",
"chars": 5,
"preview": "test3"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/a",
"chars": 12,
"preview": "Hello world\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/b",
"chars": 10,
"preview": "Hello ncp\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/c",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/d",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/e",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/f",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/sub/a",
"chars": 16,
"preview": "Hello nodejitsu\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/out/sub/b",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/a",
"chars": 12,
"preview": "Hello world\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/b",
"chars": 10,
"preview": "Hello ncp\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/c",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/d",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/e",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/f",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/sub/a",
"chars": 16,
"preview": "Hello nodejitsu\n"
},
{
"path": "lib/copy/__tests__/ncp/fixtures/regular-fixtures/src/sub/b",
"chars": 0,
"preview": ""
},
{
"path": "lib/copy/__tests__/ncp/ncp-error-perm.test.js",
"chars": 1440,
"preview": "'use strict'\n\n// file in reference: https://github.com/jprichardson/node-fs-extra/issues/56\n\nconst fs = require('fs')\nco"
},
{
"path": "lib/copy/__tests__/ncp/ncp.test.js",
"chars": 5245,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst { copy: ncp } = require('../../')\nconst path = require('path')\nconst rimraf"
},
{
"path": "lib/copy/__tests__/ncp/symlink.test.js",
"chars": 2297,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../..')\nconst { copy: ncp } = re"
},
{
"path": "lib/copy/copy-sync.js",
"chars": 5929,
"preview": "'use strict'\n\nconst fs = require('graceful-fs')\nconst path = require('path')\nconst mkdirsSync = require('../mkdirs').mkd"
},
{
"path": "lib/copy/copy.js",
"chars": 5988,
"preview": "'use strict'\n\nconst fs = require('../fs')\nconst path = require('path')\nconst { mkdirs } = require('../mkdirs')\nconst { p"
},
{
"path": "lib/copy/index.js",
"chars": 146,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nmodule.exports = {\n copy: u(require('./copy')),\n copySync:"
},
{
"path": "lib/empty/__tests__/empty-dir-sync.test.js",
"chars": 1588,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/empty/__tests__/empty-dir.test.js",
"chars": 1771,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/empty/index.js",
"chars": 747,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst fs = require('../fs')\nconst path = require('path')\ncon"
},
{
"path": "lib/ensure/__tests__/create.test.js",
"chars": 3065,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/ensure/__tests__/ensure.test.js",
"chars": 3921,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/ensure/__tests__/link.test.js",
"chars": 8124,
"preview": "'use strict'\n\nconst CWD = process.cwd()\n\nconst fs = require('graceful-fs')\nconst os = require('os')\nconst fse = require("
},
{
"path": "lib/ensure/__tests__/symlink-paths.test.js",
"chars": 3255,
"preview": "'use strict'\n\nconst CWD = process.cwd()\n\nconst fs = require('graceful-fs')\nconst os = require('os')\nconst fse = require("
},
{
"path": "lib/ensure/__tests__/symlink-type.test.js",
"chars": 3962,
"preview": "'use strict'\n\nconst CWD = process.cwd()\n\nconst fs = require('graceful-fs')\nconst os = require('os')\nconst fse = require("
},
{
"path": "lib/ensure/__tests__/symlink.test.js",
"chars": 16954,
"preview": "'use strict'\n\nconst CWD = process.cwd()\n\nconst fs = require('graceful-fs')\nconst os = require('os')\nconst fse = require("
},
{
"path": "lib/ensure/file.js",
"chars": 1459,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst path = require('path')\nconst fs = require('../fs')\ncon"
},
{
"path": "lib/ensure/index.js",
"chars": 542,
"preview": "'use strict'\n\nconst { createFile, createFileSync } = require('./file')\nconst { createLink, createLinkSync } = require('."
},
{
"path": "lib/ensure/link.js",
"chars": 1366,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst path = require('path')\nconst fs = require('../fs')\ncon"
},
{
"path": "lib/ensure/symlink-paths.js",
"chars": 3103,
"preview": "'use strict'\n\nconst path = require('path')\nconst fs = require('../fs')\nconst { pathExists } = require('../path-exists')\n"
},
{
"path": "lib/ensure/symlink-type.js",
"chars": 596,
"preview": "'use strict'\n\nconst fs = require('../fs')\nconst u = require('universalify').fromPromise\n\nasync function symlinkType (src"
},
{
"path": "lib/ensure/symlink.js",
"chars": 2586,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst path = require('path')\nconst fs = require('../fs')\n\nco"
},
{
"path": "lib/esm.mjs",
"chars": 2643,
"preview": "import _copy from './copy/index.js'\nimport _empty from './empty/index.js'\nimport _ensure from './ensure/index.js'\nimport"
},
{
"path": "lib/fs/__tests__/copyFile.test.js",
"chars": 699,
"preview": "'use strict'\n\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path')\nconst assert = require("
},
{
"path": "lib/fs/__tests__/fs-integration.test.js",
"chars": 768,
"preview": "'use strict'\n\nconst os = require('os')\nconst fs = require('fs')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/fs/__tests__/multi-param.test.js",
"chars": 8951,
"preview": "'use strict'\n/* eslint-env mocha */\nconst assert = require('assert')\nconst path = require('path')\nconst crypto = require"
},
{
"path": "lib/fs/__tests__/mz.test.js",
"chars": 1213,
"preview": "'use strict'\n// This is adapted from https://github.com/normalize/mz\n// Copyright (c) 2014-2016 Jonathan Ong me@jonglebe"
},
{
"path": "lib/fs/__tests__/realpath.test.js",
"chars": 1902,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst path = require('path')\nconst assert = require('assert')\n\n/* eslint-env moch"
},
{
"path": "lib/fs/__tests__/rm.test.js",
"chars": 547,
"preview": "'use strict'\n\nconst fse = require('../..')\nconst os = require('os')\nconst path = require('path')\nconst assert = require("
},
{
"path": "lib/fs/index.js",
"chars": 3835,
"preview": "'use strict'\n// This is adapted from https://github.com/normalize/mz\n// Copyright (c) 2014-2016 Jonathan Ong me@jonglebe"
},
{
"path": "lib/index.js",
"chars": 358,
"preview": "'use strict'\n\nmodule.exports = {\n // Export promiseified graceful-fs:\n ...require('./fs'),\n // Export extra methods:\n"
},
{
"path": "lib/json/__tests__/jsonfile-integration.test.js",
"chars": 1315,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/json/__tests__/output-json-sync.test.js",
"chars": 1427,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/json/__tests__/output-json.test.js",
"chars": 2466,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/json/__tests__/promise-support.test.js",
"chars": 927,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/json/__tests__/read.test.js",
"chars": 1198,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/json/index.js",
"chars": 508,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst jsonFile = require('./jsonfile')\n\njsonFile.outputJson "
},
{
"path": "lib/json/jsonfile.js",
"chars": 238,
"preview": "'use strict'\n\nconst jsonFile = require('jsonfile')\n\nmodule.exports = {\n // jsonfile exports\n readJson: jsonFile.readFi"
},
{
"path": "lib/json/output-json-sync.js",
"chars": 276,
"preview": "'use strict'\n\nconst { stringify } = require('jsonfile/utils')\nconst { outputFileSync } = require('../output-file')\n\nfunc"
},
{
"path": "lib/json/output-json.js",
"chars": 277,
"preview": "'use strict'\n\nconst { stringify } = require('jsonfile/utils')\nconst { outputFile } = require('../output-file')\n\nasync fu"
},
{
"path": "lib/mkdirs/__tests__/chmod.test.js",
"chars": 1600,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require('path"
},
{
"path": "lib/mkdirs/__tests__/clobber.test.js",
"chars": 1086,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/issue-209.test.js",
"chars": 911,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst fse = require('../..')\n\n/* global describe, it */\n\ndescribe('mkdirp"
},
{
"path": "lib/mkdirs/__tests__/issue-93.test.js",
"chars": 1184,
"preview": "'use strict'\n\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path')\nconst assert = require("
},
{
"path": "lib/mkdirs/__tests__/mkdir.test.js",
"chars": 1705,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/mkdirp.test.js",
"chars": 1285,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/opts-undef.test.js",
"chars": 695,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/perm.test.js",
"chars": 1247,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require('path"
},
{
"path": "lib/mkdirs/__tests__/perm_sync.test.js",
"chars": 1410,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/race.test.js",
"chars": 1493,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/__tests__/rel.test.js",
"chars": 1503,
"preview": "'use strict'\n\nconst CWD = process.cwd()\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\n"
},
{
"path": "lib/mkdirs/__tests__/root.test.js",
"chars": 639,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst fse = require('../../')\nconst path = require('path')\nconst assert = require"
},
{
"path": "lib/mkdirs/__tests__/sync.test.js",
"chars": 1431,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/mkdirs/index.js",
"chars": 328,
"preview": "'use strict'\nconst u = require('universalify').fromPromise\nconst { makeDir: _makeDir, makeDirSync } = require('./make-di"
},
{
"path": "lib/mkdirs/make-dir.js",
"chars": 545,
"preview": "'use strict'\nconst fs = require('../fs')\nconst { checkPath } = require('./utils')\n\nconst getMode = options => {\n const "
},
{
"path": "lib/mkdirs/utils.js",
"chars": 1655,
"preview": "// Adapted from https://github.com/sindresorhus/make-dir\n// Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindre"
},
{
"path": "lib/move/__tests__/cross-device-utils.js",
"chars": 593,
"preview": "const fs = require('graceful-fs')\nconst path = require('path')\n\nconst { CROSS_DEVICE_PATH } = process.env\nlet runCrossDe"
},
{
"path": "lib/move/__tests__/move-case-insensitive-paths.test.js",
"chars": 2684,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-preserve-timestamp.test.js",
"chars": 2804,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst utimesSync = requ"
},
{
"path": "lib/move/__tests__/move-prevent-moving-identical.test.js",
"chars": 8922,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-prevent-moving-into-itself.test.js",
"chars": 13023,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-sync-case-insensitive-paths.test.js",
"chars": 2429,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-sync-preserve-timestamp.test.js",
"chars": 2816,
"preview": "'use strict'\n\nconst fs = require('../../')\nconst os = require('os')\nconst path = require('path')\nconst utimesSync = requ"
},
{
"path": "lib/move/__tests__/move-sync-prevent-moving-identical.test.js",
"chars": 9209,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-sync-prevent-moving-into-itself.test.js",
"chars": 14227,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst os = require('os')\nconst path = require('path')\nconst fs = require("
},
{
"path": "lib/move/__tests__/move-sync.test.js",
"chars": 8845,
"preview": "'use strict'\n\n// TODO: enable this once graceful-fs supports bigint option.\n// const fs = require('graceful-fs')\nconst f"
},
{
"path": "lib/move/__tests__/move.test.js",
"chars": 11802,
"preview": "'use strict'\n\nconst fs = require('../../fs')\nconst os = require('os')\nconst fse = require('../../')\nconst path = require"
},
{
"path": "lib/move/index.js",
"chars": 146,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nmodule.exports = {\n move: u(require('./move')),\n moveSync:"
},
{
"path": "lib/move/move-sync.js",
"chars": 1515,
"preview": "'use strict'\n\nconst fs = require('graceful-fs')\nconst path = require('path')\nconst copySync = require('../copy').copySyn"
},
{
"path": "lib/move/move.js",
"chars": 1523,
"preview": "'use strict'\n\nconst fs = require('../fs')\nconst path = require('path')\nconst { copy } = require('../copy')\nconst { remov"
},
{
"path": "lib/output-file/__tests__/output.test.js",
"chars": 2502,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/output-file/index.js",
"chars": 657,
"preview": "'use strict'\n\nconst u = require('universalify').fromPromise\nconst fs = require('../fs')\nconst path = require('path')\ncon"
},
{
"path": "lib/path-exists/__tests__/path-exists-sync.test.js",
"chars": 678,
"preview": "'use strict'\n/* eslint-env mocha */\n\nconst fs = require('../..')\nconst path = require('path')\nconst os = require('os')\nc"
},
{
"path": "lib/path-exists/__tests__/path-exists.test.js",
"chars": 1006,
"preview": "'use strict'\n/* eslint-env mocha */\n\nconst fs = require('../..')\nconst path = require('path')\nconst os = require('os')\nc"
},
{
"path": "lib/path-exists/index.js",
"chars": 263,
"preview": "'use strict'\nconst u = require('universalify').fromPromise\nconst fs = require('../fs')\n\nfunction pathExists (path) {\n r"
},
{
"path": "lib/remove/__tests__/remove-dir.test.js",
"chars": 691,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/remove/__tests__/remove-file.test.js",
"chars": 8,
"preview": "// todo\n"
},
{
"path": "lib/remove/__tests__/remove-sync-dir.test.js",
"chars": 847,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/remove/__tests__/remove-sync-file.test.js",
"chars": 656,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/remove/__tests__/remove.test.js",
"chars": 3413,
"preview": "'use strict'\n\nconst assert = require('assert')\nconst fs = require('fs')\nconst os = require('os')\nconst path = require('p"
},
{
"path": "lib/remove/index.js",
"chars": 331,
"preview": "'use strict'\n\nconst fs = require('graceful-fs')\nconst u = require('universalify').fromCallback\n\nfunction remove (path, c"
},
{
"path": "lib/util/__tests__/stat.test.js",
"chars": 2679,
"preview": "'use strict'\n\nconst fs = require('../..')\nconst os = require('os')\nconst path = require('path')\nconst assert = require('"
},
{
"path": "lib/util/__tests__/utimes.test.js",
"chars": 3078,
"preview": "'use strict'\n\nconst fs = require('fs')\nconst os = require('os')\nconst fse = require('../..')\nconst path = require('path'"
},
{
"path": "lib/util/async.js",
"chars": 806,
"preview": "'use strict'\n\n// https://github.com/jprichardson/node-fs-extra/issues/1056\n// Performing parallel operations on each ite"
},
{
"path": "lib/util/stat.js",
"chars": 5225,
"preview": "'use strict'\n\nconst fs = require('../fs')\nconst path = require('path')\nconst u = require('universalify').fromPromise\n\nfu"
},
{
"path": "lib/util/utimes.js",
"chars": 687,
"preview": "'use strict'\n\nconst fs = require('../fs')\nconst u = require('universalify').fromPromise\n\nasync function utimesMillis (pa"
},
{
"path": "package.json",
"chars": 1573,
"preview": "{\n \"name\": \"fs-extra\",\n \"version\": \"11.3.4\",\n \"description\": \"fs-extra contains methods that aren't included in the v"
},
{
"path": "test/readme.md",
"chars": 85,
"preview": "Looking for the test files? You can find all of the test files in `lib/**/__tests__`."
},
{
"path": "test.js",
"chars": 725,
"preview": "'use strict'\n\nconst os = require('os')\nconst path = require('path')\nconst klaw = require('klaw')\nconst Mocha = require('"
},
{
"path": "test.mjs",
"chars": 2346,
"preview": "import assert from 'assert'\nimport fsLegacy from './lib/index.js'\n// NOTE: eslint comments needed because we're importin"
}
]
About this extraction
This page contains the full source code of the jprichardson/node-fs-extra GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 165 files (456.2 KB), approximately 128.1k tokens, and a symbol index with 136 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.