@ms-cloudpack/file-watcher 0.0.2

package/README.md

@@ -0,0 +1,34 @@
+# @ms-cloudpack/file-watcher
+
+An abstraction on the file watching capabilities used in Cloudpack.
+
+## Example usage
+
+1. Create a watcher:
+
+```ts
+const watcher = createWatcher();
+```
+
+2. Subscribe to a particular package path using `watch`. (Returns an `unwatch` function.)
+
+```ts
+const unwatch = watcher.watch({ path: 'path/to/package' }, () => console.log(`package changed`));
+```
+
+3. To dispose, call the returned `unwatch`, or call `watcher.unwatchAll` to unsubscribe from all watchers.
+
+```ts
+// Dispose an individual watcher.
+await unwatch();
+
+// Dispose all watchers.
+await watcher.unwatchAll();
+```
+
+### `watcher.watch` options
+
+| Name           | Type     | Description                                                                               |
+| -------------- | -------- | ----------------------------------------------------------------------------------------- |
+| `path`         | string   | The absolute base path to be watched.                                                     |
+| `watchedPaths` | string[] | Relative paths from the base path to watch. Defaults to `package.json` and `src/` folder. |

package/lib/createWatcher.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Creates a watcher which can watch a package and notify the client when it changes.
+ */
+export declare function createWatcher(): {
+    watch({ path, watchPaths, }: {
+        path: string;
+        watchPaths?: string[] | undefined;
+    }, onPackageChanged: () => void): () => Promise<void>;
+    unwatchAll(): Promise<void>;
+};
+export type Watcher = ReturnType<typeof createWatcher>;
+//# sourceMappingURL=createWatcher.d.ts.map

package/lib/createWatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWatcher.d.ts","sourceRoot":"","sources":["../src/createWatcher.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,wBAAgB,aAAa;;cAUf,MAAM;;yBAGI,MAAM,IAAI;;EAuCjC;AAED,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC"}

package/lib/createWatcher.js

@@ -0,0 +1,46 @@
+import chokidar from 'chokidar';
+import { resolve } from 'path';
+// TODO: This list of watched paths is hardcoded, but really it shouldn't be. In fact, this whole file
+// probably shouldn't be here. I think lage should be responsible for understanding what "bundle" means
+// (we can provide a definition) and what its inputs are and what it depends on. Then when we call
+// ensurePackageBundled, lage can ensure watching is happening for the full graph of tasks.
+const defaultWatchPaths = ['./package.json', './src'];
+/**
+ * Creates a watcher which can watch a package and notify the client when it changes.
+ */
+export function createWatcher() {
+    const watchedPaths = new Set();
+    const watchers = new Set();
+    return {
+        watch({ path, watchPaths = defaultWatchPaths, }, onPackageChanged) {
+            const paths = watchPaths.map((relPath) => resolve(path, relPath)).filter((p) => !watchedPaths.has(p));
+            let watcher;
+            if (paths.length) {
+                // Add paths to watchedPaths to avoid watching them again.
+                paths.forEach((p) => watchedPaths.add(p));
+                // Watch source and register a handler which will rebundle the changed package and notify the client on
+                // success. Note that if failures happen, the client will receive the error notification automatically.
+                watcher = chokidar.watch(paths).on('change', onPackageChanged);
+                watchers.add(watcher);
+            }
+            // Return a dispose function to individually clean up.
+            return async () => {
+                if (watcher) {
+                    const w = watcher;
+                    watcher = undefined;
+                    watchers.delete(w);
+                    for (const watchedPath of paths) {
+                        watchedPaths.delete(watchedPath);
+                    }
+                    await w.close();
+                }
+            };
+        },
+        async unwatchAll() {
+            await Promise.all(Array.from(watchers).map((w) => w.close()));
+            watchers.clear();
+            watchedPaths.clear();
+        },
+    };
+}
+//# sourceMappingURL=createWatcher.js.map

