npmpackage.info

Gathering detailed insights and metrics for @supercharge/fs

@supercharge/fs

Extended `fs` drop-in replacement for Node.js

3.4.2

MIT

JavaScript

478,976 3.4

Installations

npm install @supercharge/fs

Pull Requests

Open

0

Total

14

Closed

7

Merged

7

Issues

Open

0

Total

1

Closed

1

Releases

Unable to fetch releases

Developer

supercharge

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=12

Typescript Support

Yes

Node Version

20.11.0

NPM Version

10.2.4 Statistics

18 Stars

150 Commits

2 Forks

2 Watching

3 Branches

3 Contributors

Updated on 07 Aug 2024

Languages

JavaScript (50.75%)

TypeScript (49.25%)

Total Downloads

Cumulative downloads

Total Downloads

478,976

Last day

-31.7%

1,083

Compared to previous day

Last week

-9.1%

7,096

Compared to previous week

Last month

-10.2%

33,992

Compared to previous month

Last year

303.1%

350,225

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@supercharge/goodies @types/fs-extra @types/proper-lockfile @types/recursive-readdir fs-extra proper-lockfile recursive-readdir

Dev Dependencies

@supercharge/eslint-config-typescript @supercharge/tsconfig c8 eslint expect typescript uvu

Versions

Fs

Extended drop-in fs replacement for Node.js

Installation · Docs · Usage

Follow @marcuspoehls and @superchargejs for updates!

Introduction

The @supercharge/fs package provides an improved and extended fs implementation

provides convenience methods like isFile(path) or isDirectory(path)
useful methods, like copy, ensureFile, ensureDir
based on fs-extra providing all native fs methods from Node.js
full async/await support
aligned camelCase method naming, like realPath instead of realpath

Installation

npm i @supercharge/fs

Resources

Documentation

Quick Usage Overview

Using @supercharge/fs is pretty straightforward. Install and import the package in your project and use the methods to interact with the filesystem.

For example, you may copy or move a file from src to dest or retrieve a file’s size:

1const Fs = require('@supercharge/fs')
2
3await Fs.copy(src, dest)
4await Fs.move(src, dest)
5
6const size = await Fs.size(file)
7// 3758 bytes

Have a look at the docs for this package to find more details on all supported methods.

Contributing

Do you miss a string function? We very much appreciate your contribution! Please send in a pull request 😊

Create a fork
Create your feature branch: git checkout -b my-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request 🚀

License

MIT © Supercharge

superchargejs.com · GitHub @supercharge · Twitter @superchargejs

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

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

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/publish-in-github-package-registry.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/publish-in-github-package-registry.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/publish-in-github-package-registry.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/publish-in-github-package-registry.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/publish-in-github-package-registry.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/run-tests.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/supercharge/fs/run-tests.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:20
Warn: npmCommand not pinned by hash: .github/workflows/publish-in-github-package-registry.yml:38
Warn: npmCommand not pinned by hash: .github/workflows/run-tests.yml:33
Info: 0 out of 7 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

Token-Permissions

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

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

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

Score

3.4

/10

Last Scanned on 2024-11-18

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