Gathering detailed insights and metrics for fs-extra
Gathering detailed insights and metrics for fs-extra
Gathering detailed insights and metrics for fs-extra
Gathering detailed insights and metrics for fs-extra
Node.js: extra methods for the fs object like copy(), remove(), mkdirs()
npm install fs-extra
Typescript
Module System
Min. Node Version
Node Version
NPM Version
98.8
Supply Chain
100
Quality
79.9
Maintenance
100
Vulnerability
100
License
Updated on 06 Dec 2024
JavaScript (100%)
Cumulative downloads
Total Downloads
Last day
15.6%
Compared to previous day
Last week
-5.1%
Compared to previous week
Last month
4.4%
Compared to previous month
Last year
13.7%
Compared to previous year
3
8
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
to prevent EMFILE
errors. It should be a drop in replacement for fs
.
I got tired of including mkdirp
, rimraf
, and ncp
in most of my projects.
npm install fs-extra
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:
1const fs = require('fs') // this is no longer necessary
you can now do this:
1const 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:
1const fse = require('fs-extra')
you can also keep both, but it's redundant:
1const fs = require('fs') 2const fse = require('fs-extra')
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:
1import { readFileSync } from 'fs' 2import { readFile } from 'fs/promises' 3import { outputFile, outputFileSync } from 'fs-extra/esm'
Default exports are supported:
1import fs from 'fs' 2import fse from 'fs-extra/esm' 3// 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:
1import fs from 'fs-extra' 2// both fs and fs-extra methods are defined
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:
1const fs = require('fs-extra') 2 3// Async with promises: 4fs.copy('/tmp/myfile', '/tmp/mynewfile') 5 .then(() => console.log('success!')) 6 .catch(err => console.error(err)) 7 8// Async with callbacks: 9fs.copy('/tmp/myfile', '/tmp/mynewfile', err => { 10 if (err) return console.error(err) 11 console.log('success!') 12}) 13 14// Sync: 15try { 16 fs.copySync('/tmp/myfile', '/tmp/mynewfile') 17 console.log('success!') 18} catch (err) { 19 console.error(err) 20} 21 22// Async/Await: 23async function copyFiles () { 24 try { 25 await fs.copy('/tmp/myfile', '/tmp/mynewfile') 26 console.log('success!') 27 } catch (err) { 28 console.error(err) 29 } 30} 31 32copyFiles()
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()
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
and klaw-sync
.
fse-cli allows you to run fs-extra
from a console or from npm scripts.
If you like TypeScript, you can use fs-extra
with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
If you want to watch for changes to files or directories, then you should use chokidar.
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.
Wanna hack on fs-extra
? Great! Your help is needed! fs-extra is one of the most depended upon Node.js packages. This project
uses JavaScript Standard Style - 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
.
What's needed?
Note: If you make any big changes, you should definitely file an issue for discussion first.
fs-extra contains hundreds of tests.
npm run lint
: runs the linter (standard)npm run unit
: runs the unit testsnpm run unit-esm
: runs tests for fs-extra/esm
exportsnpm test
: runs the linter and all testsWhen 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.
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.
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:
First, I believe that in as many cases as possible, the Node.js naming schemes 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)
.
fs-extra
wouldn't be possible without using the modules from the following authors:
Licensed under MIT
Copyright (c) 2011-2017 JP Richardson
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
GitHub workflow tokens follow principle of least privilege
Details
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
0 existing vulnerabilities detected
Reason
Found 17/30 approved changesets -- score normalized to 5
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2024-12-02
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More