For full text search please use the '?' prefix. e.g. ? Onboarding

Note Lookup

Summary

This describes the logic for Note Lookup

State Diagram

State transitions for NoteLookupCommand

stateDiagram-v2 [*] --> LookupCommand state LookupCommand { [*] --> run run --> gatherInput gatherInput --> prepareQuickPick gatherInput --> constructProvider gatherInput --> enrichInput enrichInput --> subscribe enrichInput --> subscribedToListener subscribedToListener --> showQuickPick lookupExecute --> [*] state Controller { prepareQuickPick prepareQuickPick --> gatherInput showQuickPick --> onUpdatePickerItems showQuickPick --> [*] } state Provider { constructProvider --> gatherInput onUpdatePickerItems --> updatePickerItems } state Quickpick { state updatePickerItems <<choice>> updatePickerItems --> fetchRootResults: if qs = "" updatePickerItems --> [*]: if noChangeValue(picker) updatePickerItems --> fetchPickerResultsp fetchRootResults --> [*] } } state HistoryListener { state listen <<choice>> subscribe --> listening listening --> listen listen --> done : if action = done listen --> done : if action = changeState & data = hide & !picker.pending listen --> done : if action = error listen --> listening: otherwise done --> [*] } HistoryListener --> lookupExecute

Steps

Code

Gather Input

  • this method is responsible for configuring and instantiating the lookup controller and provider

    • controller controls presentation of the quickinput
    • provider controls the data retrieval behavior
    • on success, will return the following response type
    • NOTE: because we can't simply block on showQuickInput, we return a promise that listens to a lookupProvider event with the corresponding id of the particular command

  • src/commands/NoteLookupCommand.ts

gatherInputs {

    lc = this._controller = LookupControllerV3.create(buttons:[...], ...)
    provider = new NoteLookupProvider("lookup", {
        allowNewNote: true,
        ...
    })
    lc.prepareQuickPick
}

NoteLookup Provider

Prepare Quickpick

  • src/components/lookup/LookupControllerV3.ts
prepareQuickPick {
    quickpick.onTriggerButton = @onDidTriggerButton
    refreshButtons
}

showQuickPick {
    provider.onUpdatePickerItems

}

OnDidTriggerButton

onDidTriggerButton(btn) {
    find(btn, @state.buttons).pressed = btn.pressed
    refreshPickerBehavior(@state.buttons)
}

RefreshPickerBehavior

refreshPickerBehavior {
    buttonsEnabled :=
    buttonsDisabled :=

    buttonsEnabled.map bt => bt.onEnable
    buttonsDisabled.map bt => bt.onDisable
}

OnUpdatePickerItems

fetchpPickerResults

resp = engine.queryNotes;
nodes = filterPickerResults;

OnAccept

This gets triggered when the user selects a result form the quickpick.

Type Signature

quickpick: DendronQuickPick
selectedItems: NoteItemSelection[]

Pseudocode

  • src/components/lookup/LookupProviderV3.ts
onDidAccept {
    selectedItems := picker

    selectedItems ??= fetchPickerResultsNoInput

    if hasNextPicker(picker)

    resp = @_onAcceptHooks.map { hooks
        hook(picker, selectedItems)
    }

    HistoryInstance.add {
        source: lookupProvider,
        action: done,
        id: @id,
        data: {
            selectedItems,
            onAcceptHookResp: resp
        }
    }

}

execute {
    @acceptItem
}

acceptItem(item, picker) {

    throw if not picker.validate(item)

    if isNew(item) {
        @acceptNewItem
    } else {
        @acceptExistingItem
    }
}

acceptExistingItem {
    uri := item
    show uri
}

acceptNewItem(item, picker) {
    fname := picker
    if isStub(item) {
        note = notes[item.stub]
        delete note.stub
    } else {
        vault := getVaultForNewNote
        note = Note.create item

        if picker.hasSelectionProcessFunc {
            picker.hasSelectionProcessFunc(note)
        }

        if matchSchema(note) {
            addSchema(note)
        }
        if note.schema.template {
            applyTemplate(note)
        }
    }
    note = picker.transformTitle(note)
    picker.onCreate(note)
    writeNote note
}

getVaultForNewNote

getVaultForNewNote {

    vault := picker.vault || getVaultForOpenEditor

}
Backlinks