fix(ngdoc): should ignore watch json files #364

docgeni · Jul 31, 2022 · 3bd92ab · 3bd92ab
1 parent e2b8b25
commit 3bd92ab
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/packages/ngdoc/src/ng-parser-host.ts b/packages/ngdoc/src/ng-parser-host.ts
@@ -106,6 +106,11 @@ export class DefaultNgParserHost implements NgParserHost {
             if (this.moduleWatchersMap.get(resolvedModule.resolvedFileName) || !resolvedModule.resolvedFileName.includes(this.rootDir)) {
                 return;
             }
+            // Note: ignore json file, it will always trigger watch callback event for json file
+            // see https://github.com/docgeni/docgeni/issues/364
+            if (resolvedModule.resolvedFileName.endsWith('.json')) {
+                return;
+            }
             debug(`watch resolvedModule: ${resolvedModule.resolvedFileName}`, 'ng-parser');
             const watcher = toolkit.fs.watch(resolvedModule.resolvedFileName, { persistent: true }, (event: string, filename: string) => {
                 this.tsProgram = this.createProgram();

diff --git a/packages/ngdoc/test/fixtures/tsconfig/src/button.component.ts b/packages/ngdoc/test/fixtures/tsconfig/src/button.component.ts
@@ -1,9 +1,10 @@
 import { Component } from '@angular/core';
+import users from './users.json';
 
 @Component({
     selector: 'button',
-    template: `button`
+    template: `
+        button
+    `
 })
-export class ButtonComponent {
-
-}
+export class ButtonComponent {}
diff --git a/packages/ngdoc/test/fixtures/tsconfig/src/users.json b/packages/ngdoc/test/fixtures/tsconfig/src/users.json
@@ -0,0 +1 @@
+[{}]
diff --git a/packages/ngdoc/test/fixtures/tsconfig/tsconfig.json b/packages/ngdoc/test/fixtures/tsconfig/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "experimentalDecorators": true
+    "experimentalDecorators": true,
+    "resolveJsonModule": true
   },
   // "files": ["./src/public-api.ts"]
   "include": ["src/"]