obsidian-dev-utils
Version:
This is the collection of useful functions that you can use for your Obsidian plugin development
90 lines (87 loc) • 10.4 kB
JavaScript
/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/
(function initEsm(){if(globalThis.process){return}const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};globalThis.process=browserProcess})();
import { Notice } from "obsidian";
import { abortSignalNever } from "../AbortController.mjs";
import { requestAnimationFrameAsync } from "../Async.mjs";
import { getLibDebugger } from "../Debug.mjs";
import {
ASYNC_ERROR_WRAPPER_MESSAGE,
emitAsyncErrorEvent
} from "../Error.mjs";
import { noop } from "../Function.mjs";
async function loop(options) {
const DEFAULT_OPTIONS = {
abortSignal: abortSignalNever,
buildNoticeMessage() {
throw new Error("buildNoticeMessage is required");
},
items: [],
// eslint-disable-next-line no-magic-numbers
noticeMinTimeoutInMilliseconds: 2e3,
processItem: noop,
progressBarTitle: "",
shouldContinueOnError: true,
shouldShowProgressBar: true,
// eslint-disable-next-line no-magic-numbers
uiUpdateThresholdInMilliseconds: 100
};
const fullOptions = {
...DEFAULT_OPTIONS,
...options
};
const items = fullOptions.items;
let iterationCount = 0;
let notice = null;
if (fullOptions.shouldShowProgressBar) {
notice = new Notice("", 0);
}
const noticeMinTimeoutPromise = sleep(fullOptions.noticeMinTimeoutInMilliseconds);
const progressBarEl = createEl("progress");
progressBarEl.max = items.length;
if (fullOptions.shouldShowProgressBar) {
const fragment = createFragment();
fragment.createDiv({ text: fullOptions.progressBarTitle });
fragment.appendChild(progressBarEl);
notice?.setMessage(fragment);
}
let lastUIUpdateTimestamp = performance.now();
for (const item of items) {
if (fullOptions.abortSignal.aborted) {
notice?.hide();
return;
}
iterationCount++;
const iterationStr = `# ${String(iterationCount)} / ${String(items.length)}`;
const message = fullOptions.buildNoticeMessage(item, iterationStr);
if (!fullOptions.shouldShowProgressBar) {
notice?.setMessage(message);
}
getLibDebugger("Loop")(message);
const asyncErrorWrapper = new Error(ASYNC_ERROR_WRAPPER_MESSAGE);
try {
if (performance.now() - lastUIUpdateTimestamp > fullOptions.uiUpdateThresholdInMilliseconds) {
await requestAnimationFrameAsync();
lastUIUpdateTimestamp = performance.now();
}
await fullOptions.processItem(item);
} catch (error) {
console.error("Error processing item", item);
if (!fullOptions.shouldContinueOnError) {
notice?.hide();
throw error;
}
asyncErrorWrapper.cause = error;
emitAsyncErrorEvent(asyncErrorWrapper);
}
progressBarEl.value++;
}
await noticeMinTimeoutPromise;
notice?.hide();
}
export {
loop
};
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL0xvb3AudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uXG4gKlxuICogQ29udGFpbnMgdXRpbGl0eSBmdW5jdGlvbnMgZm9yIGxvb3BpbmcgaW4gT2JzaWRpYW4uXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBQcm9taXNhYmxlIH0gZnJvbSAndHlwZS1mZXN0JztcblxuaW1wb3J0IHsgTm90aWNlIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG5pbXBvcnQgeyBhYm9ydFNpZ25hbE5ldmVyIH0gZnJvbSAnLi4vQWJvcnRDb250cm9sbGVyLnRzJztcbmltcG9ydCB7IHJlcXVlc3RBbmltYXRpb25GcmFtZUFzeW5jIH0gZnJvbSAnLi4vQXN5bmMudHMnO1xuaW1wb3J0IHsgZ2V0TGliRGVidWdnZXIgfSBmcm9tICcuLi9EZWJ1Zy50cyc7XG5pbXBvcnQge1xuICBBU1lOQ19FUlJPUl9XUkFQUEVSX01FU1NBR0UsXG4gIGVtaXRBc3luY0Vycm9yRXZlbnRcbn0gZnJvbSAnLi4vRXJyb3IudHMnO1xuaW1wb3J0IHsgbm9vcCB9IGZyb20gJy4uL0Z1bmN0aW9uLnRzJztcblxuLyoqXG4gKiBPcHRpb25zIGZvciB0aGUgbG9vcCBmdW5jdGlvbi5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBMb29wT3B0aW9uczxUPiB7XG4gIC8qKlxuICAgKiBBbiBvcHRpb25hbCBhYm9ydCBzaWduYWwgdG8gY2FuY2VsIHRoZSBsb29wLlxuICAgKi9cbiAgYWJvcnRTaWduYWw/OiBBYm9ydFNpZ25hbDtcbiAgLyoqXG4gICAqIFRoZSBmdW5jdGlvbiB0byBidWlsZCB0aGUgbm90aWNlIG1lc3NhZ2UgZm9yIGVhY2ggaXRlbS5cbiAgICovXG4gIGJ1aWxkTm90aWNlTWVzc2FnZShpdGVtOiBULCBpdGVyYXRpb25TdHI6IHN0cmluZyk6IHN0cmluZztcbiAgLyoqXG4gICAqIFRoZSBpdGVtcyB0byBsb29wIG92ZXIuXG4gICAqL1xuICBpdGVtczogVFtdO1xuICAvKipcbiAgICogVGhlIG1pbmltdW0gdGltZW91dCBmb3IgdGhlIG5vdGljZS5cbiAgICovXG4gIG5vdGljZU1pblRpbWVvdXRJbk1pbGxpc2Vjb25kcz86IG51bWJlcjtcbiAgLyoqXG4gICAqIFRoZSBmdW5jdGlvbiB0byBwcm9jZXNzIGVhY2ggaXRlbS5cbiAgICovXG4gIHByb2Nlc3NJdGVtKGl0ZW06IFQpOiBQcm9taXNhYmxlPHZvaWQ+O1xuICAvKipcbiAgICogVGhlIHRpdGxlIG9mIHRoZSBwcm9ncmVzcyBiYXIuXG4gICAqL1xuICBwcm9ncmVzc0JhclRpdGxlPzogc3RyaW5nO1xuICAvKipcbiAgICogV2hldGhlciB0byBjb250aW51ZSB0aGUgbG9vcCBvbiBlcnJvci5cbiAgICovXG4gIHNob3VsZENvbnRpbnVlT25FcnJvcj86IGJvb2xlYW47XG4gIC8qKlxuICAgKiBXaGV0aGVyIHRvIHNob3cgYSBwcm9ncmVzcyBiYXIuXG4gICAqL1xuICBzaG91bGRTaG93UHJvZ3Jlc3NCYXI/OiBib29sZWFuO1xuICAvKipcbiAgICogVGhlIHRocmVzaG9sZCBmb3IgdGhlIFVJIHVwZGF0ZS5cbiAgICovXG4gIHVpVXBkYXRlVGhyZXNob2xkSW5NaWxsaXNlY29uZHM/OiBudW1iZXI7XG59XG5cbi8qKlxuICogTG9vcHMgb3ZlciBhIGxpc3Qgb2YgaXRlbXMgYW5kIHByb2Nlc3NlcyBlYWNoIGl0ZW0uXG4gKlxuICogQHBhcmFtIG9wdGlvbnMgLSBUaGUgb3B0aW9ucyBmb3IgdGhlIGxvb3AuXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBsb29wPFQ+KG9wdGlvbnM6IExvb3BPcHRpb25zPFQ+KTogUHJvbWlzZTx2b2lkPiB7XG4gIGNvbnN0IERFRkFVTFRfT1BUSU9OUzogUmVxdWlyZWQ8TG9vcE9wdGlvbnM8VD4+ID0ge1xuICAgIGFib3J0U2lnbmFsOiBhYm9ydFNpZ25hbE5ldmVyLFxuICAgIGJ1aWxkTm90aWNlTWVzc2FnZSgpIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcignYnVpbGROb3RpY2VNZXNzYWdlIGlzIHJlcXVpcmVkJyk7XG4gICAgfSxcbiAgICBpdGVtczogW10sXG4gICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIG5vLW1hZ2ljLW51bWJlcnNcbiAgICBub3RpY2VNaW5UaW1lb3V0SW5NaWxsaXNlY29uZHM6IDIwMDAsXG4gICAgcHJvY2Vzc0l0ZW06IG5vb3AsXG4gICAgcHJvZ3Jlc3NCYXJUaXRsZTogJycsXG4gICAgc2hvdWxkQ29udGludWVPbkVycm9yOiB0cnVlLFxuICAgIHNob3VsZFNob3dQcm9ncmVzc0JhcjogdHJ1ZSxcbiAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgbm8tbWFnaWMtbnVtYmVyc1xuICAgIHVpVXBkYXRlVGhyZXNob2xkSW5NaWxsaXNlY29uZHM6IDEwMFxuICB9O1xuXG4gIGNvbnN0IGZ1bGxPcHRpb25zOiBSZXF1aXJlZDxMb29wT3B0aW9uczxUPj4gPSB7XG4gICAgLi4uREVGQVVMVF9PUFRJT05TLFxuICAgIC4uLm9wdGlvbnNcbiAgfTtcblxuICBjb25zdCBpdGVtcyA9IGZ1bGxPcHRpb25zLml0ZW1zO1xuICBsZXQgaXRlcmF0aW9uQ291bnQgPSAwO1xuICBsZXQgbm90aWNlOiBOb3RpY2UgfCBudWxsID0gbnVsbDtcbiAgaWYgKGZ1bGxPcHRpb25zLnNob3VsZFNob3dQcm9ncmVzc0Jhcikge1xuICAgIG5vdGljZSA9IG5ldyBOb3RpY2UoJycsIDApO1xuICB9XG4gIGNvbnN0IG5vdGljZU1pblRpbWVvdXRQcm9taXNlID0gc2xlZXAoZnVsbE9wdGlvbnMubm90aWNlTWluVGltZW91dEluTWlsbGlzZWNvbmRzKTtcbiAgY29uc3QgcHJvZ3Jlc3NCYXJFbCA9IGNyZWF0ZUVsKCdwcm9ncmVzcycpO1xuICBwcm9ncmVzc0JhckVsLm1heCA9IGl0ZW1zLmxlbmd0aDtcbiAgaWYgKGZ1bGxPcHRpb25zLnNob3VsZFNob3dQcm9ncmVzc0Jhcikge1xuICAgIGNvbnN0IGZyYWdtZW50ID0gY3JlYXRlRnJhZ21lbnQoKTtcbiAgICBmcmFnbWVudC5jcmVhdGVEaXYoeyB0ZXh0OiBmdWxsT3B0aW9ucy5wcm9ncmVzc0JhclRpdGxlIH0pO1xuICAgIGZyYWdtZW50LmFwcGVuZENoaWxkKHByb2dyZXNzQmFyRWwpO1xuICAgIG5vdGljZT8uc2V0TWVzc2FnZShmcmFnbWVudCk7XG4gIH1cblxuICBsZXQgbGFzdFVJVXBkYXRlVGltZXN0YW1wID0gcGVyZm9ybWFuY2Uubm93KCk7XG5cbiAgZm9yIChjb25zdCBpdGVtIG9mIGl0ZW1zKSB7XG4gICAgaWYgKGZ1bGxPcHRpb25zLmFib3J0U2lnbmFsLmFib3J0ZWQpIHtcbiAgICAgIG5vdGljZT8uaGlkZSgpO1xuICAgICAgcmV0dXJuO1xuICAgIH1cbiAgICBpdGVyYXRpb25Db3VudCsrO1xuICAgIGNvbnN0IGl0ZXJhdGlvblN0ciA9IGAjICR7U3RyaW5nKGl0ZXJhdGlvbkNvdW50KX0gLyAke1N0cmluZyhpdGVtcy5sZW5ndGgpfWA7XG4gICAgY29uc3QgbWVzc2FnZSA9IGZ1bGxPcHRpb25zLmJ1aWxkTm90aWNlTWVzc2FnZShpdGVtLCBpdGVyYXRpb25TdHIpO1xuICAgIGlmICghZnVsbE9wdGlvbnMuc2hvdWxkU2hvd1Byb2dyZXNzQmFyKSB7XG4gICAgICBub3RpY2U/LnNldE1lc3NhZ2UobWVzc2FnZSk7XG4gICAgfVxuICAgIGdldExpYkRlYnVnZ2VyKCdMb29wJykobWVzc2FnZSk7XG5cbiAgICBjb25zdCBhc3luY0Vycm9yV3JhcHBlciA9IG5ldyBFcnJvcihBU1lOQ19FUlJPUl9XUkFQUEVSX01FU1NBR0UpO1xuICAgIHRyeSB7XG4gICAgICBpZiAocGVyZm9ybWFuY2Uubm93KCkgLSBsYXN0VUlVcGRhdGVUaW1lc3RhbXAgPiBmdWxsT3B0aW9ucy51aVVwZGF0ZVRocmVzaG9sZEluTWlsbGlzZWNvbmRzKSB7XG4gICAgICAgIGF3YWl0IHJlcXVlc3RBbmltYXRpb25GcmFtZUFzeW5jKCk7XG4gICAgICAgIGxhc3RVSVVwZGF0ZVRpbWVzdGFtcCA9IHBlcmZvcm1hbmNlLm5vdygpO1xuICAgICAgfVxuICAgICAgYXdhaXQgZnVsbE9wdGlvbnMucHJvY2Vzc0l0ZW0oaXRlbSk7XG4gICAgfSBjYXRjaCAoZXJyb3IpIHtcbiAgICAgIGNvbnNvbGUuZXJyb3IoJ0Vycm9yIHByb2Nlc3NpbmcgaXRlbScsIGl0ZW0pO1xuICAgICAgaWYgKCFmdWxsT3B0aW9ucy5zaG91bGRDb250aW51ZU9uRXJyb3IpIHtcbiAgICAgICAgbm90aWNlPy5oaWRlKCk7XG4gICAgICAgIHRocm93IGVycm9yO1xuICAgICAgfVxuICAgICAgYXN5bmNFcnJvcldyYXBwZXIuY2F1c2UgPSBlcnJvcjtcbiAgICAgIGVtaXRBc3luY0Vycm9yRXZlbnQoYXN5bmNFcnJvcldyYXBwZXIpO1xuICAgIH1cbiAgICBwcm9ncmVzc0JhckVsLnZhbHVlKys7XG4gIH1cbiAgYXdhaXQgbm90aWNlTWluVGltZW91dFByb21pc2U7XG4gIG5vdGljZT8uaGlkZSgpO1xufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7OztBQVFBLFNBQVMsY0FBYztBQUV2QixTQUFTLHdCQUF3QjtBQUNqQyxTQUFTLGtDQUFrQztBQUMzQyxTQUFTLHNCQUFzQjtBQUMvQjtBQUFBLEVBQ0U7QUFBQSxFQUNBO0FBQUEsT0FDSztBQUNQLFNBQVMsWUFBWTtBQWlEckIsZUFBc0IsS0FBUSxTQUF3QztBQUNwRSxRQUFNLGtCQUE0QztBQUFBLElBQ2hELGFBQWE7QUFBQSxJQUNiLHFCQUFxQjtBQUNuQixZQUFNLElBQUksTUFBTSxnQ0FBZ0M7QUFBQSxJQUNsRDtBQUFBLElBQ0EsT0FBTyxDQUFDO0FBQUE7QUFBQSxJQUVSLGdDQUFnQztBQUFBLElBQ2hDLGFBQWE7QUFBQSxJQUNiLGtCQUFrQjtBQUFBLElBQ2xCLHVCQUF1QjtBQUFBLElBQ3ZCLHVCQUF1QjtBQUFBO0FBQUEsSUFFdkIsaUNBQWlDO0FBQUEsRUFDbkM7QUFFQSxRQUFNLGNBQXdDO0FBQUEsSUFDNUMsR0FBRztBQUFBLElBQ0gsR0FBRztBQUFBLEVBQ0w7QUFFQSxRQUFNLFFBQVEsWUFBWTtBQUMxQixNQUFJLGlCQUFpQjtBQUNyQixNQUFJLFNBQXdCO0FBQzVCLE1BQUksWUFBWSx1QkFBdUI7QUFDckMsYUFBUyxJQUFJLE9BQU8sSUFBSSxDQUFDO0FBQUEsRUFDM0I7QUFDQSxRQUFNLDBCQUEwQixNQUFNLFlBQVksOEJBQThCO0FBQ2hGLFFBQU0sZ0JBQWdCLFNBQVMsVUFBVTtBQUN6QyxnQkFBYyxNQUFNLE1BQU07QUFDMUIsTUFBSSxZQUFZLHVCQUF1QjtBQUNyQyxVQUFNLFdBQVcsZUFBZTtBQUNoQyxhQUFTLFVBQVUsRUFBRSxNQUFNLFlBQVksaUJBQWlCLENBQUM7QUFDekQsYUFBUyxZQUFZLGFBQWE7QUFDbEMsWUFBUSxXQUFXLFFBQVE7QUFBQSxFQUM3QjtBQUVBLE1BQUksd0JBQXdCLFlBQVksSUFBSTtBQUU1QyxhQUFXLFFBQVEsT0FBTztBQUN4QixRQUFJLFlBQVksWUFBWSxTQUFTO0FBQ25DLGNBQVEsS0FBSztBQUNiO0FBQUEsSUFDRjtBQUNBO0FBQ0EsVUFBTSxlQUFlLEtBQUssT0FBTyxjQUFjLENBQUMsTUFBTSxPQUFPLE1BQU0sTUFBTSxDQUFDO0FBQzFFLFVBQU0sVUFBVSxZQUFZLG1CQUFtQixNQUFNLFlBQVk7QUFDakUsUUFBSSxDQUFDLFlBQVksdUJBQXVCO0FBQ3RDLGNBQVEsV0FBVyxPQUFPO0FBQUEsSUFDNUI7QUFDQSxtQkFBZSxNQUFNLEVBQUUsT0FBTztBQUU5QixVQUFNLG9CQUFvQixJQUFJLE1BQU0sMkJBQTJCO0FBQy9ELFFBQUk7QUFDRixVQUFJLFlBQVksSUFBSSxJQUFJLHdCQUF3QixZQUFZLGlDQUFpQztBQUMzRixjQUFNLDJCQUEyQjtBQUNqQyxnQ0FBd0IsWUFBWSxJQUFJO0FBQUEsTUFDMUM7QUFDQSxZQUFNLFlBQVksWUFBWSxJQUFJO0FBQUEsSUFDcEMsU0FBUyxPQUFPO0FBQ2QsY0FBUSxNQUFNLHlCQUF5QixJQUFJO0FBQzNDLFVBQUksQ0FBQyxZQUFZLHVCQUF1QjtBQUN0QyxnQkFBUSxLQUFLO0FBQ2IsY0FBTTtBQUFBLE1BQ1I7QUFDQSx3QkFBa0IsUUFBUTtBQUMxQiwwQkFBb0IsaUJBQWlCO0FBQUEsSUFDdkM7QUFDQSxrQkFBYztBQUFBLEVBQ2hCO0FBQ0EsUUFBTTtBQUNOLFVBQVEsS0FBSztBQUNmOyIsCiAgIm5hbWVzIjogW10KfQo=