fsevents 2.0.7 → 2.1.0

package/.github/workflows/nodejs.yml

@@ -0,0 +1,26 @@
+name: Node CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: macOS-latest
+
+    strategy:
+      matrix:
+        node-version: [8, 10, 12]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Node v${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: npm install, build, and test
+      run: |
+        npm install
+        npm run build --if-present
+        npm test
+      env:
+        CI: true

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar
+Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -11,6 +11,8 @@ uses fsevents, check out [Chokidar](https://github.com/paulmillr/chokidar).
 
 ## Installation
 
+Supports only **Node.js v8.16 and higher**.
+
 ```sh
 npm install fsevents
 ```
@@ -28,13 +30,15 @@ stop(); // To end observation
 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:
 
-`(path: String, flags: Number, id: String) => {}`
+###### `fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): Function`
 
- * `path` - the item in the filesystem that have been changed
- * `flags` - a numeric value describing what the change was
- * `id` - an unique-id identifying this specific event
+ * `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.
 
-###### `fsevents.getInfo(path, flags, id): FsEventInfo => {}`
+###### `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.
@@ -62,6 +66,6 @@ The `FsEventsInfo` has the following shape:
 
 ## License
 
-The MIT License Copyright (C) 2010-2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar — see LICENSE file.
+The MIT License Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.
 
 Visit our [GitHub page](https://github.com/fsevents/fsevents) and [NPM Page](https://npmjs.org/package/fsevents)

package/fsevents.js

@@ -1,7 +1,7 @@
 /*
-** © 2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar
-** Licensed under MIT License.
-*/
+ ** © 2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
+ ** Licensed under MIT License.
+ */
 
 /* jshint node:true */
 'use strict';
@@ -11,11 +11,15 @@ if (process.platform !== 'darwin') {
 }
 
 const Native = require('./fsevents.node');
-const con = Native.constants;
+const events = Native.constants;
 
 function watch(path, handler) {
-  if ('string' !== typeof path) throw new TypeError(`argument 1 must be a string and not a ${typeof path}`);
-  if ('function' !== typeof handler) throw new TypeError(`argument 2 must be a function and not a ${typeof handler}`);
+  if (typeof path !== 'string') {
+    throw new TypeError(`fsevents argument 1 must be a string and not a ${typeof path}`);
+  }
+  if (typeof handler !== 'function') {
+    throw new TypeError(`fsevents argument 2 must be a function and not a ${typeof handler}`);
+  }
 
   let instance = Native.start(path, handler);
   if (!instance) throw new Error(`could not watch: ${path}`);
@@ -25,9 +29,11 @@ function watch(path, handler) {
     return result;
   };
 }
+
 function getInfo(path, flags) {
   return {
-    path, flags,
+    path,
+    flags,
     event: getEventType(flags),
     type: getFileType(flags),
     changes: getFileChanges(flags)
@@ -35,28 +41,35 @@ function getInfo(path, flags) {
 }
 
 function getFileType(flags) {
-  if (con.kFSEventStreamEventFlagItemIsFile & flags) return 'file';
-  if (con.kFSEventStreamEventFlagItemIsDir & flags) return 'directory';
-  if (con.kFSEventStreamEventFlagItemIsSymlink & flags) return 'symlink';
+  if (events.ItemIsFile & flags) return 'file';
+  if (events.ItemIsDir & flags) return 'directory';
+  if (events.ItemIsSymlink & flags) return 'symlink';
+}
+function anyIsTrue(obj) {
+  for (let key in obj) {
+    if (obj[key]) return true;
+  }
+  return false;
 }
 function getEventType(flags) {
-  if (con.kFSEventStreamEventFlagItemRemoved & flags) return 'deleted';
-  if (con.kFSEventStreamEventFlagItemRenamed & flags) return 'moved';
-  if (con.kFSEventStreamEventFlagItemCreated & flags) return 'created';
-  if (con.kFSEventStreamEventFlagItemModified & flags) return 'modified';
-  if (con.kFSEventStreamEventFlagRootChanged & flags) return 'root-changed';
-
+  if (events.ItemRemoved & flags) return 'deleted';
+  if (events.ItemRenamed & flags) return 'moved';
+  if (events.ItemCreated & flags) return 'created';
+  if (events.ItemModified & flags) return 'modified';
+  if (events.RootChanged & flags) return 'root-changed';
+  if (events.ItemCloned & flags) return 'cloned';
+  if (anyIsTrue(flags)) return 'modified';
   return 'unknown';
 }
 function getFileChanges(flags) {
   return {
-    inode: !!(con.kFSEventStreamEventFlagItemInodeMetaMod & flags),
-    finder: !!(con.kFSEventStreamEventFlagItemFinderInfoMod & flags),
-    access: !!(con.kFSEventStreamEventFlagItemChangeOwner & flags),
-    xattrs: !!(con.kFSEventStreamEventFlagItemXattrMod & flags)
+    inode: !!(events.ItemInodeMetaMod & flags),
+    finder: !!(events.ItemFinderInfoMod & flags),
+    access: !!(events.ItemChangeOwner & flags),
+    xattrs: !!(events.ItemXattrMod & flags)
   };
 }
 
 exports.watch = watch;
 exports.getInfo = getInfo;
-exports.constants = con;
+exports.constants = events;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fsevents",
-  "version": "2.0.7",
-  "description": "Native Access to Mac OS-X FSEvents",
+  "version": "2.1.0",
+  "description": "Native Access to MacOS FSEvents",
   "main": "fsevents.js",
   "os": [
     "darwin"
@@ -39,12 +39,15 @@
     {
       "name": "Miroslav Bajtoš",
       "email": "mbajtoss@gmail.com"
+    },
+    {
+      "name": "Paul Miller",
+      "url": "https://paulmillr.com"
     }
   ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fsevents/fsevents/issues"
   },
-  "homepage": "https://github.com/fsevents/fsevents",
-  "devDependencies": {}
+  "homepage": "https://github.com/fsevents/fsevents"
 }