refactor(@angular-devkit/core): use chokidar types instead of custom interface

alan-agius4 · alan-agius4 · commit a169f26513cb · 2021-10-09T07:04:18.000+02:00
Replace `ChokidarWatcher` with types from `chokidar`
diff --git a/goldens/public-api/angular_devkit/core/node/index.md b/goldens/public-api/angular_devkit/core/node/index.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { ErrorObject } from 'ajv';
 import { Format } from 'ajv';
 import { Observable } from 'rxjs';
diff --git a/goldens/public-api/angular_devkit/schematics/src/index.md b/goldens/public-api/angular_devkit/schematics/src/index.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { analytics } from '@angular-devkit/core';
 import { BaseException } from '@angular-devkit/core';
 import { logging } from '@angular-devkit/core';
diff --git a/goldens/public-api/angular_devkit/schematics/tasks/index.md b/goldens/public-api/angular_devkit/schematics/tasks/index.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 // @public (undocumented)
 export class NodePackageInstallTask implements TaskConfigurationGenerator<NodePackageTaskOptions> {
     constructor(workingDirectory?: string);
diff --git a/goldens/public-api/angular_devkit/schematics/testing/index.md b/goldens/public-api/angular_devkit/schematics/testing/index.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { analytics } from '@angular-devkit/core';
 import { logging } from '@angular-devkit/core';
 import { Observable } from 'rxjs';
diff --git a/packages/angular_devkit/core/node/BUILD.bazel b/packages/angular_devkit/core/node/BUILD.bazel
@@ -28,6 +28,7 @@ ts_library(
     deps = [
         "//packages/angular_devkit/core",
         "@npm//@types/node",
+        "@npm//chokidar",
         "@npm//rxjs",
     ],
 )
diff --git a/packages/angular_devkit/core/node/host.ts b/packages/angular_devkit/core/node/host.ts
@@ -6,6 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import type { FSWatcher as ChokidarWatcher } from 'chokidar';
 import fs, {
   PathLike,
   Stats,
@@ -20,7 +21,7 @@ import fs, {
   unlinkSync,
   writeFileSync,
 } from 'fs';
-import { dirname as pathDirname, join as pathJoin } from 'path';
+import { dirname as pathDirname } from 'path';
 import { Observable, concat, from as observableFrom, of, throwError } from 'rxjs';
 import { concatMap, map, mergeMap, publish, refCount } from 'rxjs/operators';
 import {
@@ -34,18 +35,6 @@ import {
   virtualFs,
 } from '../src';
 
-interface ChokidarWatcher {
-  // eslint-disable-next-line @typescript-eslint/no-misused-new
-  new (options: {}): ChokidarWatcher;
-
-  add(path: string): ChokidarWatcher;
-  on(type: 'change', cb: (path: string) => void): ChokidarWatcher;
-  on(type: 'add', cb: (path: string) => void): ChokidarWatcher;
-  on(type: 'unlink', cb: (path: string) => void): ChokidarWatcher;
-
-  close(): void;
-}
-
 async function exists(path: PathLike): Promise<boolean> {
   try {
     await fsPromises.access(path, constants.F_OK);
@@ -59,7 +48,7 @@ async function exists(path: PathLike): Promise<boolean> {
 // This will only be initialized if the watch() method is called.
 // Otherwise chokidar appears only in type positions, and shouldn't be referenced
 // in the JavaScript output.
-let FSWatcher: ChokidarWatcher;
+let FSWatcher: typeof ChokidarWatcher;
 function loadFSWatcher() {
   if (!FSWatcher) {
     try {
@@ -161,7 +150,8 @@ export class NodeJsAsyncHost implements virtualFs.Host<Stats> {
   ): Observable<virtualFs.HostWatchEvent> | null {
     return new Observable<virtualFs.HostWatchEvent>((obs) => {
       loadFSWatcher();
-      const watcher = new FSWatcher({ persistent: true }).add(getSystemPath(path));
+      const watcher = new FSWatcher({ persistent: true });
+      watcher.add(getSystemPath(path));
 
       watcher
         .on('change', (path) => {
@@ -308,9 +298,9 @@ export class NodeJsSyncHost implements virtualFs.Host<Stats> {
     _options?: virtualFs.HostWatchOptions,
   ): Observable<virtualFs.HostWatchEvent> | null {
     return new Observable<virtualFs.HostWatchEvent>((obs) => {
-      const opts = { persistent: false };
       loadFSWatcher();
-      const watcher = new FSWatcher(opts).add(getSystemPath(path));
+      const watcher = new FSWatcher({ persistent: false });
+      watcher.add(getSystemPath(path));
 
       watcher
         .on('change', (path) => {

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ ts_library(`
`28`	`28`	`deps = [`
`29`	`29`	`"//packages/angular_devkit/core",`
`30`	`30`	`"@npm//@types/node",`
	`31`	`+ "@npm//chokidar",`
`31`	`32`	`"@npm//rxjs",`
`32`	`33`	`],`
`33`	`34`	`)`