obsidian-dev-utils 93.3.1 → 94.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/dist/integration-test-plugin/main.js +8 -1
- package/dist/lib/cjs/__merged.cjs +3 -1
- package/dist/lib/cjs/__merged.d.cts +1 -1
- package/dist/lib/cjs/generated-during-build.cjs +1 -1
- package/dist/lib/cjs/obsidian/modals/prompt.cjs +3 -1
- package/dist/lib/cjs/obsidian/obsidian-settings.cjs +6 -1
- package/dist/lib/cjs/obsidian/obsidian-settings.d.cts +7 -0
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.cjs +2 -1
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.d.cts +4 -0
- package/dist/lib/cjs/script-utils/demo-vault-app-json.cjs +164 -0
- package/dist/lib/cjs/script-utils/demo-vault-app-json.d.cts +93 -0
- package/dist/lib/cjs/script-utils/demo-vault-coverage.cjs +18 -1
- package/dist/lib/cjs/script-utils/demo-vault-coverage.d.cts +13 -0
- package/dist/lib/cjs/script-utils/demo-vault.cjs +27 -1
- package/dist/lib/cjs/script-utils/demo-vault.d.cts +5 -0
- package/dist/lib/cjs/script-utils/index.cjs +4 -1
- package/dist/lib/cjs/script-utils/index.d.cts +1 -0
- package/dist/lib/esm/__merged.d.mts +1 -1
- package/dist/lib/esm/__merged.mjs +3 -1
- package/dist/lib/esm/generated-during-build.mjs +1 -1
- package/dist/lib/esm/obsidian/modals/prompt.mjs +3 -1
- package/dist/lib/esm/obsidian/obsidian-settings.d.mts +7 -0
- package/dist/lib/esm/obsidian/obsidian-settings.mjs +5 -1
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.d.mts +4 -0
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.mjs +2 -1
- package/dist/lib/esm/script-utils/demo-vault-app-json.d.mts +93 -0
- package/dist/lib/esm/script-utils/demo-vault-app-json.mjs +57 -0
- package/dist/lib/esm/script-utils/demo-vault-coverage.d.mts +13 -0
- package/dist/lib/esm/script-utils/demo-vault-coverage.mjs +22 -1
- package/dist/lib/esm/script-utils/demo-vault.d.mts +5 -0
- package/dist/lib/esm/script-utils/demo-vault.mjs +31 -1
- package/dist/lib/esm/script-utils/index.d.mts +1 -0
- package/dist/lib/esm/script-utils/index.mjs +3 -1
- package/package.json +6 -6
- package/script-utils/demo-vault-app-json/package.json +6 -0
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
(function initCjs() {
|
|
7
|
+
// eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
|
|
8
|
+
const globalThisRecord = globalThis;
|
|
9
|
+
globalThisRecord['__name'] ??= name;
|
|
10
|
+
const originalRequire = require;
|
|
11
|
+
if (originalRequire && !originalRequire.__isPatched) {
|
|
12
|
+
// eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
|
|
13
|
+
require = Object.assign(
|
|
14
|
+
(id) => requirePatched(id),
|
|
15
|
+
originalRequire,
|
|
16
|
+
{
|
|
17
|
+
__isPatched: true
|
|
18
|
+
}
|
|
19
|
+
);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const newFuncs = {
|
|
23
|
+
__extractDefault() {
|
|
24
|
+
return extractDefault;
|
|
25
|
+
},
|
|
26
|
+
process() {
|
|
27
|
+
const browserProcess = {
|
|
28
|
+
browser: true,
|
|
29
|
+
cwd() {
|
|
30
|
+
return '/';
|
|
31
|
+
},
|
|
32
|
+
env: {},
|
|
33
|
+
platform: 'android'
|
|
34
|
+
};
|
|
35
|
+
return browserProcess;
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
for (const key of Object.keys(newFuncs)) {
|
|
40
|
+
globalThisRecord[key] ??= newFuncs[key]?.();
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function extractDefault(module) {
|
|
44
|
+
return module && module.__esModule && 'default' in module ? module.default : module;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
|
|
48
|
+
'@codemirror/autocomplete',
|
|
49
|
+
'@codemirror/collab',
|
|
50
|
+
'@codemirror/commands',
|
|
51
|
+
'@codemirror/language',
|
|
52
|
+
'@codemirror/lint',
|
|
53
|
+
'@codemirror/search',
|
|
54
|
+
'@codemirror/state',
|
|
55
|
+
'@codemirror/text',
|
|
56
|
+
'@codemirror/view',
|
|
57
|
+
'@lezer/common',
|
|
58
|
+
'@lezer/highlight',
|
|
59
|
+
'@lezer/lr',
|
|
60
|
+
'obsidian']
|
|
61
|
+
);
|
|
62
|
+
|
|
63
|
+
const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
|
|
64
|
+
'@codemirror/closebrackets',
|
|
65
|
+
'@codemirror/comment',
|
|
66
|
+
'@codemirror/fold',
|
|
67
|
+
'@codemirror/gutter',
|
|
68
|
+
'@codemirror/highlight',
|
|
69
|
+
'@codemirror/history',
|
|
70
|
+
'@codemirror/matchbrackets',
|
|
71
|
+
'@codemirror/panel',
|
|
72
|
+
'@codemirror/rangeset',
|
|
73
|
+
'@codemirror/rectangular-selection',
|
|
74
|
+
'@codemirror/stream-parser',
|
|
75
|
+
'@codemirror/tooltip']
|
|
76
|
+
);
|
|
77
|
+
|
|
78
|
+
function requirePatched(id) {
|
|
79
|
+
if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
|
|
80
|
+
return originalRequire?.(id);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this -- Need access to app. Actively use globalThis.
|
|
84
|
+
if (globalThis.app.isMobile) {
|
|
85
|
+
if (id === 'process' || id === 'node:process') {
|
|
86
|
+
// eslint-disable-next-line no-console -- Valid usage.
|
|
87
|
+
console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
|
|
88
|
+
|
|
89
|
+
return process;
|
|
90
|
+
}
|
|
91
|
+
} else {
|
|
92
|
+
const module = originalRequire?.(id);
|
|
93
|
+
if (module) {
|
|
94
|
+
return extractDefault(module);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// eslint-disable-next-line no-console -- Valid usage.
|
|
99
|
+
console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
|
|
100
|
+
return {};
|
|
101
|
+
}
|
|
102
|
+
})();
|
|
103
|
+
|
|
104
|
+
"use strict";
|
|
105
|
+
var __defProp = Object.defineProperty;
|
|
106
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
107
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
108
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
109
|
+
var __export = (target, all) => {
|
|
110
|
+
for (var name in all)
|
|
111
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
112
|
+
};
|
|
113
|
+
var __copyProps = (to, from, except, desc) => {
|
|
114
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
115
|
+
for (let key of __getOwnPropNames(from))
|
|
116
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
117
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
118
|
+
}
|
|
119
|
+
return to;
|
|
120
|
+
};
|
|
121
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
122
|
+
var demo_vault_app_json_exports = {};
|
|
123
|
+
__export(demo_vault_app_json_exports, {
|
|
124
|
+
DEMO_VAULT_APP_JSON_SETTINGS: () => DEMO_VAULT_APP_JSON_SETTINGS,
|
|
125
|
+
buildArchivedDemoVaultAppJsonContent: () => buildArchivedDemoVaultAppJsonContent,
|
|
126
|
+
findOwnedDemoVaultAppJsonSettings: () => findOwnedDemoVaultAppJsonSettings,
|
|
127
|
+
parseDemoVaultAppJson: () => parseDemoVaultAppJson
|
|
128
|
+
});
|
|
129
|
+
module.exports = __toCommonJS(demo_vault_app_json_exports);
|
|
130
|
+
var import_object_utils = require('../object-utils.cjs');
|
|
131
|
+
const DEMO_VAULT_APP_JSON_SETTINGS = {
|
|
132
|
+
defaultViewMode: "preview",
|
|
133
|
+
livePreview: false,
|
|
134
|
+
newLinkFormat: "relative",
|
|
135
|
+
useMarkdownLinks: true
|
|
136
|
+
};
|
|
137
|
+
function buildArchivedDemoVaultAppJsonContent(params) {
|
|
138
|
+
return `${(0, import_object_utils.toJson)({
|
|
139
|
+
...params.appJson,
|
|
140
|
+
...DEMO_VAULT_APP_JSON_SETTINGS
|
|
141
|
+
})}
|
|
142
|
+
`;
|
|
143
|
+
}
|
|
144
|
+
function findOwnedDemoVaultAppJsonSettings(params) {
|
|
145
|
+
return Object.keys(DEMO_VAULT_APP_JSON_SETTINGS).filter((setting) => Object.hasOwn(params.appJson, setting));
|
|
146
|
+
}
|
|
147
|
+
function parseDemoVaultAppJson(params) {
|
|
148
|
+
if (params.content === null) {
|
|
149
|
+
return {};
|
|
150
|
+
}
|
|
151
|
+
try {
|
|
152
|
+
return JSON.parse(params.content);
|
|
153
|
+
} catch (error) {
|
|
154
|
+
throw new Error(`Could not parse ${params.path}.`, { cause: error });
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
158
|
+
0 && (module.exports = {
|
|
159
|
+
DEMO_VAULT_APP_JSON_SETTINGS,
|
|
160
|
+
buildArchivedDemoVaultAppJsonContent,
|
|
161
|
+
findOwnedDemoVaultAppJsonSettings,
|
|
162
|
+
parseDemoVaultAppJson
|
|
163
|
+
});
|
|
164
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3NjcmlwdC11dGlscy9kZW1vLXZhdWx0LWFwcC1qc29uLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVGhlIGAub2JzaWRpYW4vYXBwLmpzb25gIHNldHRpbmdzIGBvYnNpZGlhbi1kZXYtdXRpbHNgIG93bnMgaW4gZXZlcnkgZGVtbyB2YXVsdC5cbiAqXG4gKiBBIGRlbW8gdmF1bHQgaXMgZG9jdW1lbnRhdGlvbiBmaXJzdCBhbmQgYW4gZWRpdGluZyBzdXJmYWNlIHNlY29uZCwgc28gZm91ciBPYnNpZGlhbiBzZXR0aW5ncyBoYXZlIHRvIGJlXG4gKiB0aGUgc2FtZSBpbiBldmVyeSBvbmUgb2YgdGhlbS4gVGhleSBhcmUgKipub3QqKiBjb21taXR0ZWQ6IGEgdmF1bHQgdGhhdCB3cm90ZSB0aGVtIGl0c2VsZiB3b3VsZCBkcmlmdFxuICogKG1lYXN1cmVkIDIwMjYtMDgtMTMsIG9ubHkgMyBvZiAyMyB2YXVsdHMgaGFkIHRoZSBmaXJzdCBwYWlyIGFuZCAxIG9mIDIzIHRoZSBzZWNvbmQpLCBzbyB0aGlzIHBhY2thZ2VcbiAqIG93bnMgdGhlbSBpbnN0ZWFkIFx1MjAxNCB7QGxpbmsgYXJjaGl2ZVBsdWdpbkRlbW9WYXVsdH0gbWVyZ2VzIHRoZW0gaW50byB0aGUgYGFwcC5qc29uYCBvZiB0aGUgYXJjaGl2ZWQgY29weVxuICogYXQgcmVsZWFzZSB0aW1lLCBhbmQgdGhlIGRlbW8tdmF1bHQgY292ZXJhZ2Ugc3VpdGUgZmFpbHMgYSB2YXVsdCB0aGF0IGNvbW1pdHMgYW55IG9mIHRoZW0uXG4gKlxuICogLSBgZGVmYXVsdFZpZXdNb2RlOiAncHJldmlldydgICsgYGxpdmVQcmV2aWV3OiBmYWxzZWAgXHUyMDE0IGEgbm90ZSBvcGVucyBhcyBhIHJlYWRlciBzZWVzIGl0IHJhdGhlciB0aGFuIGFzXG4gKiAgIHJhdyBtYXJrdXAuIE9ic2lkaWFuLW9ubHk6IEdpdEh1YiBuZXZlciByZWFkcyBgYXBwLmpzb25gIGFuZCByZW5kZXJzIGV2ZXJ5IG5vdGUgYXMgSFRNTCByZWdhcmRsZXNzLlxuICogLSBgdXNlTWFya2Rvd25MaW5rczogdHJ1ZWAgKyBgbmV3TGlua0Zvcm1hdDogJ3JlbGF0aXZlJ2AgXHUyMDE0IHdoYXQgT2JzaWRpYW4gd3JpdGVzIHdoZW4gYSBsaW5rIGlzIGNyZWF0ZWRcbiAqICAgaW5zaWRlIHRoZSB2YXVsdC4gTGVmdCBhdCBPYnNpZGlhbidzIGRlZmF1bHRzIChgZmFsc2VgIC8gYCdzaG9ydGVzdCdgKSBldmVyeSBuZXcgbGluayBjb21lcyBvdXQgYXMgYVxuICogICBzaG9ydGVzdC1wYXRoIGBbW3dpa2lsaW5rXV1gLCB0aGUgZm9ybSB0aGUgY292ZXJhZ2Ugc3VpdGUgcmVqZWN0cyBhbmQgR2l0SHViIHJlbmRlcnMgYXMgbGl0ZXJhbFxuICogICBicmFja2V0cy4gYHJlbGF0aXZlYCByYXRoZXIgdGhhbiBgYWJzb2x1dGVgIHNvIG5vdGVzIGtlZXAgcmVzb2x2aW5nIG9uY2UgdGhlIHZhdWx0IGlzIGV4dHJhY3RlZCB0byBhblxuICogICBhcmJpdHJhcnkgZm9sZGVyLlxuICpcbiAqIEFsbCBmb3VyIGFyZSB3cml0dGVuIGV4cGxpY2l0bHksIG5ldmVyIGxlZnQgdG8gYW4gT2JzaWRpYW4gZGVmYXVsdDogYSB2YXVsdCBsZWFuaW5nIG9uIGEgZGVmYXVsdCBjaGFuZ2VzXG4gKiBiZWhhdmlvciB3aGVuIHRoYXQgZGVmYXVsdCBkb2VzLlxuICpcbiAqIEtlcHQgZnJlZSBvZiBib3RoIGB2aXRlc3RgIGFuZCBgYWRtLXppcGAgb24gcHVycG9zZSBcdTIwMTQgdGhlIGNvdmVyYWdlIHN1aXRlIHB1bGxzIGluIHRoZSBmb3JtZXIgYW5kIHRoZVxuICogYXJjaGl2ZXIgdGhlIGxhdHRlciwgYW5kIG5laXRoZXIgbWF5IHJlYWNoIHRoZSBvdGhlcidzIGVudmlyb25tZW50LlxuICovXG5cbmltcG9ydCB7IHRvSnNvbiB9IGZyb20gJy4uL29iamVjdC11dGlscy50cyc7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3Ige0BsaW5rIGJ1aWxkQXJjaGl2ZWREZW1vVmF1bHRBcHBKc29uQ29udGVudH0uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgQnVpbGRBcmNoaXZlZERlbW9WYXVsdEFwcEpzb25Db250ZW50UGFyYW1zIHtcbiAgLyoqXG4gICAqIFRoZSBkZW1vIHZhdWx0J3MgY29tbWl0dGVkIGBhcHAuanNvbmAsIHBhcnNlZCBieSB7QGxpbmsgcGFyc2VEZW1vVmF1bHRBcHBKc29ufS5cbiAgICovXG4gIHJlYWRvbmx5IGFwcEpzb246IERlbW9WYXVsdEFwcEpzb247XG59XG5cbi8qKlxuICogQSBwYXJzZWQgYC5vYnNpZGlhbi9hcHAuanNvbmAuIE9ubHkgdGhlIHNldHRpbmdzIGluIHtAbGluayBERU1PX1ZBVUxUX0FQUF9KU09OX1NFVFRJTkdTfSBhcmUgaW50ZXJwcmV0ZWQ7XG4gKiBldmVyeSBvdGhlciBzZXR0aW5nIGlzIGNhcnJpZWQgdGhyb3VnaCB1bnRvdWNoZWQuXG4gKi9cbmV4cG9ydCB0eXBlIERlbW9WYXVsdEFwcEpzb24gPSBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPjtcblxuLyoqXG4gKiBQYXJhbWV0ZXJzIGZvciB7QGxpbmsgZmluZE93bmVkRGVtb1ZhdWx0QXBwSnNvblNldHRpbmdzfS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBGaW5kT3duZWREZW1vVmF1bHRBcHBKc29uU2V0dGluZ3NQYXJhbXMge1xuICAvKipcbiAgICogVGhlIGRlbW8gdmF1bHQncyBjb21taXR0ZWQgYGFwcC5qc29uYCwgcGFyc2VkIGJ5IHtAbGluayBwYXJzZURlbW9WYXVsdEFwcEpzb259LlxuICAgKi9cbiAgcmVhZG9ubHkgYXBwSnNvbjogRGVtb1ZhdWx0QXBwSnNvbjtcbn1cblxuLyoqXG4gKiBQYXJhbWV0ZXJzIGZvciB7QGxpbmsgcGFyc2VEZW1vVmF1bHRBcHBKc29ufS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBQYXJzZURlbW9WYXVsdEFwcEpzb25QYXJhbXMge1xuICAvKipcbiAgICogVGhlIHJhdyBmaWxlIGNvbnRlbnQsIG9yIGBudWxsYCB3aGVuIHRoZSB2YXVsdCBjb21taXRzIG5vIGBhcHAuanNvbmAgYXQgYWxsIFx1MjAxNCB3aGljaCBpcyB0aGUgZXhwZWN0ZWRcbiAgICogc3RhdGUgZm9yIGEgdmF1bHQgdGhhdCBoYXMgbm90aGluZyBlbHNlIHRvIGNvbmZpZ3VyZS5cbiAgICovXG4gIHJlYWRvbmx5IGNvbnRlbnQ6IG51bGwgfCBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSBwYXRoIHRoZSBjb250ZW50IHdhcyByZWFkIGZyb20sIG5hbWVkIGluIHRoZSBlcnJvciB3aGVuIGl0IGRvZXMgbm90IHBhcnNlLlxuICAgKi9cbiAgcmVhZG9ubHkgcGF0aDogc3RyaW5nO1xufVxuXG4vKipcbiAqIFRoZSBgLm9ic2lkaWFuL2FwcC5qc29uYCBzZXR0aW5ncyB0aGlzIHBhY2thZ2Ugd3JpdGVzIGludG8gZXZlcnkgYXJjaGl2ZWQgZGVtbyB2YXVsdCwgYW5kIHRoYXQgYSBkZW1vXG4gKiB2YXVsdCBtdXN0IHRoZXJlZm9yZSBuZXZlciBjb21taXQuIFNlZSB0aGUgZmlsZSBvdmVydmlldyBmb3Igd2hhdCBlYWNoIG9uZSBidXlzLlxuICovXG5leHBvcnQgY29uc3QgREVNT19WQVVMVF9BUFBfSlNPTl9TRVRUSU5HUzogRGVtb1ZhdWx0QXBwSnNvbiA9IHtcbiAgZGVmYXVsdFZpZXdNb2RlOiAncHJldmlldycsXG4gIGxpdmVQcmV2aWV3OiBmYWxzZSxcbiAgbmV3TGlua0Zvcm1hdDogJ3JlbGF0aXZlJyxcbiAgdXNlTWFya2Rvd25MaW5rczogdHJ1ZVxufTtcblxuLyoqXG4gKiBCdWlsZHMgdGhlIGBhcHAuanNvbmAgY29udGVudCBmb3IgdGhlIGFyY2hpdmVkIGNvcHkgb2YgYSBkZW1vIHZhdWx0OiB0aGUgY29tbWl0dGVkIHNldHRpbmdzIHdpdGggdGhlXG4gKiBvd25lZCBvbmVzIG1lcmdlZCBvdmVyIHRoZW0uXG4gKlxuICogQHBhcmFtIHBhcmFtcyAtIFRoZSBwYXJhbWV0ZXJzIGZvciB0aGUgYnVpbGQuXG4gKiBAcmV0dXJucyBUaGUgSlNPTiB0ZXh0IHRvIHN0b3JlIGFzIHRoZSBhcmNoaXZlJ3MgYC5vYnNpZGlhbi9hcHAuanNvbmAuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBidWlsZEFyY2hpdmVkRGVtb1ZhdWx0QXBwSnNvbkNvbnRlbnQocGFyYW1zOiBCdWlsZEFyY2hpdmVkRGVtb1ZhdWx0QXBwSnNvbkNvbnRlbnRQYXJhbXMpOiBzdHJpbmcge1xuICByZXR1cm4gYCR7XG4gICAgdG9Kc29uKHtcbiAgICAgIC4uLnBhcmFtcy5hcHBKc29uLFxuICAgICAgLi4uREVNT19WQVVMVF9BUFBfSlNPTl9TRVRUSU5HU1xuICAgIH0pXG4gIH1cXG5gO1xufVxuXG4vKipcbiAqIEZpbmRzIHRoZSBvd25lZCBzZXR0aW5ncyBhIGRlbW8gdmF1bHQgaGFzIGNvbW1pdHRlZC4gVGhleSBiZWxvbmcgdG8gdGhpcyBwYWNrYWdlLCB3aGljaCBpbmplY3RzIHRoZW0gYXRcbiAqIHJlbGVhc2UgdGltZSwgc28gYSBjb21taXR0ZWQgb25lIGlzIGRyaWZ0IHdhaXRpbmcgdG8gaGFwcGVuIHJhdGhlciB0aGFuIGEgbG9jYWwgcHJlZmVyZW5jZS5cbiAqXG4gKiBAcGFyYW0gcGFyYW1zIC0gVGhlIHBhcmFtZXRlcnMgZm9yIHRoZSBsb29rdXAuXG4gKiBAcmV0dXJucyBUaGUgbmFtZXMgb2YgdGhlIG93bmVkIHNldHRpbmdzIHByZXNlbnQgaW4gdGhlIGNvbW1pdHRlZCBgYXBwLmpzb25gLCBpbiB0aGUgb3JkZXIgdGhleSBhcmVcbiAqIGRlY2xhcmVkIGluIHtAbGluayBERU1PX1ZBVUxUX0FQUF9KU09OX1NFVFRJTkdTfS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGZpbmRPd25lZERlbW9WYXVsdEFwcEpzb25TZXR0aW5ncyhwYXJhbXM6IEZpbmRPd25lZERlbW9WYXVsdEFwcEpzb25TZXR0aW5nc1BhcmFtcyk6IHN0cmluZ1tdIHtcbiAgcmV0dXJuIE9iamVjdC5rZXlzKERFTU9fVkFVTFRfQVBQX0pTT05fU0VUVElOR1MpLmZpbHRlcigoc2V0dGluZykgPT4gT2JqZWN0Lmhhc093bihwYXJhbXMuYXBwSnNvbiwgc2V0dGluZykpO1xufVxuXG4vKipcbiAqIFBhcnNlcyBhIGRlbW8gdmF1bHQncyBjb21taXR0ZWQgYGFwcC5qc29uYC5cbiAqXG4gKiBAcGFyYW0gcGFyYW1zIC0gVGhlIHBhcmFtZXRlcnMgZm9yIHRoZSBwYXJzZS5cbiAqIEByZXR1cm5zIFRoZSBwYXJzZWQgc2V0dGluZ3MsIG9yIGFuIGVtcHR5IG9iamVjdCB3aGVuIHRoZSB2YXVsdCBjb21taXRzIG5vIGBhcHAuanNvbmAuXG4gKiBAdGhyb3dzIFdoZW4gdGhlIGNvbnRlbnQgaXMgbm90IHZhbGlkIEpTT04sIG5hbWluZyB0aGUgZmlsZSBpdCBjYW1lIGZyb20uXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBwYXJzZURlbW9WYXVsdEFwcEpzb24ocGFyYW1zOiBQYXJzZURlbW9WYXVsdEFwcEpzb25QYXJhbXMpOiBEZW1vVmF1bHRBcHBKc29uIHtcbiAgaWYgKHBhcmFtcy5jb250ZW50ID09PSBudWxsKSB7XG4gICAgcmV0dXJuIHt9O1xuICB9XG5cbiAgdHJ5IHtcbiAgICByZXR1cm4gSlNPTi5wYXJzZShwYXJhbXMuY29udGVudCkgYXMgRGVtb1ZhdWx0QXBwSnNvbjtcbiAgfSBjYXRjaCAoZXJyb3IpIHtcbiAgICB0aHJvdyBuZXcgRXJyb3IoYENvdWxkIG5vdCBwYXJzZSAke3BhcmFtcy5wYXRofS5gLCB7IGNhdXNlOiBlcnJvciB9KTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUEwQkEsMEJBQXVCO0FBZ0RoQixNQUFNLCtCQUFpRDtBQUFBLEVBQzVELGlCQUFpQjtBQUFBLEVBQ2pCLGFBQWE7QUFBQSxFQUNiLGVBQWU7QUFBQSxFQUNmLGtCQUFrQjtBQUNwQjtBQVNPLFNBQVMscUNBQXFDLFFBQTREO0FBQy9HLFNBQU8sT0FDTCw0QkFBTztBQUFBLElBQ0wsR0FBRyxPQUFPO0FBQUEsSUFDVixHQUFHO0FBQUEsRUFDTCxDQUFDLENBQ0g7QUFBQTtBQUNGO0FBVU8sU0FBUyxrQ0FBa0MsUUFBMkQ7QUFDM0csU0FBTyxPQUFPLEtBQUssNEJBQTRCLEVBQUUsT0FBTyxDQUFDLFlBQVksT0FBTyxPQUFPLE9BQU8sU0FBUyxPQUFPLENBQUM7QUFDN0c7QUFTTyxTQUFTLHNCQUFzQixRQUF1RDtBQUMzRixNQUFJLE9BQU8sWUFBWSxNQUFNO0FBQzNCLFdBQU8sQ0FBQztBQUFBLEVBQ1Y7QUFFQSxNQUFJO0FBQ0YsV0FBTyxLQUFLLE1BQU0sT0FBTyxPQUFPO0FBQUEsRUFDbEMsU0FBUyxPQUFPO0FBQ2QsVUFBTSxJQUFJLE1BQU0sbUJBQW1CLE9BQU8sSUFBSSxLQUFLLEVBQUUsT0FBTyxNQUFNLENBQUM7QUFBQSxFQUNyRTtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/// <reference path="../library.d.cts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* The `.obsidian/app.json` settings `obsidian-dev-utils` owns in every demo vault.
|
|
6
|
+
*
|
|
7
|
+
* A demo vault is documentation first and an editing surface second, so four Obsidian settings have to be
|
|
8
|
+
* the same in every one of them. They are **not** committed: a vault that wrote them itself would drift
|
|
9
|
+
* (measured 2026-08-13, only 3 of 23 vaults had the first pair and 1 of 23 the second), so this package
|
|
10
|
+
* owns them instead — {@link archivePluginDemoVault} merges them into the `app.json` of the archived copy
|
|
11
|
+
* at release time, and the demo-vault coverage suite fails a vault that commits any of them.
|
|
12
|
+
*
|
|
13
|
+
* - `defaultViewMode: 'preview'` + `livePreview: false` — a note opens as a reader sees it rather than as
|
|
14
|
+
* raw markup. Obsidian-only: GitHub never reads `app.json` and renders every note as HTML regardless.
|
|
15
|
+
* - `useMarkdownLinks: true` + `newLinkFormat: 'relative'` — what Obsidian writes when a link is created
|
|
16
|
+
* inside the vault. Left at Obsidian's defaults (`false` / `'shortest'`) every new link comes out as a
|
|
17
|
+
* shortest-path `[[wikilink]]`, the form the coverage suite rejects and GitHub renders as literal
|
|
18
|
+
* brackets. `relative` rather than `absolute` so notes keep resolving once the vault is extracted to an
|
|
19
|
+
* arbitrary folder.
|
|
20
|
+
*
|
|
21
|
+
* All four are written explicitly, never left to an Obsidian default: a vault leaning on a default changes
|
|
22
|
+
* behavior when that default does.
|
|
23
|
+
*
|
|
24
|
+
* Kept free of both `vitest` and `adm-zip` on purpose — the coverage suite pulls in the former and the
|
|
25
|
+
* archiver the latter, and neither may reach the other's environment.
|
|
26
|
+
*/
|
|
27
|
+
/**
|
|
28
|
+
* Parameters for {@link buildArchivedDemoVaultAppJsonContent}.
|
|
29
|
+
*/
|
|
30
|
+
export interface BuildArchivedDemoVaultAppJsonContentParams {
|
|
31
|
+
/**
|
|
32
|
+
* The demo vault's committed `app.json`, parsed by {@link parseDemoVaultAppJson}.
|
|
33
|
+
*/
|
|
34
|
+
readonly appJson: DemoVaultAppJson;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* A parsed `.obsidian/app.json`. Only the settings in {@link DEMO_VAULT_APP_JSON_SETTINGS} are interpreted;
|
|
38
|
+
* every other setting is carried through untouched.
|
|
39
|
+
*/
|
|
40
|
+
export type DemoVaultAppJson = Record<string, unknown>;
|
|
41
|
+
/**
|
|
42
|
+
* Parameters for {@link findOwnedDemoVaultAppJsonSettings}.
|
|
43
|
+
*/
|
|
44
|
+
export interface FindOwnedDemoVaultAppJsonSettingsParams {
|
|
45
|
+
/**
|
|
46
|
+
* The demo vault's committed `app.json`, parsed by {@link parseDemoVaultAppJson}.
|
|
47
|
+
*/
|
|
48
|
+
readonly appJson: DemoVaultAppJson;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Parameters for {@link parseDemoVaultAppJson}.
|
|
52
|
+
*/
|
|
53
|
+
export interface ParseDemoVaultAppJsonParams {
|
|
54
|
+
/**
|
|
55
|
+
* The raw file content, or `null` when the vault commits no `app.json` at all — which is the expected
|
|
56
|
+
* state for a vault that has nothing else to configure.
|
|
57
|
+
*/
|
|
58
|
+
readonly content: null | string;
|
|
59
|
+
/**
|
|
60
|
+
* The path the content was read from, named in the error when it does not parse.
|
|
61
|
+
*/
|
|
62
|
+
readonly path: string;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* The `.obsidian/app.json` settings this package writes into every archived demo vault, and that a demo
|
|
66
|
+
* vault must therefore never commit. See the file overview for what each one buys.
|
|
67
|
+
*/
|
|
68
|
+
export declare const DEMO_VAULT_APP_JSON_SETTINGS: DemoVaultAppJson;
|
|
69
|
+
/**
|
|
70
|
+
* Builds the `app.json` content for the archived copy of a demo vault: the committed settings with the
|
|
71
|
+
* owned ones merged over them.
|
|
72
|
+
*
|
|
73
|
+
* @param params - The parameters for the build.
|
|
74
|
+
* @returns The JSON text to store as the archive's `.obsidian/app.json`.
|
|
75
|
+
*/
|
|
76
|
+
export declare function buildArchivedDemoVaultAppJsonContent(params: BuildArchivedDemoVaultAppJsonContentParams): string;
|
|
77
|
+
/**
|
|
78
|
+
* Finds the owned settings a demo vault has committed. They belong to this package, which injects them at
|
|
79
|
+
* release time, so a committed one is drift waiting to happen rather than a local preference.
|
|
80
|
+
*
|
|
81
|
+
* @param params - The parameters for the lookup.
|
|
82
|
+
* @returns The names of the owned settings present in the committed `app.json`, in the order they are
|
|
83
|
+
* declared in {@link DEMO_VAULT_APP_JSON_SETTINGS}.
|
|
84
|
+
*/
|
|
85
|
+
export declare function findOwnedDemoVaultAppJsonSettings(params: FindOwnedDemoVaultAppJsonSettingsParams): string[];
|
|
86
|
+
/**
|
|
87
|
+
* Parses a demo vault's committed `app.json`.
|
|
88
|
+
*
|
|
89
|
+
* @param params - The parameters for the parse.
|
|
90
|
+
* @returns The parsed settings, or an empty object when the vault commits no `app.json`.
|
|
91
|
+
* @throws When the content is not valid JSON, naming the file it came from.
|
|
92
|
+
*/
|
|
93
|
+
export declare function parseDemoVaultAppJson(params: ParseDemoVaultAppJsonParams): DemoVaultAppJson;
|