Require Node.js 18

Author: sindresorhus

.github/workflows/main.yml

@@ -10,16 +10,15 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
+          - 20
           - 18
-          - 16
-          - 14
         os:
           - ubuntu-latest
           - macos-latest
           - windows-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

.gitignore

@@ -2,3 +2,4 @@ node_modules
 yarn.lock
 .nyc_output
 coverage
+temp

copy-file-error.js

@@ -1,10 +1,7 @@
-import NestedError from 'nested-error-stacks';
-
-// TODO: Use `Error#cause`.
-export default class CopyFileError extends NestedError {
-	constructor(message, nested) {
-		super(message, nested);
-		Object.assign(this, nested);
+export default class CopyFileError extends Error {
+	constructor(message, {cause} = {}) {
+		super(message, {cause});
+		Object.assign(this, cause);
 		this.name = 'CopyFileError';
 	}
 }

fs.js

@@ -18,60 +18,60 @@ export async function createReadStream(path, options) {
 	try {
 		await pEvent(read, ['readable', 'end']);
 	} catch (error) {
-		throw new CopyFileError(`Cannot read from \`${path}\`: ${error.message}`, error);
+		throw new CopyFileError(`Cannot read from \`${path}\`: ${error.message}`, {cause: error});
 	}
 
 	return read;
 }
 
 export const stat = path => statP(path).catch(error => {
-	throw new CopyFileError(`Cannot stat path \`${path}\`: ${error.message}`, error);
+	throw new CopyFileError(`Cannot stat path \`${path}\`: ${error.message}`, {cause: error});
 });
 
 export const lstat = path => lstatP(path).catch(error => {
-	throw new CopyFileError(`lstat \`${path}\` failed: ${error.message}`, error);
+	throw new CopyFileError(`lstat \`${path}\` failed: ${error.message}`, {cause: error});
 });
 
 export const utimes = (path, atime, mtime) => utimesP(path, atime, mtime).catch(error => {
-	throw new CopyFileError(`utimes \`${path}\` failed: ${error.message}`, error);
+	throw new CopyFileError(`utimes \`${path}\` failed: ${error.message}`, {cause: error});
 });
 
 export const chmod = (path, mode) => chmodP(path, mode).catch(error => {
-	throw new CopyFileError(`chmod \`${path}\` failed: ${error.message}`, error);
+	throw new CopyFileError(`chmod \`${path}\` failed: ${error.message}`, {cause: error});
 });
 
 export const statSync = path => {
 	try {
 		return fs.statSync(path);
 	} catch (error) {
-		throw new CopyFileError(`stat \`${path}\` failed: ${error.message}`, error);
+		throw new CopyFileError(`stat \`${path}\` failed: ${error.message}`, {cause: error});
 	}
 };
 
 export const utimesSync = (path, atime, mtime) => {
 	try {
 		return fs.utimesSync(path, atime, mtime);
 	} catch (error) {
-		throw new CopyFileError(`utimes \`${path}\` failed: ${error.message}`, error);
+		throw new CopyFileError(`utimes \`${path}\` failed: ${error.message}`, {cause: error});
 	}
 };
 
 export const makeDirectory = (path, options) => makeDirectoryP(path, {...options, recursive: true}).catch(error => {
-	throw new CopyFileError(`Cannot create directory \`${path}\`: ${error.message}`, error);
+	throw new CopyFileError(`Cannot create directory \`${path}\`: ${error.message}`, {cause: error});
 });
 
 export const makeDirectorySync = (path, options) => {
 	try {
 		fs.mkdirSync(path, {...options, recursive: true});
 	} catch (error) {
-		throw new CopyFileError(`Cannot create directory \`${path}\`: ${error.message}`, error);
+		throw new CopyFileError(`Cannot create directory \`${path}\`: ${error.message}`, {cause: error});
 	}
 };
 
 export const copyFileSync = (source, destination, flags) => {
 	try {
 		fs.copyFileSync(source, destination, flags);
 	} catch (error) {
-		throw new CopyFileError(`Cannot copy from \`${source}\` to \`${destination}\`: ${error.message}`, error);
+		throw new CopyFileError(`Cannot copy from \`${source}\` to \`${destination}\`: ${error.message}`, {cause: error});
 	}
 };

index.d.ts

@@ -1,4 +1,4 @@
-export interface Options {
+export type Options = {
 	/**
 	Overwrite existing destination file.
 
@@ -23,9 +23,9 @@ export interface Options {
 	@default process.cwd()
 	*/
 	readonly cwd?: string;
-}
+};
 
-export interface AsyncOptions {
+export type AsyncOptions = {
 	/**
 	The given function is called whenever there is measurable progress.
 
@@ -43,9 +43,9 @@ export interface AsyncOptions {
 	```
 	*/
 	readonly onProgress?: (progress: ProgressData) => void;
-}
+};
 
-export interface ProgressData {
+export type ProgressData = {
 	/**
 	Absolute path to source.
 	*/
@@ -70,7 +70,7 @@ export interface ProgressData {
 	Copied percentage, a value between `0` and `1`.
 	*/
 	percent: number;
-}
+};
 
 /**
 Copy a file.

index.js

@@ -31,7 +31,7 @@ const copyFileAsync = async (source, destination, options) => {
 	});
 
 	readStream.once('error', error => {
-		readError = new CopyFileError(`Cannot read from \`${source}\`: ${error.message}`, error);
+		readError = new CopyFileError(`Cannot read from \`${source}\`: ${error.message}`, {cause: error});
 	});
 
 	let shouldUpdateStats = false;
@@ -42,7 +42,7 @@ const copyFileAsync = async (source, destination, options) => {
 		emitProgress(size);
 		shouldUpdateStats = true;
 	} catch (error) {
-		throw new CopyFileError(`Cannot write to \`${destination}\`: ${error.message}`, error);
+		throw new CopyFileError(`Cannot write to \`${destination}\`: ${error.message}`, {cause: error});
 	}
 
 	if (readError) {

index.test-d.ts

@@ -1,5 +1,5 @@
 import {expectError, expectType} from 'tsd';
-import {copyFile, copyFileSync, ProgressData} from './index.js';
+import {copyFile, copyFileSync, type ProgressData} from './index.js';
 
 expectType<Promise<void> >(
 	copyFile('source/unicorn.png', 'destination/unicorn.png'),

package.json

@@ -11,10 +11,12 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
-	"types": "./index.d.ts",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=14.16"
+		"node": ">=18"
 	},
 	"scripts": {
 		"test": "xo && nyc ava && tsd"
@@ -27,42 +29,46 @@
 	],
 	"keywords": [
 		"copy",
+		"copying",
 		"cp",
 		"file",
 		"clone",
 		"fs",
 		"stream",
 		"file-system",
+		"filesystem",
 		"ncp",
 		"fast",
 		"quick",
 		"data",
 		"content",
-		"contents"
+		"contents",
+		"read",
+		"write",
+		"io"
 	],
 	"dependencies": {
-		"graceful-fs": "^4.2.10",
-		"nested-error-stacks": "^2.1.1",
-		"p-event": "^5.0.1"
+		"graceful-fs": "^4.2.11",
+		"p-event": "^6.0.0"
 	},
 	"devDependencies": {
-		"ava": "^4.3.0",
+		"ava": "^5.3.1",
 		"clear-module": "^4.1.2",
 		"coveralls": "^3.1.1",
-		"del": "^6.1.1",
+		"del": "^7.1.0",
 		"import-fresh": "^3.3.0",
 		"nyc": "^15.1.0",
-		"sinon": "^14.0.0",
-		"tsd": "^0.21.0",
-		"xo": "^0.50.0"
+		"sinon": "^17.0.1",
+		"tsd": "^0.29.0",
+		"xo": "^0.56.0"
 	},
 	"xo": {
 		"rules": {
-			"unicorn/string-content": "off",
 			"ava/assertion-arguments": "off"
 		}
 	},
 	"ava": {
-		"workerThreads": false
+		"workerThreads": false,
+		"serial": true
 	}
 }

readme.md

@@ -7,8 +7,8 @@
 - Fast by using streams in the async version and [`fs.copyFileSync()`](https://nodejs.org/api/fs.html#fs_fs_copyfilesync_src_dest_flags) in the synchronous version.
 - Resilient by using [graceful-fs](https://github.com/isaacs/node-graceful-fs).
 - User-friendly by creating non-existent destination directories for you.
-- Can be safe by turning off [overwriting](#optionsoverwrite).
-- Preserves file mode, [but not ownership](https://github.com/sindresorhus/cp-file/issues/22#issuecomment-502079547).
+- Can be safe by turning off [overwriting](#overwrite).
+- Preserves file mode [but not ownership](https://github.com/sindresorhus/cp-file/issues/22#issuecomment-502079547).
 - User-friendly errors.
 
 ## Install

test/async.js

@@ -5,7 +5,7 @@ import fs from 'node:fs';
 import {fileURLToPath} from 'node:url';
 import importFresh from 'import-fresh';
 import clearModule from 'clear-module';
-import del from 'del';
+import {deleteSync} from 'del';
 import test from 'ava';
 import sinon from 'sinon';
 import {copyFile} from '../index.js';
@@ -18,16 +18,17 @@ const THREE_HUNDRED_KILO = (100 * 3 * 1024) + 1;
 
 test.before(() => {
 	process.chdir(path.dirname(__dirname));
+	deleteSync('temp'); // In case last test run failed.
+	fs.mkdirSync('temp');
 });
 
-test.beforeEach(t => {
-	t.context.source = crypto.randomUUID();
-	t.context.destination = crypto.randomUUID();
-	t.context.creates = [t.context.source, t.context.destination];
+test.after(() => {
+	deleteSync('temp');
 });
 
-test.afterEach.always(t => {
-	del.sync(t.context.creates);
+test.beforeEach(t => {
+	t.context.source = path.join('temp', crypto.randomUUID());
+	t.context.destination = path.join('temp', crypto.randomUUID());
 });
 
 test('reject an Error on missing `source`', async t => {

test/progress.js

@@ -3,7 +3,7 @@ import crypto from 'node:crypto';
 import path from 'node:path';
 import {fileURLToPath} from 'node:url';
 import fs from 'node:fs';
-import del from 'del';
+import {deleteSync} from 'del';
 import test from 'ava';
 import {copyFile} from '../index.js';
 
@@ -13,18 +13,17 @@ const THREE_HUNDRED_KILO = (100 * 3 * 1024) + 1;
 
 test.before(() => {
 	process.chdir(path.dirname(__dirname));
+	deleteSync('temp'); // In case last test run failed.
+	fs.mkdirSync('temp');
 });
 
-test.beforeEach(t => {
-	t.context.source = crypto.randomUUID();
-	t.context.destination = crypto.randomUUID();
-	t.context.creates = [t.context.source, t.context.destination];
+test.after(() => {
+	deleteSync('temp');
 });
 
-test.afterEach.always(t => {
-	for (const path of t.context.creates) {
-		del.sync(path);
-	}
+test.beforeEach(t => {
+	t.context.source = path.join('temp', crypto.randomUUID());
+	t.context.destination = path.join('temp', crypto.randomUUID());
 });
 
 test('report progress', async t => {

test/sync.js

@@ -3,7 +3,7 @@ import crypto from 'node:crypto';
 import {fileURLToPath} from 'node:url';
 import path from 'node:path';
 import fs from 'node:fs';
-import del from 'del';
+import {deleteSync} from 'del';
 import test from 'ava';
 import sinon from 'sinon';
 import {copyFileSync} from '../index.js';
@@ -16,18 +16,17 @@ const THREE_HUNDRED_KILO = (100 * 3 * 1024) + 1;
 
 test.before(() => {
 	process.chdir(path.dirname(__dirname));
+	deleteSync('temp'); // In case last test run failed.
+	fs.mkdirSync('temp');
 });
 
-test.beforeEach(t => {
-	t.context.source = crypto.randomUUID();
-	t.context.destination = crypto.randomUUID();
-	t.context.creates = [t.context.source, t.context.destination];
+test.after(() => {
+	deleteSync('temp');
 });
 
-test.afterEach.always(t => {
-	for (const path_ of t.context.creates) {
-		del.sync(path_);
-	}
+test.beforeEach(t => {
+	t.context.source = path.join('temp', crypto.randomUUID());
+	t.context.destination = path.join('temp', crypto.randomUUID());
 });
 
 test('throw an Error on missing `source`', t => {