Mar 27, 2023 · Mar 26, 2023 · Mar 26, 2023 · Mar 26, 2023 · Mar 26, 2023 · Mar 26, 2023
diff --git a/autodoc.config.json b/autodoc.config.json
diff --git a/src/cli/commands/estimate/index.ts b/src/cli/commands/estimate/index.ts
diff --git a/src/cli/commands/index/convertJsonToMarkdown.ts b/src/cli/commands/index/convertJsonToMarkdown.ts
diff --git a/src/cli/commands/index/index.ts b/src/cli/commands/index/index.ts
diff --git a/src/cli/commands/index/processRepository.ts b/src/cli/commands/index/processRepository.ts
diff --git a/src/cli/commands/init/index.ts b/src/cli/commands/init/index.ts
diff --git a/src/cli/commands/query/createChatChain.ts b/src/cli/commands/query/createChatChain.ts
diff --git a/src/cli/utils/FileUtil.ts b/src/cli/utils/FileUtil.ts
diff --git a/src/cli/utils/traverseFileSystem.ts b/src/cli/utils/traverseFileSystem.ts
diff --git a/src/types.ts b/src/types.ts
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,7 +19,8 @@ export const estimate = async ({
		folderPrompt,
		chatPrompt,
		contentType,
	targetAudience
	targetAudience,
	linkHosted,
		}: AutodocRepoConfig) => {
		const json = path.join(output, 'docs', 'json/');

Expand All		@@ -41,7 +42,8 @@ export const estimate = async ({
		folderPrompt,
		chatPrompt,
		contentType,
	targetAudience
	targetAudience,
	linkHosted,
		},
		true,
		);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
Expand All		@@ -35,6 +36,7 @@ export const convertJsonToMarkdown = async ({
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});

		/**
Expand Down Expand Up		@@ -95,6 +97,7 @@ export const convertJsonToMarkdown = async ({
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		spinnerSuccess(`Created ${files} mardown files...`);
		};
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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/');
Expand All		@@ -40,6 +41,7 @@ export const index = async ({
		chatPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		updateSpinnerText('Processing repository...');
		spinnerSuccess();
Expand All		@@ -60,6 +62,7 @@ export const index = async ({
		chatPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		spinnerSuccess();

Expand All		@@ -76,6 +79,7 @@ export const index = async ({
		chatPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		spinnerSuccess();
		};
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,6 +42,7 @@ export const processRepository = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		}: AutodocRepoConfig,
		dryRun?: boolean,
		) => {
Expand All		@@ -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,
Expand Down Expand Up		@@ -181,6 +183,7 @@ export const processRepository = async (
		contentType,
		folderPrompt,
		shouldIgnore,
	linkHosted,
		}): Promise<void> => {
		/**
		* For now we don't care about folders
Expand All		@@ -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);
Expand Down Expand Up		@@ -295,6 +299,7 @@ export const processRepository = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		}),
		traverseFileSystem({
		inputPath: inputRoot,
Expand All		@@ -308,6 +313,7 @@ export const processRepository = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		}),
		]);

Expand All		@@ -333,6 +339,7 @@ export const processRepository = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		spinnerSuccess(`Processing ${files} files...`);

Expand All		@@ -349,6 +356,7 @@ export const processRepository = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		spinnerSuccess(`Processing ${folders} folders... `);
		stopSpinner();
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,6 +47,7 @@ export const makeConfigTemplate = (
		chatPrompt: '',
		contentType: 'code',
		targetAudience: 'smart developer',
	linkHosted: false,
		};
		};

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.
Expand Down Expand Up		@@ -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({
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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,
	)}`;
	}
		};
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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);
Expand Down Expand Up		@@ -43,6 +43,7 @@ export const traverseFileSystem = async (
		folderPrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		}
		}),
Expand All		@@ -61,6 +62,7 @@ export const traverseFileSystem = async (
		filePrompt,
		contentType,
		targetAudience,
	linkHosted,
		});
		}
		}),
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,6 +16,7 @@ export type AutodocRepoConfig = {
		chatPrompt: string;
		contentType: string;
		targetAudience: string;
	linkHosted: boolean;
		};

		export type FileSummary = {
Expand All		@@ -33,6 +34,7 @@ export type ProcessFileParams = {
		contentType: string;
		filePrompt: string;
		targetAudience: string;
	linkHosted: boolean;
		};

		export type ProcessFile = (params: ProcessFileParams) => Promise<void>;
Expand All		@@ -54,6 +56,7 @@ export type ProcessFolderParams = {
		contentType: string;
		folderPrompt: string;
		targetAudience: string;
	linkHosted: boolean;
		shouldIgnore: (fileName: string) => boolean;
		};

Expand All		@@ -69,6 +72,7 @@ export type TraverseFileSystemParams = {
		folderPrompt: string;
		contentType: string;
		targetAudience: string;
	linkHosted: boolean;
		};

		export enum LLMModels {
Expand Down