Skip to content

Refactor Styles & OutputGenerate functions to streamline generation process #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yamadashy merged 2 commits into from
Oct 16, 2024
Merged

Refactor Styles & OutputGenerate functions to streamline generation process #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17bcfe7
update OutputStyles & OutputGenerate logic
iNerdStack Oct 15, 2024
12dce72
chore(lint): Fix code style with lint
yamadashy Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 37 additions & 8 deletions src/core/output/outputGenerate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
import fs from 'node:fs/promises';
import path from 'node:path';
import Handlebars from 'handlebars';
import type { RepopackConfigMerged } from '../../config/configTypes.js';
import { RepopackError } from '../../shared/errorHandle.js';
import { generateTreeString } from '../file/fileTreeGenerate.js';
import type { ProcessedFile } from '../file/fileTypes.js';
import type { OutputGeneratorContext } from './outputGeneratorTypes.js';
import { generateMarkdownStyle } from './outputStyles/markdownStyle.js';
import { generatePlainStyle } from './outputStyles/plainStyle.js';
import { generateXmlStyle } from './outputStyles/xmlStyle.js';
import {
generateHeader,
generateSummaryAdditionalInfo,
generateSummaryFileFormat,
generateSummaryNotes,
generateSummaryPurpose,
generateSummaryUsageGuidelines,
} from './outputStyleDecorate.js';
import { getMarkdownTemplate } from './outputStyles/markdownStyle.js';
import { getPlainTemplate } from './outputStyles/plainStyle.js';
import { getXmlTemplate } from './outputStyles/xmlStyle.js';

const createRenderContext = (outputGeneratorContext: OutputGeneratorContext) => {
return {
generationHeader: generateHeader(outputGeneratorContext.generationDate),
summaryPurpose: generateSummaryPurpose(),
summaryFileFormat: generateSummaryFileFormat(),
summaryUsageGuidelines: generateSummaryUsageGuidelines(
outputGeneratorContext.config,
outputGeneratorContext.instruction,
),
summaryNotes: generateSummaryNotes(outputGeneratorContext.config),
summaryAdditionalInfo: generateSummaryAdditionalInfo(),
headerText: outputGeneratorContext.config.output.headerText,
instruction: outputGeneratorContext.instruction,
treeString: outputGeneratorContext.treeString,
processedFiles: outputGeneratorContext.processedFiles,
};
};

