Gathering detailed insights and metrics for @visulima/fs
Gathering detailed insights and metrics for @visulima/fs
Visulima is the next-gen JavaScript framework for JAMStack blogs, sites & apps.
Installations
npm install @visulima/fsDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=18.0.0 <=23.x
Node Version
18.20.7
NPM Version
10.9.2
Releases
1,170
@visulima/string@1.0.2
@visulima/string@1.0.2
Updated on Mar 22, 2025
@visulima/string@1.0.1
@visulima/string@1.0.1
Updated on Mar 21, 2025
@visulima/string@1.0.0
@visulima/string@1.0.0
Updated on Mar 21, 2025
@visulima/package@3.5.4
@visulima/package@3.5.4
Updated on Mar 12, 2025
@visulima/cerebro@1.1.40
@visulima/cerebro@1.1.40
Updated on Mar 07, 2025
@visulima/pail@2.1.22
@visulima/pail@2.1.22
Updated on Mar 07, 2025
Languages
6
TypeScript
JavaScript
MDX
Handlebars
CSS
Shell
TypeScript (93.38%)
JavaScript (4.8%)
MDX (1.31%)
Handlebars (0.31%)
CSS (0.11%)
Shell (0.1%)
Developer
Download Statistics
Total Downloads
83,363
Last Day
224
Last Week
1,462
Last Month
7,497
Last Year
81,140
GitHub Statistics
MIT License
13 Stars
2,491 Commits
3 Forks
2 Watchers
17 Branches
2 Contributors
Updated on Mar 22, 2025
Bundle Size
28.76 kB
Minified
7.71 kB
Minified + Gzipped
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
3.1.2
Package Id
@visulima/fs@3.1.2
Unpacked Size
328.04 kB
Size
60.65 kB
File Count
142
NPM Version
10.9.2
Node Version
18.20.7
Published on
Mar 07, 2025
Total Downloads
Cumulative downloads
Total Downloads
83,363
Last Day
-30.2%
224
Compared to previous day
Last Week
-30.3%
1,462
Compared to previous week
Last Month
6.2%
7,497
Compared to previous month
Last Year
3,550%
81,140
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Visulima fs
Human friendly file system utilities for Node.js
[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
Install
1npm install @visulima/fs
1yarn add @visulima/fs
1pnpm add @visulima/fs
Note: If you want to parse or write YAML, you'll need to install
yamlas well.
1npm install yaml
1yarn add yaml
1pnpm add yaml
After installing
yaml, you can use thereadYaml,readYamlSyncandwriteYaml,writeYamlSyncfunctions from@visulima/fs/yaml.
Usage
walk
1import { walk } from "@visulima/fs"; 2 3const filesAndFolders: string[] = []; 4 5for await (const index of walk(`${__dirname}/fixtures`, {})) { 6 filesAndFolders.push(index.path); 7} 8 9console.log(filesAndFolders);
walkSync
1import { walkSync } from "@visulima/fs"; 2 3const filesAndFolders: string[] = []; 4 5for (const index of walkSync(`${__dirname}/fixtures`, {})) { 6 filesAndFolders.push(index.path); 7} 8 9console.log(filesAndFolders);
API for walk and walkSync
path
Type: string
The directory to start from.
options
Type: object
maxDepth
Type: number
Default: Infinity
Optional: true
Description: The maximum depth of the file tree to be walked recursively.
includeFiles
Type: boolean
Default: true
Optional: true
Description: Indicates whether file entries should be included or not.
includeDirs
Type: boolean
Default: true
Optional: true
Description: Indicates whether directory entries should be included or not.
includeSymlinks
Type: boolean
Default: true
Optional: true
Description: Indicates whether symlink entries should be included or not. This option is meaningful only if followSymlinks is set to false.
followSymlinks
Type: boolean
Default: false
Optional: true
Description: Indicates whether symlinks should be resolved or not.
extensions
Type: string[]
Default: undefined
Optional: true
Description: List of file extensions used to filter entries. If specified, entries without the file extension specified by this option are excluded.
match
Type: (RegExp | string)[]
Default: undefined
Optional: true
Description: List of regular expression or glob patterns used to filter entries. If specified, entries that do not match the patterns specified by this option are excluded.
skip
Type: (RegExp | string)[]
Default: undefined
Optional: true
Description: List of regular expression or glob patterns used to filter entries. If specified, entries matching the patterns specified by this option are excluded.
findUp
Find a file or directory by walking up parent directories.
1import { findUp } from "@visulima/fs"; 2 3// Returns a Promise for the found path or undefined if it could not be found. 4const file = await findUp("package.json"); 5 6console.log(file);
findUpSync
Find a file or directory by walking up parent directories.
1import { findUpSync } from "@visulima/fs"; 2 3// Returns the found path or undefined if it could not be found. 4const file = findUpSync("package.json"); 5 6console.log(file);
API for findUp and findUpSync
name
Type: string[] | string | ((directory: PathLike) => PathLike | Promise<PathLike | typeof FIND_UP_STOP> | typeof FIND_UP_STOP)
Sync Type: string[] | string | ((directory: PathLike) => PathLike | typeof FIND_UP_STOP)
The name of the file or directory to find.
If an array is specified, the first item that exists will be returned.
A function that will be called with each directory until it returns a string with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use-cases.
When using async mode, the matcher may optionally be an async or promise-returning function that returns the path.
options
Type: object
cwd
Type: URL | string
Default: process.cwd()
The directory to start from.
type
Type: string
Default: 'file'
Values: 'file' | 'directory'
The type of path to match.
stopAt
Type: URL | string
Default: Root directory
A directory path where the search halts if no matches are found before reaching this point.
allowSymlinks
Type: boolean
Default: true
Allow symbolic links to match if they point to the target file or directory.
readFile
Read a file.
1import { readFile } from "@visulima/fs"; 2 3// Returns a Promise for the file contents. 4const file = await readFile("package.json"); 5 6console.log(file);
readFileSync
Read a file.
1import { readFileSync } from "@visulima/fs"; 2 3// Returns the file contents. 4 5const file = readFileSync("package.json"); 6 7console.log(file);
API for readFile and readFileSync
path
Type: string
The path to the file to read.
options
Type: object
buffer
Type: boolean
Default: true
Optional: true
Description: Indicates whether the file contents should be returned as a Buffer or a string.
compression
Type: "brotli" | "gzip" | undefined
Default: undefined
Optional: true
Description: The file compression.
encoding
Type: "ascii" | "base64" | "base64url" | "hex" | "latin1" | "ucs-2" | "ucs2" | "utf-8" | "utf-16le" | "utf8" | "utf16le" | undefined
Default: utf8
Optional: true
flag
Type: number | string | undefined
Default: 'r'
Optional: true
isAccessible
Check if a file or directory exists and is accessible.
1import { isAccessible } from "@visulima/fs"; 2 3// Returns a Promise for the result. 4const file = await isAccessible("package.json"); 5 6console.log(file);
isAccessibleSync
Check if a file or directory exists and is accessible.
1import { isAccessibleSync } from "@visulima/fs"; 2 3// Returns the result. 4 5const file = isAccessibleSync("package.json"); 6 7console.log(file);
API for isAccessible and isAccessibleSync
path
Type: string
The path to the file or directory to check.
mode
Type: number
Default: fs.constants.F_OK
Optional: true
Description: The accessibility mode.
Utilities
parseJson
Parse JSON with more helpful errors.
1import { parseJson, JSONError } from "@visulima/fs/utils"; 2 3const json = '{\n\t"foo": true,\n}'; 4 5JSON.parse(json); 6/* 7undefined:3 8} 9^ 10SyntaxError: Unexpected token } 11*/ 12 13parseJson(json); 14/* 15JSONError: Unexpected token } in JSON at position 16 while parsing near '{ "foo": true,}' 16 17 1 | { 18 2 | "foo": true, 19> 3 | } 20 | ^ 21*/ 22 23parseJson(json, "foo.json"); 24/* 25JSONError: Unexpected token } in JSON at position 16 while parsing near '{ "foo": true,}' in foo.json 26 27 1 | { 28 2 | "foo": true, 29> 3 | } 30 | ^ 31*/
API for parseJson
json
Type: string
The JSON string to parse.
reviver
Type: Function
Prescribes how the value originally produced by parsing is transformed, before being returned. See JSON.parse docs for more.
filename
Type: string
The filename to use in error messages.
API for JSONError
Exposed for use in instanceof checks.
fileName
Type: string
The filename displayed in the error message.
codeFrame
Type: string
The printable section of the JSON which produces the error.
Api Docs
error
Classes
AlreadyExistsError
Defined in: packages/fs/src/error/already-exists-error.ts:4
Error thrown when file already exists.
Extends
Error
Constructors
new AlreadyExistsError()
1new AlreadyExistsError(message): AlreadyExistsErrorDefined in: packages/fs/src/error/already-exists-error.ts:9
Creates a new instance.
Parameters
message
string
The error message.
Returns
Overrides
1Error.constructorAccessors
code
Get Signature
1get code(): string
Defined in: packages/fs/src/error/already-exists-error.ts:14
Returns
string
Set Signature
1set code(_name): void
Defined in: packages/fs/src/error/already-exists-error.ts:19
Parameters
_name
string
Returns
void
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/already-exists-error.ts:24
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/already-exists-error.ts:29
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messagestack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitDirectoryError
Defined in: packages/fs/src/error/directory-error.ts:4
Error thrown when an operation is not allowed on a directory.
Extends
Error
Constructors
new DirectoryError()
1new DirectoryError(message): DirectoryErrorDefined in: packages/fs/src/error/directory-error.ts:9
Creates a new instance.
Parameters
message
string
The error message.
Returns
Overrides
1Error.constructorAccessors
code
Get Signature
1get code(): string
Defined in: packages/fs/src/error/directory-error.ts:14
Returns
string
Set Signature
1set code(_name): void
Defined in: packages/fs/src/error/directory-error.ts:19
Parameters
_name
string
Returns
void
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/directory-error.ts:24
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/directory-error.ts:29
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messagestack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitNotEmptyError
Defined in: packages/fs/src/error/not-empty-error.ts:4
Error thrown when a directory is not empty.
Extends
Error
Constructors
new NotEmptyError()
1new NotEmptyError(message): NotEmptyErrorDefined in: packages/fs/src/error/not-empty-error.ts:9
Creates a new instance.
Parameters
message
string
The error message.
Returns
Overrides
1Error.constructorAccessors
code
Get Signature
1get code(): string
Defined in: packages/fs/src/error/not-empty-error.ts:14
Returns
string
Set Signature
1set code(_name): void
Defined in: packages/fs/src/error/not-empty-error.ts:19
Parameters
_name
string
Returns
void
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/not-empty-error.ts:24
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/not-empty-error.ts:29
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messagestack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitNotFoundError
Defined in: packages/fs/src/error/not-found-error.ts:4
Error thrown when a file or directory is not found.
Extends
Error
Constructors
new NotFoundError()
1new NotFoundError(message): NotFoundErrorDefined in: packages/fs/src/error/not-found-error.ts:9
Creates a new instance.
Parameters
message
string
The error message.
Returns
Overrides
1Error.constructorAccessors
code
Get Signature
1get code(): string
Defined in: packages/fs/src/error/not-found-error.ts:14
Returns
string
Set Signature
1set code(_name): void
Defined in: packages/fs/src/error/not-found-error.ts:19
Parameters
_name
string
Returns
void
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/not-found-error.ts:24
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/not-found-error.ts:29
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messagestack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitPermissionError
Defined in: packages/fs/src/error/permission-error.ts:4
Error thrown when an operation is not permitted.
Extends
Error
Constructors
new PermissionError()
1new PermissionError(message): PermissionErrorDefined in: packages/fs/src/error/permission-error.ts:9
Creates a new instance.
Parameters
message
string
The error message.
Returns
Overrides
1Error.constructorAccessors
code
Get Signature
1get code(): string
Defined in: packages/fs/src/error/permission-error.ts:14
Returns
string
Set Signature
1set code(_name): void
Defined in: packages/fs/src/error/permission-error.ts:19
Parameters
_name
string
Returns
void
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/permission-error.ts:24
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/permission-error.ts:29
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messagestack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitWalkError
Defined in: packages/fs/src/error/walk-error.ts:7
Error thrown in walk or walkSync during iteration.
Extends
Error
Constructors
new WalkError()
1new WalkError(cause, root): WalkErrorDefined in: packages/fs/src/error/walk-error.ts:12
Constructs a new instance.
Parameters
cause
unknown
root
string
Returns
Overrides
1Error.constructorAccessors
name
Get Signature
1get name(): string
Defined in: packages/fs/src/error/walk-error.ts:21
Returns
string
Set Signature
1set name(_name): void
Defined in: packages/fs/src/error/walk-error.ts:26
Parameters
_name
string
Returns
void
Overrides
1Error.name
Methods
captureStackTrace()
1static captureStackTrace(targetObject, constructorOpt?): voidDefined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:91
Create .stack property on a target object
Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
1Error.captureStackTraceProperties
cause?
1optional cause: unknown;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
1Error.causemessage
1message: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
1Error.messageroot
1root: string;
Defined in: packages/fs/src/error/walk-error.ts:9
File path of the root that's being walked.
stack?
1optional stack: string;
Defined in: node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
1Error.stackprepareStackTrace()?
1static optional prepareStackTrace: (err, stackTraces) => any;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:98
Optional override for formatting stack traces
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
1Error.prepareStackTracestackTraceLimit
1static stackTraceLimit: number;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/globals.d.ts:100
Inherited from
1Error.stackTraceLimitReferences
JSONError
Re-exports JSONError
index
Functions
collect()
1function collect(directory, options): Promise<string[]>
Defined in: packages/fs/src/find/collect.ts:4
Parameters
directory
string
options
WalkOptions = {}
Returns
Promise<string[]>
collectSync()
1function collectSync(directory, options): string[]Defined in: packages/fs/src/find/collect-sync.ts:4
Parameters
directory
string
options
WalkOptions = {}
Returns
string[]
detect()
1function detect(content): "\n" | "\r\n"Defined in: packages/fs/src/eol.ts:20
Detect the EOL character for string input. Returns null if no newline.
Parameters
content
string
Returns
"\n" | "\r\n"
emptyDir()
1function emptyDir(dir, options?): Promise<void>Defined in: packages/fs/src/remove/empty-dir.ts:19
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.
Parameters
dir
string | URL
options?
Returns
Promise<void>
emptyDirSync()
1function emptyDirSync(dir, options?): voidDefined in: packages/fs/src/remove/empty-dir-sync.ts:18
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.
Parameters
dir
string | URL
options?
Returns
void
ensureDir()
1function ensureDir(directory): Promise<void>
Defined in: packages/fs/src/ensure/ensure-dir.ts:12
Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p.
Parameters
directory
string | URL
Returns
Promise<void>
ensureDirSync()
1function ensureDirSync(directory): void
Defined in: packages/fs/src/ensure/ensure-dir-sync.ts:12
Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p.
Parameters
directory
string | URL
Returns
void
ensureFile()
1function ensureFile(filePath): Promise<void>
Defined in: packages/fs/src/ensure/ensure-file.ts:16
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 NOTMODIFIED.
Parameters
filePath
string | URL
Returns
Promise<void>
ensureFileSync()
1function ensureFileSync(filePath): void
Defined in: packages/fs/src/ensure/ensure-file-sync.ts:16
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 NOTMODIFIED.
Parameters
filePath
string | URL
Returns
void
ensureLink()
1function ensureLink(source, destination): Promise<void>Defined in: packages/fs/src/ensure/ensure-link.ts:15
Ensures that the hard link exists. If the directory structure does not exist, it is created.
Parameters
source
string | URL
destination
string | URL
Returns
Promise<void>
ensureLinkSync()
1function ensureLinkSync(source, destination): voidDefined in: packages/fs/src/ensure/ensure-link-sync.ts:15
Ensures that the hard link exists. If the directory structure does not exist, it is created.
Parameters
source
string | URL
destination
string | URL
Returns
void
ensureSymlink()
1function ensureSymlink(
2 target,
3 linkName,
4type?): Promise<void>Defined in: packages/fs/src/ensure/ensure-symlink.ts:28
Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
Parameters
target
the source file path
string | URL
linkName
the destination link path
string | URL
type?
Type
the type of the symlink, or null to use automatic detection
Returns
Promise<void>
A void promise that resolves once the link exists.
ensureSymlinkSync()
1function ensureSymlinkSync(
2 target,
3 linkName,
4 type?): voidDefined in: packages/fs/src/ensure/ensure-symlink-sync.ts:28
Ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
Parameters
target
the source file path
string | URL
linkName
the destination link path
string | URL
type?
Type
the type of the symlink, or null to use automatic detection
Returns
void
A void.
findUp()
1function findUp(name, options): Promise<string>Defined in: packages/fs/src/find/find-up.ts:11
Parameters
name
options
FindUpOptions = {}
Returns
Promise<string>
findUpSync()
1function findUpSync(name, options): stringDefined in: packages/fs/src/find/find-up-sync.ts:11
Parameters
name
options
FindUpOptions = {}
Returns
string
format()
1function format(content, eol): string
Defined in: packages/fs/src/eol.ts:36
Format the file to the targeted EOL.
Parameters
content
string
eol
"\n" | "\r\n"
Returns
string
isAccessible()
1function isAccessible(path, mode?): Promise<boolean>Defined in: packages/fs/src/is-accessible.ts:9
Returns a Promise that resolves to a boolean indicating if the path is accessible or not.
Parameters
path
string | URL
mode?
number
Returns
Promise<boolean>
isAccessibleSync()
1function isAccessibleSync(path, mode?): booleanDefined in: packages/fs/src/is-accessible-sync.ts:9
Returns a boolean indicating if the path is accessible or not.
Parameters
path
string | URL
mode?
number
Returns
boolean
move()
1function move( 2 sourcePath, 3 destinationPath, 4options): Promise<void>
Defined in: packages/fs/src/move/index.ts:35
Move a file asynchronously.
Parameters
sourcePath
string
The file you want to move.
destinationPath
string
Where you want the file moved.
options
MoveOptions = {}
Configuration options.
Returns
Promise<void>
A Promise that resolves when the file has been moved.
Example
import { moveFile } from '@visulima/fs';
await moveFile('source/test.png', 'destination/test.png');
console.log('The file has been moved');
moveSync()
1function moveSync(
2 sourcePath,
3 destinationPath,
4 options?): voidDefined in: packages/fs/src/move/index.ts:61
Move a file synchronously.
Parameters
sourcePath
string
The file you want to move.
destinationPath
string
Where you want the file moved.
options?
Configuration options.
Returns
void
Nothing is returned.
Example
import { moveFileSync } from '@visulima/fs';
moveFileSync('source/test.png', 'destination/test.png');
console.log('The file has been moved');
readFile()
1function readFile<O>(path, options?): Promise<ContentType<O>>
Defined in: packages/fs/src/read/read-file.ts:20
Type Parameters
• O extends ReadFileOptions<"brotli" | "gzip" | "none"> = undefined
Parameters
path
string | URL
options?
O
Returns
Promise<ContentType<O>>
readFileSync()
1function readFileSync<O>(path, options?): ContentType<O>
Defined in: packages/fs/src/read/read-file-sync.ts:18
Type Parameters
• O extends ReadFileOptions<"brotli" | "gzip" | "none"> = undefined
Parameters
path
string | URL
options?
O
Returns
ContentType<O>
readJson()
Call Signature
1function readJson<T>(path, options?): Promise<T>
Defined in: packages/fs/src/read/read-json.ts:8
Type Parameters
• T extends JsonValue
Parameters
path
string | URL
options?
Returns
Promise<T>
Call Signature
1function readJson<T>( 2 path, 3 reviver, 4options?): Promise<T>
Defined in: packages/fs/src/read/read-json.ts:10
Type Parameters
• T extends JsonValue
Parameters
path
string | URL
reviver
(this, key, value) => any
options?
Returns
Promise<T>
readJsonSync()
Call Signature
1function readJsonSync<T>(path, options?): T
Defined in: packages/fs/src/read/read-json-sync.ts:8
Type Parameters
• T extends JsonValue
Parameters
path
string | URL
options?
Returns
T
Call Signature
1function readJsonSync<T>( 2 path, 3 reviver, 4 options?): T
Defined in: packages/fs/src/read/read-json-sync.ts:10
Type Parameters
• T extends JsonValue
Parameters
path
string | URL
reviver
(this, key, value) => any
options?
Returns
T
remove()
1function remove(path, options): Promise<void>
Defined in: packages/fs/src/remove/remove.ts:5
Parameters
path
string | URL
options
maxRetries?
number
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
Default
10
retryDelay?
number
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
Default
1100
Returns
Promise<void>
removeSync()
1function removeSync(path, options): void
Defined in: packages/fs/src/remove/remove-sync.ts:5
Parameters
path
string | URL
options
maxRetries?
number
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
Default
10
retryDelay?
number
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
Default
1100
Returns
void
rename()
1function rename( 2 source, 3 destination, 4options?): Promise<void>
Defined in: packages/fs/src/move/index.ts:85
Rename a file asynchronously.
Parameters
source
string
The file you want to rename.
destination
string
The name of the renamed file.
options?
Configuration options.
Returns
Promise<void>
A Promise that resolves when the file has been renamed.
Example
import { renameFile } from '@visulima/fs';
await renameFile('test.png', 'tests.png', {cwd: 'source'});
console.log('The file has been renamed');
renameSync()
1function renameSync(
2 source,
3 destination,
4 options?): voidDefined in: packages/fs/src/move/index.ts:109
Rename a file synchronously.
Parameters
source
string
The file you want to rename.
destination
string
The name of the renamed file.
options?
Configuration options.
Returns
void
A Promise that resolves when the file has been renamed.
Example
import {renameFileSync} from '@visulima/fs';
renameFileSync('test.png', 'tests.png', {cwd: 'source'});
console.log('The file has been renamed');
walk()
1function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>
Defined in: packages/fs/src/find/walk.ts:49
Walks the file tree rooted at root, yielding each file or directory in the tree filtered according to the given options. Options:
- maxDepth?: number = Infinity;
- includeFiles?: boolean = true;
- includeDirs?: boolean = true;
- includeSymlinks?: boolean = true;
- followSymlinks?: boolean = false;
- extensions?: string[];
- match?: string | ReadonlyArray
; - skip?: string | ReadonlyArray
;
Parameters
directory
string | URL
__namedParameters
WalkOptions = {}
Returns
AsyncIterableIterator<WalkEntry>
walkSync()
1function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>Defined in: packages/fs/src/find/walk-sync.ts:40
Same as walk but uses synchronous ops
Parameters
directory
string | URL
__namedParameters
WalkOptions = {}
Returns
IterableIterator<WalkEntry>
writeFile()
1function writeFile(
2 path,
3 content,
4options?): Promise<void>Defined in: packages/fs/src/write/write-file.ts:15
Parameters
path
string | URL
content
string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>
options?
Returns
Promise<void>
writeFileSync()
1function writeFileSync(
2 path,
3 content,
4 options?): voidDefined in: packages/fs/src/write/write-file-sync.ts:15
Parameters
path
string | URL
content
string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>
options?
Returns
void
writeJson()
1function writeJson(
2 path,
3 data,
4options): Promise<void>Defined in: packages/fs/src/write/write-json.ts:11
Parameters
path
string | URL
data
unknown
options
WriteJsonOptions = {}
Returns
Promise<void>
writeJsonSync()
1function writeJsonSync(
2 path,
3 data,
4 options): voidDefined in: packages/fs/src/write/write-json-sync.ts:11
Parameters
path
string | URL
data
unknown
options
WriteJsonOptions = {}
Returns
void
Variables
CRLF
1const CRLF: "\r\n";
Defined in: packages/fs/src/eol.ts:9
End-of-line character for Windows platforms.
EOL
1const EOL: "\n" | "\r\n";Defined in: packages/fs/src/eol.ts:14
End-of-line character evaluated for the current platform.
F_OK
1const F_OK: 0 = 0;
Defined in: packages/fs/src/constants.ts:2
Is the path visible to the calling process?
FIND_UP_STOP
1const FIND_UP_STOP: typeof FIND_UP_STOP;
Defined in: packages/fs/src/constants.ts:13
LF
1const LF: "\n";
Defined in: packages/fs/src/eol.ts:6
End-of-line character for POSIX platforms such as macOS and Linux.
R_OK
1const R_OK: 4 = 4;
Defined in: packages/fs/src/constants.ts:5
Is the path readable to the calling process?
W_OK
1const W_OK: 2 = 2;
Defined in: packages/fs/src/constants.ts:8
Is the path writable to the calling process?
X_OK
1const X_OK: 1 = 1;
Defined in: packages/fs/src/constants.ts:11
Is the path executable to the calling process?
Interfaces
WalkEntry
Defined in: packages/fs/src/types.ts:56
Extends
Pick<Dirent,"isDirectory"|"isFile"|"isSymbolicLink"|"name">
Methods
isDirectory()
1isDirectory(): boolean
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/fs.d.ts:190
Returns true if the fs.Dirent object describes a file system
directory.
Returns
boolean
Since
v10.10.0
Inherited from
1Pick.isDirectoryisFile()
1isFile(): boolean
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/fs.d.ts:184
Returns true if the fs.Dirent object describes a regular file.
Returns
boolean
Since
v10.10.0
Inherited from
1Pick.isFileisSymbolicLink()
1isSymbolicLink(): boolean
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/fs.d.ts:205
Returns true if the fs.Dirent object describes a symbolic link.
Returns
boolean
Since
v10.10.0
Inherited from
1Pick.isSymbolicLinkProperties
name
1name: string;
Defined in: node_modules/.pnpm/@types+node@18.19.71/node_modules/@types/node/fs.d.ts:222
The file name that this fs.Dirent object refers to. The type of this
value is determined by the options.encoding passed to readdir or readdirSync.
Since
v10.10.0
Inherited from
1Pick.namepath
1path: string;
Defined in: packages/fs/src/types.ts:57
WalkOptions
Defined in: packages/fs/src/types.ts:9
Properties
extensions?
1optional extensions: string[];
Defined in: packages/fs/src/types.ts:15
List of file extensions used to filter entries. If specified, entries without the file extension specified by this option are excluded.
Default
1{undefined}
followSymlinks?
1optional followSymlinks: boolean;
Defined in: packages/fs/src/types.ts:20
Indicates whether symlinks should be resolved or not.
Default
1{false}
includeDirs?
1optional includeDirs: boolean;
Defined in: packages/fs/src/types.ts:25
Indicates whether directory entries should be included or not.
Default
1{true}
includeFiles?
1optional includeFiles: boolean;
Defined in: packages/fs/src/types.ts:30
Indicates whether file entries should be included or not.
Default
1{true}
includeSymlinks?
1optional includeSymlinks: boolean;
Defined in: packages/fs/src/types.ts:36
Indicates whether symlink entries should be included or not.
This option is meaningful only if followSymlinks is set to false.
Default
1{true}
match?
1optional match: (string | RegExp)[];
Defined in: packages/fs/src/types.ts:42
List of regular expression or glob patterns used to filter entries. If specified, entries that do not match the patterns specified by this option are excluded.
Default
1{undefined}
maxDepth?
1optional maxDepth: number;
Defined in: packages/fs/src/types.ts:47
The maximum depth of the file tree to be walked recursively.
Default
1{Infinity}
skip?
1optional skip: (string | RegExp)[];
Defined in: packages/fs/src/types.ts:53
List of regular expression or glob patterns used to filter entries. If specified, entries matching the patterns specified by this option are excluded.
Default
1{undefined}
Type Aliases
CodeFrameLocation
1type CodeFrameLocation = object;
Defined in: packages/fs/src/types.ts:91
Type declaration
column?
1optional column: number;
line
1line: number;
EmptyDirOptions
1type EmptyDirOptions = object;
Defined in: packages/fs/src/types.ts:188
Type declaration
maxRetries?
1optional maxRetries: number;
If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or
EPERM error is encountered, Node.js will retry the operation with a linear
backoff wait of retryDelay ms longer on each try. This option represents the
number of retries. This option is ignored if the recursive option is not
true.
Default
10
retryDelay?
1optional retryDelay: number;
The amount of time in milliseconds to wait between retries.
This option is ignored if the recursive option is not true.
Default
1100
FindUpName
1type FindUpName = 2 | string[] 3 | string 4 | (directory) => FindUpNameFnResult;
Defined in: packages/fs/src/types.ts:180
FindUpNameFnResult
1type FindUpNameFnResult = 2 | PathLike 3 | Promise<PathLike | typeof FIND_UP_STOP> 4 | typeof FIND_UP_STOP 5 | undefined;
Defined in: packages/fs/src/types.ts:178
FindUpNameSync
1type FindUpNameSync = 2 | string[] 3 | string 4 | (directory) => FindUpNameSyncFnResult;
Defined in: packages/fs/src/types.ts:185
FindUpNameSyncFnResult
1type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
Defined in: packages/fs/src/types.ts:183
FindUpOptions
1type FindUpOptions = object;
Defined in: packages/fs/src/types.ts:170
Type declaration
allowSymlinks?
1optional allowSymlinks: boolean;
cwd?
1optional cwd: URL | string;
stopAt?
1optional stopAt: URL | string;
type?
1optional type: "directory" | "file";
JsonReplacer
1type JsonReplacer = (number | string)[] | (this, key, value) => unknown | null;
Defined in: packages/fs/src/types.ts:143
JsonReviver
1type JsonReviver = Parameters<typeof JSON["parse"]>["1"];
Defined in: packages/fs/src/types.ts:89
MoveOptions
1type MoveOptions = object;
Defined in: packages/fs/src/move/types.ts:3
Type declaration
cwd?
1optional cwd: URL | string;
The working directory to find source files. The source and destination path are relative to this.
Default
1process.cwd()
directoryMode?
1readonly optional directoryMode: FilePermissions;
Permissions for created directories.
It has no effect on Windows.
Default
10o777
overwrite?
1readonly optional overwrite: boolean;
Overwrite existing destination file.
Default
1true
ReadFileEncoding
1type ReadFileEncoding = 2 | "ascii" 3 | "base64" 4 | "base64url" 5 | "hex" 6 | "latin1" 7 | "ucs-2" 8 | "ucs2" 9 | "utf-8" 10 | "utf-16le" 11 | "utf8" 12 | "utf16le";
Defined in: packages/fs/src/types.ts:61
ReadFileOptions<C>
1type ReadFileOptions<C> = object;
Defined in: packages/fs/src/types.ts:63
Type Parameters
• C
Type declaration
buffer?
1optional buffer: boolean;
Return content as a Buffer. Default: false
compression?
1optional compression: C;
Compression method to decompress the file against. Default: none
encoding?
1optional encoding: ReadFileEncoding;
The encoding to use. Default: utf8
See
https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
flag?
1optional flag: number | string;
The flag used to open the file. Default: r
ReadJsonOptions
1type ReadJsonOptions = CodeFrameOptions & object;
Defined in: packages/fs/src/types.ts:104
Type declaration
beforeParse()?
1optional beforeParse: (source) => string;
Parameters
source
string
Returns
string
WriteFileOptions
1type WriteFileOptions = object;
Defined in: packages/fs/src/types.ts:108
Type declaration
chown?
1optional chown: object;
The group and user ID used to set the file ownership. Default: undefined
chown.gid
1gid: number;
chown.uid
1uid: number;
encoding?
1optional encoding: BufferEncoding | null;
The encoding to use. Default: utf8
flag?
1optional flag: string;
The flag used to write the file. Default: w
mode?
1optional mode: number;
The file mode (permission and sticky bits). Default: 0o666
overwrite?
1optional overwrite: boolean;
Indicates whether the file should be overwritten if it already exists. Default: false
recursive?
1optional recursive: boolean;
Recursively create parent directories if needed. Default: true
WriteJsonOptions
1type WriteJsonOptions = WriteFileOptions & object;
Defined in: packages/fs/src/types.ts:146
Type declaration
detectIndent?
1optional detectIndent: boolean;
Detect indentation automatically if the file exists. Default: false
indent?
1optional indent: number | string;
The space used for pretty-printing.
Pass in undefined for no formatting.
replacer?
1optional replacer: JsonReplacer;
Passed into JSON.stringify.
stringify()?
1optional stringify: (data, replacer, space) => string;
Override the default JSON.stringify method.
Parameters
data
unknown
replacer
space
number | string | undefined
Returns
string
size
Functions
brotliSize()
1function brotliSize(input, options?): Promise<number>Defined in: packages/fs/src/size.ts:109
Asynchronously calculates the Brotli compressed size of the input. Uses memory-efficient streaming for large inputs.
Parameters
input
string | URL | Buffer<ArrayBufferLike> | Readable
options?
BrotliOptions
Returns
Promise<number>
brotliSizeSync()
1function brotliSizeSync(input, options?): numbe
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
1 out of 1 merged PRs checked by a CI test -- score normalized to 10
Reason
project has 4 contributing companies or organizations
Details
- Info: narrowspark contributor org/company found, anolilab contributor org/company found, growcss contributor org/company found, visulima contributor org/company found,
Reason
no dangerous workflow patterns detected
Reason
update tool detected
Details
- Info: detected update tool: RenovateBot: .github/renovate.json5:1
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (1) are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 8
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:84
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:237
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:135
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:186
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock-file-maintenance.yml:39
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/preview-release.yaml:50
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/semantic-release.yml:59
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/semantic-release.yml:78
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:96
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:164
- Warn: downloadThenRun not pinned by hash: .github/workflows/lint.yml:305
- Info: 25 out of 25 GitHub-owned GitHubAction dependencies pinned
- Info: 44 out of 54 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 downloadThenRun dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:34
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:33
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/lock-file-maintenance.yml:20
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/preview-release.yaml:22
- Warn: jobLevel 'checks' permission set to 'write': .github/workflows/preview-release.yaml:24
- Info: jobLevel 'pull-requests' permission set to 'read': .github/workflows/require-allow-edits.yml:11
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/scorecards.yml:31
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/scorecards.yml:32
- Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/semantic-pull-request.yml:21
- Warn: no topLevel permission defined: .github/workflows/allo-allo.yaml:1
- Warn: no topLevel permission defined: .github/workflows/cache-clear.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:24
- Info: topLevel 'contents' permission set to 'read': .github/workflows/comment-issue.yml:9
- Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:17
- Info: topLevel 'contents' permission set to 'read': .github/workflows/lint.yml:16
- Info: topLevel 'contents' permission set to 'read': .github/workflows/lock-file-maintenance.yml:12
- Warn: no topLevel permission defined: .github/workflows/lock-issues.yaml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/preview-release.yaml:8
- Info: topLevel 'contents' permission set to 'read': .github/workflows/require-allow-edits.yml:6
- Info: topLevel permissions set to 'read-all': .github/workflows/scorecards.yml:20
- Info: topLevel 'contents' permission set to 'read': .github/workflows/semantic-pull-request.yml:15
- Info: topLevel 'contents' permission set to 'read': .github/workflows/semantic-release.yml:17
- Warn: no topLevel permission defined: .github/workflows/stale-issues.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/test.yml:16
Score
6.3
/10
Last Scanned on 2025-04-01T07:30:39Z
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