arduino-ide/arduino-ide-extension/src/common/protocol/sketches-service.ts

export const SketchesServicePath = '/services/sketches-service';
export const SketchesService = Symbol('SketchesService');
export interface SketchesService {
    /**
     * Returns with the direct sketch folders from the location of the `fileStat`.
     * The sketches returns with inverse-chronological order, the first item is the most recent one.
     */
    getSketches(uri?: string): Promise<Sketch[]>
    getSketchFiles(uri: string): Promise<string[]>
    /**
     * Creates a new sketch folder in the `parentUri` location.
     * Normally, `parentUri` is the client's workspace root, or the default `sketchDirUri` from the CLI.
     * Note, `parentUri` and `sketchDirUri` can be the same.
     */
    createNewSketch(parentUri: string): Promise<Sketch>
    isSketchFolder(uri: string): Promise<boolean>
}

export interface Sketch {
    readonly name: string;
    readonly uri: string
}