Skip to content

Ensure global documentation file is cleared before writing new content #54

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
merged 1 commit into from
Nov 4, 2025
Merged

Ensure global documentation file is cleared before writing new content #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 5 additions & 18 deletions src/ccs/commands/globalDocumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,26 +77,13 @@ async function tryWriteGlobalDocumentationFile(
// Ensure directory exists
await vscode.workspace.fs.createDirectory(vscode.Uri.file(path.dirname(targetUri.fsPath)));

// Read existing content (if any)
let existingContent = "";
try {
const buffer = await vscode.workspace.fs.readFile(targetUri);
existingContent = Buffer.from(buffer).toString("utf8");
} catch (readError: unknown) {
// If the file doesn't exist, proceed without error
if (!(readError instanceof vscode.FileSystemError) || readError.code !== "FileNotFound") {
throw readError;
}
}

// Normalize line breaks for the current OS
// Normalize line breaks for the current OS and build content.
// Overwrite file content instead of appending.
const normalizedContent = content.split(/\r?\n/).join(EOL);
const newSection = `${GLOBAL_DOC_HEADER}${EOL}${normalizedContent}${EOL}`;
const needsSeparator = existingContent.length > 0 && !existingContent.endsWith(EOL.repeat(2));
const separator = needsSeparator ? EOL.repeat(2) : "";
const combinedContent = existingContent ? `${existingContent}${separator}${newSection}` : newSection;
const newContent = `${GLOBAL_DOC_HEADER}${EOL}${normalizedContent}${EOL}`;

await vscode.workspace.fs.writeFile(targetUri, Buffer.from(combinedContent, "utf8"));
// This write overwrites any previous content
await vscode.workspace.fs.writeFile(targetUri, Buffer.from(newContent, "utf8"));

// Open the file beside for editing
const document = await vscode.workspace.openTextDocument(targetUri);
Expand Down