npmpackage.info

Gathering detailed insights and metrics for fs-plus

Other packages similar to fs-plus

@types/fs-plus

3.0.6

TypeScript definitions for fs-plus

fs-extra-plus

0.6.0

A extension of fs-extra with .glob(), .saferRemove()

@craftzdog/fs-plus

4.0.3

node's fs with more helpers

co-fs-plus

0.3.1

co-fs plus, supports `fs.walk` `fs.mkdirp` `fs.rimraf` etc.

fs-plus

node's fs module with some helpful additions

3.1.1

107

MIT

CoffeeScript

28.55 kB

32,926,982 2.8

Installations

npm install fs-plus

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.14.0

NPM Version

6.4.1 Score

96.9

Supply Chain

99.1

Quality

81.6

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

12

Total

50

Closed

4

Merged

34

Issues

Open

6

Total

12

Closed

6

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 34 contributors

Languages

CoffeeScript

JavaScript

CoffeeScript (53.58%)

JavaScript (46.42%)

Developer

atom

Download Statistics

Total Downloads

32,926,982

Last Day

9,009

Last Week

38,295

Last Month

169,889

Last Year

1,969,136

GitHub Statistics

107 Stars

288 Commits

35 Forks

15 Watching

11 Branches

34 Contributors

Bundle Size

92.16 kB

Minified

28.55 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.1.1

Package Id

fs-plus@3.1.1

Size

7.90 kB

NPM Version

6.4.1

Node Version

8.14.0

Publised On

19 Dec 2018

Total Downloads

Cumulative downloads

Total Downloads

32,926,982

Last day

-7.5%

9,009

Compared to previous day

Last week

-18.5%

38,295

Compared to previous week

Last month

9.3%

169,889

Compared to previous month

Last year

-21%

1,969,136

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

async mkdirp rimraf underscore-plus

Dev Dependencies

jasmine-focused grunt-contrib-coffee grunt-cli grunt grunt-shell grunt-coffeelint temp

Versions

fs plus

Yet another filesystem helper based on node's fs module. This library exports everything from node's fs module but with some extra helpers.

Using

1npm install fs-plus

1fs = require 'fs-plus'

Documentation

`getHomeDirectory()`

Returns the absolute path to the home directory.

`absolute(relativePath)`

Make the given path absolute by resolving it against the current working directory.

Params

String relativePath: The string representing the relative path. If the path is prefixed with '~', it will be expanded to the current user's home directory.

Return

String: The absolute path or the relative path if it's unable to determine its real path.

`normalize(pathToNormalize)`

Normalize the given path treating a leading ~ segment as referring to the home directory. This method does not query the filesystem.

Params

String pathToNormalize: The string containing the abnormal path. If the path is prefixed with '~', it will be expanded to the current user's home directory.

Return

String Returns a normalized path.

`tildify(pathToTildify)`

Convert an absolute path to tilde path on Linux and macOS: /Users/username/dev => ~/dev

Params

String pathToTildify: The string containing the full path.

Return

String Returns a tildified path.

`getAppDataDirectory()`

Get path to store application specific data.

Return

String Returns the absolute path or null if platform isn't supported
- macOS: ~/Library/Application Support/
- Windows: %AppData%
- Linux: /var/lib

`isAbsolute(pathToCheck)`

Is the given path absolute?

Params

String pathToCheck: The relative or absolute path to check.

Return

Bolean Returns true if the path is absolute, false otherwise.

`existsSync(pathToCheck)`

Returns true if a file or folder at the specified path exists.

`isDirectorySync(directoryPath)`

Returns true if the given path exists and is a directory.

`isDirectory(directoryPath)`

Asynchronously checks that the given path exists and is a directory.

`isFileSync(filePath)`

Returns true if the specified path exists and is a file.

`isSymbolicLinkSync(symlinkPath)`

Returns true if the specified path is a symbolic link.

`isSymbolicLink(symlinkPath, callback)`

Calls back with true if the specified path is a symbolic link.

`isExecutableSync(pathToCheck)`

Returns true if the specified path is executable.

`getSizeSync(pathToCheck)`