export const generateOutput = async (
rootDir: string,
Expand All @@ -16,20 +43,22 @@ export const generateOutput = async (
allFilePaths: string[],
): Promise<string> => {
const outputGeneratorContext = await buildOutputGeneratorContext(rootDir, config, allFilePaths, processedFiles);
const renderContext = createRenderContext(outputGeneratorContext);

let output: string;
let template: string;
switch (config.output.style) {
case 'xml':
output = generateXmlStyle(outputGeneratorContext);
template = getXmlTemplate();
break;
case 'markdown':
output = generateMarkdownStyle(outputGeneratorContext);
template = getMarkdownTemplate();
break;
default:
output = generatePlainStyle(outputGeneratorContext);
template = getPlainTemplate();
}
Comment on lines 49 to 58
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Handle unexpected output styles explicitly.

In the switch statement for config.output.style, unrecognized styles default to the plain template. Consider throwing an error or warning when an unsupported style is specified to alert users of potential misconfigurations.


return output;
const compiledTemplate = Handlebars.compile(template);
return `${compiledTemplate(renderContext).trim()}\n`;
};

export const buildOutputGeneratorContext = async (
Expand Down
35 changes: 3 additions & 32 deletions src/core/output/outputStyles/markdownStyle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,7 @@
import Handlebars from 'handlebars';
import type { OutputGeneratorContext } from '../outputGeneratorTypes.js';
import {
generateHeader,
generateSummaryAdditionalInfo,
generateSummaryFileFormat,
generateSummaryNotes,
generateSummaryPurpose,
generateSummaryUsageGuidelines,
} from '../outputStyleDecorate.js';

export const generateMarkdownStyle = (outputGeneratorContext: OutputGeneratorContext) => {
const template = Handlebars.compile(markdownTemplate);

const renderContext = {
generationHeader: generateHeader(outputGeneratorContext.generationDate),
summaryPurpose: generateSummaryPurpose(),
summaryFileFormat: generateSummaryFileFormat(),
summaryUsageGuidelines: generateSummaryUsageGuidelines(
outputGeneratorContext.config,
outputGeneratorContext.instruction,
),
summaryNotes: generateSummaryNotes(outputGeneratorContext.config),
summaryAdditionalInfo: generateSummaryAdditionalInfo(),
headerText: outputGeneratorContext.config.output.headerText,
instruction: outputGeneratorContext.instruction,
treeString: outputGeneratorContext.treeString,
processedFiles: outputGeneratorContext.processedFiles,
};

return `${template(renderContext).trim()}\n`;
};

const markdownTemplate = /* md */ `
export const getMarkdownTemplate = () => {
return /* md */ `
{{{generationHeader}}}

# File Summary
Expand Down Expand Up @@ -79,6 +49,7 @@ const markdownTemplate = /* md */ `
{{{instruction}}}
{{/if}}
`;
};

Handlebars.registerHelper('getFileExtension', (filePath) => {
const extension = filePath.split('.').pop()?.toLowerCase();
Expand Down
37 changes: 3 additions & 34 deletions src/core/output/outputStyles/plainStyle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,8 @@
import Handlebars from 'handlebars';
import type { OutputGeneratorContext } from '../outputGeneratorTypes.js';
import {
generateHeader,
generateSummaryAdditionalInfo,
generateSummaryFileFormat,
generateSummaryNotes,
generateSummaryPurpose,
generateSummaryUsageGuidelines,
} from '../outputStyleDecorate.js';

export const generatePlainStyle = (outputGeneratorContext: OutputGeneratorContext) => {
const template = Handlebars.compile(plainTemplate);

const renderContext = {
generationHeader: generateHeader(outputGeneratorContext.generationDate),
summaryPurpose: generateSummaryPurpose(),
summaryFileFormat: generateSummaryFileFormat(),
summaryUsageGuidelines: generateSummaryUsageGuidelines(
outputGeneratorContext.config,
outputGeneratorContext.instruction,
),
summaryNotes: generateSummaryNotes(outputGeneratorContext.config),
summaryAdditionalInfo: generateSummaryAdditionalInfo(),
headerText: outputGeneratorContext.config.output.headerText,
instruction: outputGeneratorContext.instruction,
treeString: outputGeneratorContext.treeString,
processedFiles: outputGeneratorContext.processedFiles,
};

return `${template(renderContext).trim()}\n`;
};

const PLAIN_SEPARATOR = '='.repeat(16);
const PLAIN_LONG_SEPARATOR = '='.repeat(64);

const plainTemplate = `
export const getPlainTemplate = () => {
return `
{{{generationHeader}}}

${PLAIN_LONG_SEPARATOR}
Expand Down Expand Up @@ -98,3 +66,4 @@ ${PLAIN_LONG_SEPARATOR}
{{/if}}

`;
};
37 changes: 3 additions & 34 deletions src/core/output/outputStyles/xmlStyle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
import Handlebars from 'handlebars';
import type { OutputGeneratorContext } from '../outputGeneratorTypes.js';
import {
generateHeader,
generateSummaryAdditionalInfo,
generateSummaryFileFormat,
generateSummaryNotes,
generateSummaryPurpose,
generateSummaryUsageGuidelines,
} from '../outputStyleDecorate.js';

export const generateXmlStyle = (outputGeneratorContext: OutputGeneratorContext) => {
const template = Handlebars.compile(xmlTemplate);

const renderContext = {
generationHeader: generateHeader(outputGeneratorContext.generationDate),
summaryPurpose: generateSummaryPurpose(),
summaryFileFormat: generateSummaryFileFormat(),
summaryUsageGuidelines: generateSummaryUsageGuidelines(
outputGeneratorContext.config,
outputGeneratorContext.instruction,
),
summaryNotes: generateSummaryNotes(outputGeneratorContext.config),
summaryAdditionalInfo: generateSummaryAdditionalInfo(),
headerText: outputGeneratorContext.config.output.headerText,
instruction: outputGeneratorContext.instruction,
treeString: outputGeneratorContext.treeString,
processedFiles: outputGeneratorContext.processedFiles,
};

return `${template(renderContext).trim()}\n`;
};

const xmlTemplate = /* xml */ `
export const getXmlTemplate = () => {
return /* xml */ `
{{{generationHeader}}}

<file_summary>
Expand Down Expand Up @@ -89,3 +57,4 @@ This section contains the contents of the repository's files.
</instruction>
{{/if}}
`;
};
8 changes: 3 additions & 5 deletions tests/core/output/outputStyles/markdownStyle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import process from 'node:process';
import { beforeEach, describe, expect, test, vi } from 'vitest';
import { buildOutputGeneratorContext } from '../../../../src/core/output/outputGenerate.js';
import { generateMarkdownStyle } from '../../../../src/core/output/outputStyles/markdownStyle.js';
import { generateOutput } from '../../../../src/core/output/outputGenerate.js';
import { createMockConfig } from '../../../testing/testUtils.js';

vi.mock('fs/promises');
Expand All @@ -11,7 +10,7 @@ describe('markdownStyle', () => {
vi.resetAllMocks();
});

test('generateMarkdownOutput should include user-provided header text', async () => {
test('generateOutput for md should include user-provided header text', async () => {
const mockConfig = createMockConfig({
output: {
filePath: 'output.md',
Expand All @@ -24,8 +23,7 @@ describe('markdownStyle', () => {
},
});

const context = await buildOutputGeneratorContext(process.cwd(), mockConfig, [], []);
const output = await generateMarkdownStyle(context);
const output = await generateOutput(process.cwd(), mockConfig, [], []);

expect(output).toContain('# File Summary');
expect(output).toContain('# Repository Structure');
Expand Down
8 changes: 3 additions & 5 deletions tests/core/output/outputStyles/plainStyle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import process from 'node:process';
import { beforeEach, describe, expect, test, vi } from 'vitest';
import { buildOutputGeneratorContext } from '../../../../src/core/output/outputGenerate.js';
import { generatePlainStyle } from '../../../../src/core/output/outputStyles/plainStyle.js';
import { generateOutput } from '../../../../src/core/output/outputGenerate.js';
import { createMockConfig } from '../../../testing/testUtils.js';

vi.mock('fs/promises');
Expand All @@ -11,7 +10,7 @@ describe('plainStyle', () => {
vi.resetAllMocks();
});

test('generatePlainOutput should include user-provided header text', async () => {
test('generateOutput for plain should include user-provided header text', async () => {
const mockConfig = createMockConfig({
output: {
filePath: 'output.txt',
Expand All @@ -24,8 +23,7 @@ describe('plainStyle', () => {
},
});

const context = await buildOutputGeneratorContext(process.cwd(), mockConfig, [], []);
const output = await generatePlainStyle(context);
const output = await generateOutput(process.cwd(), mockConfig, [], []);

expect(output).toContain('File Summary');
expect(output).toContain('Repository Structure');
Expand Down
8 changes: 3 additions & 5 deletions tests/core/output/outputStyles/xmlStyle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import process from 'node:process';
import { beforeEach, describe, expect, test, vi } from 'vitest';
import { buildOutputGeneratorContext } from '../../../../src/core/output/outputGenerate.js';
import { generateXmlStyle } from '../../../../src/core/output/outputStyles/xmlStyle.js';
import { generateOutput } from '../../../../src/core/output/outputGenerate.js';
import { createMockConfig } from '../../../testing/testUtils.js';

vi.mock('fs/promises');
Expand All @@ -11,7 +10,7 @@ describe('xmlStyle', () => {
vi.resetAllMocks();
});

test('generateXmlOutput should include user-provided header text', async () => {
test('generateOutput for xml should include user-provided header text', async () => {
const mockConfig = createMockConfig({
output: {
filePath: 'output.txt',
Expand All @@ -24,8 +23,7 @@ describe('xmlStyle', () => {
},
});

const context = await buildOutputGeneratorContext(process.cwd(), mockConfig, [], []);
const output = await generateXmlStyle(context);
const output = await generateOutput(process.cwd(), mockConfig, [], []);

expect(output).toContain('file_summary');
expect(output).toContain('repository_structure');
Expand Down