package/lib/createWatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWatcher.js","sourceRoot":"","sources":["../src/createWatcher.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,sGAAsG;AACtG,uGAAuG;AACvG,kGAAkG;AAClG,2FAA2F;AAC3F,MAAM,iBAAiB,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAa,CAAC;IAEtC,OAAO;QACL,KAAK,CACH,EACE,IAAI,EACJ,UAAU,GAAG,iBAAiB,GAI/B,EACD,gBAA4B;YAE5B,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACtG,IAAI,OAA8B,CAAC;YAEnC,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,0DAA0D;gBAC1D,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE1C,uGAAuG;gBACvG,uGAAuG;gBACvG,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;gBAE/D,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aACvB;YAED,sDAAsD;YACtD,OAAO,KAAK,IAAI,EAAE;gBAChB,IAAI,OAAO,EAAE;oBACX,MAAM,CAAC,GAAG,OAAO,CAAC;oBAElB,OAAO,GAAG,SAAS,CAAC;oBACpB,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAEnB,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE;wBAC/B,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;qBAClC;oBAED,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;iBACjB;YACH,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,UAAU;YACd,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC9D,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjB,YAAY,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type { FSWatcher } from 'chokidar';\nimport chokidar from 'chokidar';\nimport { resolve } from 'path';\n\n// TODO: This list of watched paths is hardcoded, but really it shouldn't be. In fact, this whole file\n// probably shouldn't be here. I think lage should be responsible for understanding what \"bundle\" means\n// (we can provide a definition) and what its inputs are and what it depends on. Then when we call\n// ensurePackageBundled, lage can ensure watching is happening for the full graph of tasks.\nconst defaultWatchPaths = ['./package.json', './src'];\n\n/**\n * Creates a watcher which can watch a package and notify the client when it changes.\n */\nexport function createWatcher() {\n  const watchedPaths = new Set<string>();\n  const watchers = new Set<FSWatcher>();\n\n  return {\n    watch(\n      {\n        path,\n        watchPaths = defaultWatchPaths,\n      }: {\n        path: string;\n        watchPaths?: string[];\n      },\n      onPackageChanged: () => void,\n    ) {\n      const paths = watchPaths.map((relPath) => resolve(path, relPath)).filter((p) => !watchedPaths.has(p));\n      let watcher: FSWatcher | undefined;\n\n      if (paths.length) {\n        // Add paths to watchedPaths to avoid watching them again.\n        paths.forEach((p) => watchedPaths.add(p));\n\n        // Watch source and register a handler which will rebundle the changed package and notify the client on\n        // success. Note that if failures happen, the client will receive the error notification automatically.\n        watcher = chokidar.watch(paths).on('change', onPackageChanged);\n\n        watchers.add(watcher);\n      }\n\n      // Return a dispose function to individually clean up.\n      return async () => {\n        if (watcher) {\n          const w = watcher;\n\n          watcher = undefined;\n          watchers.delete(w);\n\n          for (const watchedPath of paths) {\n            watchedPaths.delete(watchedPath);\n          }\n\n          await w.close();\n        }\n      };\n    },\n\n    async unwatchAll() {\n      await Promise.all(Array.from(watchers).map((w) => w.close()));\n      watchers.clear();\n      watchedPaths.clear();\n    },\n  };\n}\n\nexport type Watcher = ReturnType<typeof createWatcher>;\n"]}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { createWatcher } from './createWatcher.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/lib/index.js

@@ -0,0 +1,2 @@
+export { createWatcher } from './createWatcher.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["export { createWatcher } from './createWatcher.js';\n"]}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.36.2"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@ms-cloudpack/file-watcher",
+  "version": "0.0.2",
+  "description": "A file watcher abstraction for use with Cloudpack.",
+  "license": "MIT",
+  "type": "module",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "require": "./lib-commonjs/index.cjs",
+      "import": "./lib/index.js"
+    }
+  },
+  "dependencies": {
+    "chokidar": "^3.5.3"
+  },
+  "devDependencies": {
+    "@ms-cloudpack/eslint-plugin-internal": "*",
+    "@ms-cloudpack/scripts": "*"
+  },
+  "scripts": {
+    "api": "cloudpack-scripts api",
+    "build:watch": "cloudpack-scripts build-watch",
+    "build": "cloudpack-scripts build",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint",
+    "start": "node ./lib/test.js",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
+  },
+  "files": [
+    "lib/**/!(*.test.*)",
+    "lib-commonjs/**/!(*.test.*)"
+  ]
+}