npmpackage.info

Gathering detailed insights and metrics for vscode-fsevents

Other packages similar to vscode-fsevents

fsevents

2.3.3

Native Access to MacOS FSEvents

@nicolo-ribaudo/chokidar-2

2.1.8-no-fsevents.3

A wrapper around chokidar@2 to be able to specify both @2 and @3 as dependencies

@yarnpkg/plugin-compat

4.0.10

vscode-languageserver-types

3.17.5

Types used by the Language server for node

Gathering detailed insights and metrics for vscode-fsevents

vscode-fsevents

Native access to MacOS FSEvents in Node.js

1.2.12

568

MIT

292,569 3.7

Installations

npm install vscode-fsevents

Pull Requests

Open

2

Total

121

Closed

40

Merged

79

Issues

Open

9

Total

276

Closed

267

Releases

Release v2.3.3

v2.3.3

Published on 21 Aug 2023

Release v2.3.2

v2.3.2

Published on 05 Feb 2021

Release v2.3.1

v2.3.1

Published on 05 Jan 2021

Release v2.2.2

v2.2.2

Published on 05 Jan 2021

Release v2.2.0

v2.2.0

Published on 03 Nov 2020

Release v1.2.13

v1.2.13

Published on 06 May 2020

View all 48 releases

Developer

strongloop

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=6.0.0

Typescript Support

No

Node Version

10.16.0

NPM Version

6.9.0 Statistics

568 Stars

277 Commits

119 Forks

33 Watching

3 Branches

35 Contributors

Updated on 26 Oct 2024

Languages

C (50.64%)

JavaScript (44.83%)

Python (2.81%)

Shell (1.72%)

Total Downloads

Cumulative downloads

Total Downloads

292,569

Last day

8.5%

Compared to previous day

Last week

19.9%

289

Compared to previous week

Last month

-22.6%

1,415

Compared to previous month

Last year

10.2%

13,411

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

nan

Dev Dependencies

node-gyp

Versions

fsevents

Native access to MacOS FSEvents in Node.js

The FSEvents API in MacOS allows applications to register for notifications of changes to a given directory tree. It is a very fast and lightweight alternative to kqueue.

This is a low-level library. For a cross-platform file watching module that uses fsevents, check out Chokidar.

Usage

1npm install fsevents

Supports only Node.js v8.16 and higher.

1const fsevents = require('fsevents');
2
3// To start observation
4const stop = fsevents.watch(__dirname, (path, flags, id) => {
5  const info = fsevents.getInfo(path, flags);
6});
7
8// To end observation
9stop();

Important note: The API behaviour is slightly different from typical JS APIs. The stop function must be retrieved and stored somewhere, even if you don't plan to stop the watcher. If you forget it, the garbage collector will eventually kick in, the watcher will be unregistered, and your callbacks won't be called anymore.

The callback passed as the second parameter to .watch get's called whenever the operating system detects a a change in the file system. It takes three arguments:

`fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): () => Promise<undefined>`

path: string - the item in the filesystem that have been changed
flags: number - a numeric value describing what the change was
id: string - an unique-id identifying this specific event

Returns closer callback which when called returns a Promise resolving when the watcher process has been shut down.

`fsevents.getInfo(path: string, flags: number, id: string): FsEventInfo`

The getInfo function takes the path, flags and id arguments and converts those parameters into a structure that is easier to digest to determine what the change was.

The FsEventsInfo has the following shape:

1/**
2 * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent
3 * @typedef {'file'|'directory'|'symlink'} FsEventsType
4 */
5{
6  "event": "created", // {FsEventsEvent}
7  "path": "file.txt",
8  "type": "file",    // {FsEventsType}
9  "changes": {
10    "inode": true,   // Had iNode Meta-Information changed
11    "finder": false, // Had Finder Meta-Data changed
12    "access": false, // Had access permissions changed
13    "xattrs": false  // Had xAttributes changed
14  },
15  "flags": 0x100000000
16}

Changelog

v2.3 supports Apple Silicon ARM CPUs
v2 supports node 8.16+ and reduces package size massively
v1.2.8 supports node 6+
v1.2.7 supports node 4+

Troubleshooting

I'm getting EBADPLATFORM Unsupported platform for fsevents error.
It's fine, nothing is broken. fsevents is macos-only. Other platforms are skipped. If you want to hide this warning, report a bug to NPM bugtracker asking them to hide ebadplatform warnings by default.

License

Visit our GitHub page and NPM Page

No vulnerabilities found.

10

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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.

Reason

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

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/fsevents/fsevents/publish.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:25
Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:56
Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:18
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

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

SAST

Determines if the project uses static code analysis.

Score

3.7

/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