make linkHosted boolean work

Author: andrewhong5297

autodoc.config.json

@@ -25,5 +25,6 @@
   "folderPrompt": "Write a technical explanation of what the code in this file does\n      and how it might fit into the larger project or work with other parts of the project.\n      Give examples of how this code might be used. Include code examples where appropriate.\n      Be concise. Include any information that may be relevant to a developer who is curious about this code.\n      Keep you response under 400 words. Output should be in markdown format.\n      Do not just list the files and folders in this folder.",
   "chatPrompt": "",
   "contentType": "code",
-  "targetAudience": "smart developer"
+  "targetAudience": "smart developer",
+  "linkHosted": false
 }

src/cli/commands/estimate/index.ts

@@ -19,7 +19,8 @@ export const estimate = async ({
   folderPrompt,
   chatPrompt,
   contentType,
-  targetAudience
+  targetAudience,
+  linkHosted,
 }: AutodocRepoConfig) => {
   const json = path.join(output, 'docs', 'json/');
 
@@ -41,7 +42,8 @@ export const estimate = async ({
       folderPrompt,
       chatPrompt,
       contentType,
-      targetAudience
+      targetAudience,
+      linkHosted,
     },
     true,
   );

src/cli/commands/index/convertJsonToMarkdown.ts

@@ -18,6 +18,7 @@ export const convertJsonToMarkdown = async ({
   folderPrompt: folderPrompt,
   contentType: contentType,
   targetAudience: targetAudience,
+  linkHosted: linkHosted,
 }: AutodocRepoConfig) => {
   /**
    * Count the number of files in the project
@@ -35,6 +36,7 @@ export const convertJsonToMarkdown = async ({
     folderPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
 
   /**
@@ -95,6 +97,7 @@ export const convertJsonToMarkdown = async ({
     folderPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   spinnerSuccess(`Created ${files} mardown files...`);
 };

src/cli/commands/index/index.ts

@@ -17,6 +17,7 @@ export const index = async ({
   chatPrompt,
   contentType,
   targetAudience,
+  linkHosted,
 }: AutodocRepoConfig) => {
   const json = path.join(output, 'docs', 'json/');
   const markdown = path.join(output, 'docs', 'markdown/');
@@ -40,6 +41,7 @@ export const index = async ({
     chatPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   updateSpinnerText('Processing repository...');
   spinnerSuccess();
@@ -60,6 +62,7 @@ export const index = async ({
     chatPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   spinnerSuccess();
 
@@ -76,6 +79,7 @@ export const index = async ({
     chatPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   spinnerSuccess();
 };

src/cli/commands/index/processRepository.ts

@@ -42,6 +42,7 @@ export const processRepository = async (
     folderPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   }: AutodocRepoConfig,
   dryRun?: boolean,
 ) => {
@@ -65,10 +66,11 @@ export const processRepository = async (
     contentType,
     filePrompt,
     targetAudience,
+    linkHosted,
   }): Promise<void> => {
     const content = await fs.readFile(filePath, 'utf-8');
     const markdownFilePath = path.join(outputRoot, filePath);
-    const url = githubFileUrl(repositoryUrl, inputRoot, filePath);
+    const url = githubFileUrl(repositoryUrl, inputRoot, filePath, linkHosted);
     const summaryPrompt = createCodeFileSummary(
       projectName,
       projectName,
@@ -181,6 +183,7 @@ export const processRepository = async (
     contentType,
     folderPrompt,
     shouldIgnore,
+    linkHosted,
   }): Promise<void> => {
     /**
      * For now we don't care about folders
@@ -192,7 +195,8 @@ export const processRepository = async (
     const contents = (await fs.readdir(folderPath)).filter(
       (fileName) => !shouldIgnore(fileName),
     );
-    const url = githubFolderUrl(repositoryUrl, inputRoot, folderPath);
+    // eslint-disable-next-line prettier/prettier
+    const url = githubFolderUrl(repositoryUrl, inputRoot, folderPath, linkHosted);
     const allFiles: (FileSummary | null)[] = await Promise.all(
       contents.map(async (fileName) => {
         const entryPath = path.join(folderPath, fileName);
@@ -295,6 +299,7 @@ export const processRepository = async (
         folderPrompt,
         contentType,
         targetAudience,
+        linkHosted,
       }),
       traverseFileSystem({
         inputPath: inputRoot,
@@ -308,6 +313,7 @@ export const processRepository = async (
         folderPrompt,
         contentType,
         targetAudience,
+        linkHosted,
       }),
     ]);
 
@@ -333,6 +339,7 @@ export const processRepository = async (
     folderPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   spinnerSuccess(`Processing ${files} files...`);
 
@@ -349,6 +356,7 @@ export const processRepository = async (
     folderPrompt,
     contentType,
     targetAudience,
+    linkHosted,
   });
   spinnerSuccess(`Processing ${folders} folders... `);
   stopSpinner();

src/cli/commands/init/index.ts

@@ -47,6 +47,7 @@ export const makeConfigTemplate = (
     chatPrompt: '',
     contentType: 'code',
     targetAudience: 'smart developer',
+    linkHosted: false,
   };
 };
 

src/cli/commands/query/createChatChain.ts

@@ -12,6 +12,7 @@ Chat History:
 Follow Up Input: {question}
 Standalone question:`);
 
+// eslint-disable-next-line prettier/prettier
 const makeQAPrompt = (projectName: string, repositoryUrl: string, contentType: string, chatPrompt: string, targetAudience: string) =>
   PromptTemplate.fromTemplate(
     `You are an AI assistant for a software project called ${projectName}. You are trained on all the ${contentType} that makes up this project.
@@ -58,6 +59,7 @@ export const makeChain = (
     prompt: CONDENSE_PROMPT,
   });
 
+  // eslint-disable-next-line prettier/prettier
   const QA_PROMPT = makeQAPrompt(projectName, repositoryUrl, contentType, chatPrompt, targetAudience);
   const docChain = loadQAChain(
     new OpenAIChat({

src/cli/utils/FileUtil.ts

@@ -16,18 +16,28 @@ export const githubFileUrl = (
   githubRoot: string,
   inputRoot: string,
   filePath: string,
+  linkHosted: boolean,
 ): string => {
-  return `${githubRoot}/blob/master/${filePath.substring(
-    inputRoot.length - 1,
-  )}`;
+  if (linkHosted) {
+    return `${githubRoot}/${filePath.substring(inputRoot.length - 1)}`;
+  } else {
+    return `${githubRoot}/blob/master/${filePath.substring(
+      inputRoot.length - 1,
+    )}`;
+  }
 };
 
 export const githubFolderUrl = (
   githubRoot: string,
   inputRoot: string,
   folderPath: string,
+  linkHosted: boolean,
 ): string => {
-  return `${githubRoot}/tree/master/${folderPath.substring(
-    inputRoot.length - 1,
-  )}`;
+  if (linkHosted) {
+    return `${githubRoot}/${folderPath.substring(inputRoot.length - 1)}`;
+  } else {
+    return `${githubRoot}/tree/master/${folderPath.substring(
+      inputRoot.length - 1,
+    )}`;
+  }
 };

src/cli/utils/traverseFileSystem.ts

@@ -9,7 +9,7 @@ export const traverseFileSystem = async (
 ): Promise<void> => {
   try {
     // eslint-disable-next-line prettier/prettier
-    const { inputPath, projectName, processFile, processFolder, ignore, filePrompt, folderPrompt, contentType, targetAudience } = params;
+    const { inputPath, projectName, processFile, processFolder, ignore, filePrompt, folderPrompt, contentType, targetAudience, linkHosted } = params;
 
     try {
       await fs.access(inputPath);
@@ -43,6 +43,7 @@ export const traverseFileSystem = async (
               folderPrompt,
               contentType,
               targetAudience,
+              linkHosted,
             });
           }
         }),
@@ -61,6 +62,7 @@ export const traverseFileSystem = async (
               filePrompt,
               contentType,
               targetAudience,
+              linkHosted,
             });
           }
         }),

src/types.ts

@@ -16,6 +16,7 @@ export type AutodocRepoConfig = {
   chatPrompt: string;
   contentType: string;
   targetAudience: string;
+  linkHosted: boolean;
 };
 
 export type FileSummary = {
@@ -33,6 +34,7 @@ export type ProcessFileParams = {
   contentType: string;
   filePrompt: string;
   targetAudience: string;
+  linkHosted: boolean;
 };
 
 export type ProcessFile = (params: ProcessFileParams) => Promise<void>;
@@ -54,6 +56,7 @@ export type ProcessFolderParams = {
   contentType: string;
   folderPrompt: string;
   targetAudience: string;
+  linkHosted: boolean;
   shouldIgnore: (fileName: string) => boolean;
 };
 
@@ -69,6 +72,7 @@ export type TraverseFileSystemParams = {
   folderPrompt: string;
   contentType: string;
   targetAudience: string;
+  linkHosted: boolean;
 };
 
 export enum LLMModels {