add comments to why require used for git-repo-info

saisandeepvaddi · Jun 2, 2019 · 0275599 · 0275599
1 parent 7994b5c
commit 0275599
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/ui/src/components/ProjectTopbar/ProjectTopbar.tsx b/ui/src/components/ProjectTopbar/ProjectTopbar.tsx
@@ -7,6 +7,10 @@ import NewCommandDrawer from "../NewCommandDrawer";
 import { useConfig } from "../shared/Config";
 import { useProjects } from "../shared/Projects";
 import { useTheme } from "../shared/Themes";
+
+// Have to use require because it's type-definition doesn't have function that allows path
+// Do not want to update node_module's file.
+// tslint:disable-next-line: no-var-requires
 const getRepoInfo = require("git-repo-info");
 
 interface IProjectTopbarProps {