Returns the size of the specified path.

`listSync(rootPath, extensions)`

Returns an Array with the paths of the files and directories contained within the directory path. It is not recursive.

Params

String rootPath: The absolute path to the directory to list.
Array extensions: An array of extensions to filter the results by. If none are given, none are filtered (optional).

`list(rootPath, extensions)`

Asynchronously lists the files and directories in the given path. The listing is not recursive.

`listTreeSync(rootPath)`

Get all paths under the given path.

Params

String rootPath The {String} path to start at.

Return

Array Returns an array of strings under the given path.

`moveSync(source, target)`

Moves the file or directory to the target synchronously.

`removeSync(pathToRemove)`

Removes the file or directory at the given path synchronously.

`writeFileSync(filePath, content, options)`

Open, write, flush, and close a file, writing the given content synchronously. It also creates the necessary parent directories.

`writeFile(filePath, content, options, callback)`

Open, write, flush, and close a file, writing the given content asynchronously. It also creates the necessary parent directories.

`copySync(sourcePath, destinationPath)`

Copies the given path recursively and synchronously.

`makeTreeSync(directoryPath)`

Create a directory at the specified path including any missing parent directories synchronously.

`makeTree(directoryPath, callback)`

Create a directory at the specified path including any missing parent directories asynchronously.

`traverseTreeSync(rootPath, onFile, onDirectory)`

Recursively walk the given path and execute the given functions synchronously.

Params

String rootPath: The string containing the directory to recurse into.
Function onFile: The function to execute on each file, receives a single argument the absolute path.
Function onDirectory: The function to execute on each directory, receives a single argument the absolute path (defaults to onFile). If this function returns a falsy value then the directory is not entered.

`traverseTree(rootPath, onFile, onDirectory, onDone)`

Public: Recursively walk the given path and execute the given functions asynchronously.

`md5ForPath(pathToDigest)`

Hashes the contents of the given file.

Params

String pathToDigest: The string containing the absolute path.

Return

String Returns a string containing the MD5 hexadecimal hash.

`resolve(loadPaths, pathToResolve, extensions)`

Finds a relative path among the given array of paths.

Params

Array loadPaths: An array of absolute and relative paths to search.
String pathToResolve The string containing the path to resolve.
Array extensions An array of extensions to pass to {resolveExtensions} in which case pathToResolve should not contain an extension (optional).

Return

Returns the absolute path of the file to be resolved if it's found and undefined otherwise.

`resolveOnLoadPath()`

Like .resolve but uses node's modules paths as the load paths to search.

`resolveExtension(pathToResolve, extensions)`

Finds the first file in the given path which matches the extension in the order given.

Params

String pathToResolve: the string containing relative or absolute path of the file in question without the extension or '.'.
Array extensions: the ordered array of extensions to try.

Return

Returns the absolute path of the file if it exists with any of the given extensions, otherwise it's undefined.

`isCompressedExtension(ext)`

Returns true for extensions associated with compressed files.

`isImageExtension(ext)`

Returns true for extensions associated with image files.

`isPdfExtension(ext)`

Returns true for extensions associated with pdf files.

`isBinaryExtension(ext)`

Returns true for extensions associated with binary files.

`isReadmePath(readmePath)`

Returns true for files named similarily to 'README'

`isMarkdownExtension(ext)`

Returns true for extensions associated with Markdown files.

`isCaseInsensitive()`

Is the filesystem case insensitive? Returns true if case insensitive, false otherwise.

`isCaseSensitive()`

Is the filesystem case sensitive? Returns true if case sensitive, false otherwise.

`statSyncNoException(path[, options])`

Calls fs.statSync, catching all exceptions raised. This method calls fs.statSyncNoException when provided by the underlying fs module (Electron < 3.0). Returns fs.Stats if the file exists, false otherwise.

`lstatSyncNoException(path[, options])`

Calls fs.lstatSync, catching all exceptions raised. This method calls fs.lstatSyncNoException when provided by the underlying fs module (Electron < 3.0). Returns fs.Stats if the file exists, false otherwise.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-01-27

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