validate-sketch.ts

import{Dialog}from'@theia/core/lib/browser/dialogs';
import{nls}from'@theia/core/lib/common/nls';
import{Deferred,waitForEvent}from'@theia/core/lib/common/promise-util';
import{injectable}from'@theia/core/shared/inversify';
import{WorkspaceCommands}from'@theia/workspace/lib/browser/workspace-commands';
import{CurrentSketch}from'../sketches-service-client-impl';
import{CloudSketchContribution}from'./cloud-contribution';
import{Sketch,URI}from'./contribution';
import{SaveAsSketch}from'./save-as-sketch';

@injectable()
exportclassValidateSketchextendsCloudSketchContribution{
overrideonReady(): void{
this.validate();
}

privateasyncvalidate(): Promise<void>{
constresult=awaitthis.promptFixActions();
if(!result){
constyes=awaitthis.prompt(
nls.localize('arduino/validateSketch/abortFixTitle','Invalid sketch'),
nls.localize(
'arduino/validateSketch/abortFixMessage',
"The sketch is still invalid. Do you want to fix the remaining problems? By clicking '{0}', a new sketch will open.",
Dialog.NO
),
[Dialog.NO,Dialog.YES]
);
if(yes){
returnthis.validate();
}
constsketch=awaitthis.sketchesService.createNewSketch();
this.workspaceService.open(newURI(sketch.uri),{
preserveWindow: true,
});
}
}

/**
 * Returns with an array of actions the user has to perform to fix the invalid sketch.
 */
privatevalidateSketch(
sketch: Sketch,
dataDirUri: URI|undefined
): FixAction[]{
// sketch code file validation errors first as they do not require window reload
constactions=Sketch.uris(sketch)
.filter((uri)=>uri!==sketch.mainFileUri)
.map((uri)=>newURI(uri))
.filter((uri)=>Sketch.Extensions.CODE_FILES.includes(uri.path.ext))
.map((uri)=>({
 uri,
error: this.doValidate(sketch,dataDirUri,uri.path.name),
}))
.filter(({ error })=>Boolean(error))
.map((object)=><{uri: URI;error: string}>object)
.map(({ uri, error })=>({
execute: async()=>{
constunknown=
(awaitthis.promptRenameSketchFile(uri,error))&&
(awaitthis.commandService.executeCommand(
WorkspaceCommands.FILE_RENAME.id,
uri
));
return!!unknown;
},
}));

// sketch folder + main sketch file last as it requires a `Save as...` and the window reload
constsketchFolderName=newURI(sketch.uri).path.base;
constsketchFolderNameError=this.doValidate(
sketch,
dataDirUri,
sketchFolderName
);
if(sketchFolderNameError){
actions.push({
execute: async()=>{
constunknown=
(awaitthis.promptRenameSketch(sketch,sketchFolderNameError))&&
(awaitthis.commandService.executeCommand(
SaveAsSketch.Commands.SAVE_AS_SKETCH.id,
<SaveAsSketch.Options>{
markAsRecentlyOpened: true,
openAfterMove: true,
wipeOriginal: true,
}
));
return!!unknown;
},
});
}
returnactions;
}

privatedoValidate(
sketch: Sketch,
dataDirUri: URI|undefined,
toValidate: string
): string|undefined{
constcloudUri=this.createFeatures.isCloud(sketch,dataDirUri);
returncloudUri
 ? Sketch.validateCloudSketchFolderName(toValidate)
 : Sketch.validateSketchFolderName(toValidate);
}

privateasynccurrentSketch(): Promise<Sketch>{
constsketch=this.sketchServiceClient.tryGetCurrentSketch();
if(CurrentSketch.isValid(sketch)){
returnsketch;
}
constdeferred=newDeferred<Sketch>();
constdisposable=this.sketchServiceClient.onCurrentSketchDidChange(
(sketch)=>{
if(CurrentSketch.isValid(sketch)){
disposable.dispose();
deferred.resolve(sketch);
}
}
);
returndeferred.promise;
}

privateasyncpromptFixActions(): Promise<boolean>{
constmaybeDataDirUri=this.configService.tryGetDataDirUri();
const[sketch,dataDirUri]=awaitPromise.all([
this.currentSketch(),
maybeDataDirUri??
waitForEvent(this.configService.onDidChangeDataDirUri,5_000),
]);
constfixActions=this.validateSketch(sketch,dataDirUri);
for(constfixActionoffixActions){
constresult=awaitfixAction.execute();
if(!result){
returnfalse;
}
}
returntrue;
}

privateasyncpromptRenameSketch(
sketch: Sketch,
error: string
): Promise<boolean>{
returnthis.prompt(
nls.localize(
'arduino/validateSketch/renameSketchFolderTitle',
'Invalid sketch name'
),
nls.localize(
'arduino/validateSketch/renameSketchFolderMessage',
"The sketch '{0}' cannot be used. {1} To get rid of this message, rename the sketch. Do you want to rename the sketch now?",
sketch.name,
error
)
);
}

privateasyncpromptRenameSketchFile(
uri: URI,
error: string
): Promise<boolean>{
returnthis.prompt(
nls.localize(
'arduino/validateSketch/renameSketchFileTitle',
'Invalid sketch filename'
),
nls.localize(
'arduino/validateSketch/renameSketchFileMessage',
"The sketch file '{0}' cannot be used. {1} Do you want to rename the sketch file now?",
uri.path.base,
error
)
);
}

privateasyncprompt(
title: string,
message: string,
buttons: string[]=[Dialog.CANCEL,Dialog.OK]
): Promise<boolean>{
const{ response }=awaitthis.dialogService.showMessageBox({
 title,
 message,
type: 'warning',
 buttons,
});
// cancel
if(response===0){
returnfalse;
}
returntrue;
}
}

interfaceFixAction{
execute(): Promise<boolean>;
}