Skip to content

Perform a dry run of the preprocessor when initializing a sync #31

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

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
+79 −60
Open

Perform a dry run of the preprocessor when initializing a sync #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c94864
Prerun the preprocessor to build the include file tree so any edited …
WolfGangS Dec 2, 2025
557bc12
lint
WolfGangS Dec 2, 2025
19ab6ae
Merge branch 'develop' into wolfgang/prerun-preproc
WolfGangS Dec 3, 2025
f48338b
Do not save to same file as source
WolfGangS Dec 3, 2025
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
136 changes: 77 additions & 59 deletions src/scriptsync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,17 @@ export class ScriptSync implements vscode.Disposable {
}
}

public async initialize() : Promise<void> {
const masterFilePath: string = this.getMasterFilePath();

const originalContent = await fs.promises.readFile(
masterFilePath,
"utf8",
);

await this.preProcessContent(originalContent);
}

//====================================================================
//#region utilities
public showMasterDocument(): void {
Expand Down Expand Up @@ -363,84 +374,91 @@ export class ScriptSync implements vscode.Disposable {
}
//#endregion

public async handleMasterSaved(): Promise<void> {
public async preProcessContent(originalContent: string): Promise<string> {
// Check if preprocessing is enabled
if(!this.preprocessor) return originalContent;
if(!this.config.getConfig<boolean>(ConfigKey.PreprocessorEnable)) return originalContent;

this.clearDiagnostics();

const masterFilePath: string = this.getMasterFilePath();
const baseName: string = path.basename(masterFilePath);
let preprocessorResult: PreprocessorResult | null = null;
let finalContent = originalContent;
try {
// Read the original content
const masterFilePath: string = this.getMasterFilePath();
const baseName: string = path.basename(masterFilePath);
console.log(`Preprocessing enabled for: ${baseName}`);

const originalContent = await fs.promises.readFile(
masterFilePath,
"utf8",
this.macros.clearNonSystemMacros();
preprocessorResult = await this.preprocessor.process(
originalContent,
normalizePath(masterFilePath),
this.language
);
let finalContent = originalContent;
let preprocessorResult: PreprocessorResult | null = null;

this.clearDiagnostics();
// Check if preprocessing is enabled
if (this.preprocessor && this.config.getConfig<boolean>(ConfigKey.PreprocessorEnable)) {
try {
console.log(`Preprocessing enabled for: ${baseName}`);

this.macros.clearNonSystemMacros();
preprocessorResult = await this.preprocessor.process(
originalContent,
normalizePath(masterFilePath),
this.language
);


if (preprocessorResult.issues && preprocessorResult.issues.length > 0) {
const diagnostics = ScriptSync.preprocessorErrorsToDiagnostics(
preprocessorResult.issues,
`${preprocessorResult.language} Preprocessor`
);
this.addDiagnostics(diagnostics);
}

if(preprocessorResult.includes && preprocessorResult.includes.length > 0) {
this.includedFiles = preprocessorResult.includes;
}
if (preprocessorResult.issues && preprocessorResult.issues.length > 0) {
const diagnostics = ScriptSync.preprocessorErrorsToDiagnostics(
preprocessorResult.issues,
`${preprocessorResult.language} Preprocessor`
);
this.addDiagnostics(diagnostics);
}

if (preprocessorResult.success) {
finalContent = preprocessorResult.content;
this.lineMappings = preprocessorResult.lineMappings;
if (preprocessorResult.includes && preprocessorResult.includes.length > 0) {
this.includedFiles = preprocessorResult.includes;
}

console.log(
`${preprocessorResult.language.toUpperCase()} preprocessing completed successfully for: ${baseName}`,
);
} else {
// Preprocessing failed, use original content and show error
finalContent = originalContent;
if (preprocessorResult.success) {
finalContent = preprocessorResult.content;
this.lineMappings = preprocessorResult.lineMappings;

vscode.window.showErrorMessage("Preprocessing failed");
}
} catch (error) {
// Fallback to original content on any unexpected errors
finalContent = originalContent;
const errorMessage = `Preprocessing error for ${baseName}: ${
error instanceof Error ? error.message : String(error)
}`;
console.error(errorMessage);
vscode.window.showErrorMessage(errorMessage);
}
} else {
console.log(
`Preprocessing disabled, using original content for: ${baseName}`,
`${preprocessorResult.language.toUpperCase()} preprocessing completed successfully for: ${baseName}`,
);
} else {
// Preprocessing failed, use original content and show error
finalContent = originalContent;

vscode.window.showErrorMessage("Preprocessing failed");
}
} catch (error) {
// Fallback to original content on any unexpected errors
finalContent = originalContent;
const errorMessage = `Preprocessing error for ${baseName}: ${error instanceof Error ? error.message : String(error)}`;
console.error(errorMessage);
vscode.window.showErrorMessage(errorMessage);
}
return finalContent;
}

public async handleMasterSaved(): Promise<void> {
try {
// Read the original content
const masterFilePath: string = this.getMasterFilePath();

const originalContent = await fs.promises.readFile(
masterFilePath,
"utf8",
);
let finalContent = await this.preProcessContent(originalContent);

const sha = sha256.create();
sha.update(finalContent);
const hash = sha.hex();

console.error(finalContent, hash);
// console.error(finalContent, hash);
finalContent = this.prefixWithMetaInformation(finalContent, hash);

// Walk through all TrackedDocuments and save their finalContents if the hash has changed
await Promise.all(
this.getFileMappingsFilteredByHash(hash)
.map((mapping) => {
if(masterFilePath == mapping.viewerDocument.fileName) {
// Do not write to the same file we are processing from
// Allows quick editing of a script externally that hasnt matched
// Without the script extending forever if the preproc is enabled
return Promise.resolve();
}
mapping.hash = hash;
return fs.promises.writeFile(
mapping.viewerDocument.fileName,
Expand All @@ -457,14 +475,14 @@ export class ScriptSync implements vscode.Disposable {
}

private prefixWithMetaInformation(content:string, hash: string) : string {
console.error("PREFIX ENABLED", this.config.getConfig<boolean>(ConfigKey.FileMetaInfoInOutput,false));
// console.error("PREFIX ENABLED", this.config.getConfig<boolean>(ConfigKey.FileMetaInfoInOutput,false));
if(!this.config.getConfig<boolean>(ConfigKey.FileMetaInfoInOutput,false)) {
return content;
}
const meta : string[]= [];
const date = (new Date()).toISOString().split("T");

console.error("PREFIX")
// console.error("PREFIX")

const path = vscode.workspace.asRelativePath(this.masterDocument.uri.fsPath);

Expand All @@ -473,7 +491,7 @@ export class ScriptSync implements vscode.Disposable {
meta.push(`${comment} @file ${path}`);
meta.push(`${comment} @hash ${hash}`);
meta.push(`${comment} @date ${date[0]} ${date[1].split(".")[0]}`);
console.error("PREFIX CREATOR", this.config.getConfig<boolean>(ConfigKey.FileMetaInfoIncludeCreator,false));
// console.error("PREFIX CREATOR", this.config.getConfig<boolean>(ConfigKey.FileMetaInfoIncludeCreator,false));
if(this.config.getConfig<boolean>(ConfigKey.FileMetaInfoIncludeCreator, false)) {
meta.push(`${comment} @creator ${ScriptSync.getCurrentAgentName()}`);
meta.push(`${comment} @creatorID ${ScriptSync.getCurrentAgentId()}`);
Expand Down
2 changes: 1 addition & 1 deletion src/shared/includeprocessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export class IncludeProcessor {
includePaths,
aliased || allowExternal,
);
console.error("Resolve: ", [filename, sourceFile, extensions, includePaths, aliased, allowExternal], resolvedPath);
// console.error("Resolve: ", [filename, sourceFile, extensions, includePaths, aliased, allowExternal], resolvedPath);

if(!resolvedPath && this.language == "luau") {
// Luau require supports default file in folder include mechanic 'init.luau'
Expand Down
1 change: 1 addition & 0 deletions src/synchservice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ export class SynchService implements vscode.Disposable {
parsed.scriptId,
viewerDocument,
);
await sync.initialize();
this.activeSyncs.set(masterPath, sync);
}

Expand Down