obsidian-dev-utils 51.0.1 → 51.1.6
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 +30 -0
- package/dist/lib/cjs/async.cjs +2 -2
- package/dist/lib/cjs/blob.cjs +2 -2
- package/dist/lib/cjs/debug.cjs +7 -8
- package/dist/lib/cjs/library.cjs +1 -1
- package/dist/lib/cjs/object-utils.cjs +23 -23
- package/dist/lib/cjs/obsidian/app.cjs +4 -3
- package/dist/lib/cjs/obsidian/components/setting-components/multiple-file-component.cjs +3 -2
- package/dist/lib/cjs/obsidian/components/setting-components/typed-text-component.cjs +1 -1
- package/dist/lib/cjs/obsidian/components/setting-components/validator-component.cjs +2 -2
- package/dist/lib/cjs/obsidian/constructors/getDomEventsHandlersConstructor.cjs +1 -1
- package/dist/lib/cjs/obsidian/constructors/getDomEventsHandlersConstructor.d.cts +3 -1
- package/dist/lib/cjs/obsidian/dataview-link.cjs +1 -1
- package/dist/lib/cjs/obsidian/dataview-link.d.cts +1 -1
- package/dist/lib/cjs/obsidian/file-change.cjs +1 -1
- package/dist/lib/cjs/obsidian/file-system.cjs +2 -2
- package/dist/lib/cjs/obsidian/i18n/custom-type-options-base.cjs +1 -1
- package/dist/lib/cjs/obsidian/i18n/custom-type-options-base.d.cts +12 -6
- package/dist/lib/cjs/obsidian/index.cjs +4 -1
- package/dist/lib/cjs/obsidian/index.d.cts +1 -0
- package/dist/lib/cjs/obsidian/is-in-obsidian.cjs +143 -0
- package/dist/lib/cjs/obsidian/is-in-obsidian.d.cts +11 -0
- package/dist/lib/cjs/obsidian/link.cjs +37 -37
- package/dist/lib/cjs/obsidian/markdown.cjs +1 -1
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.cjs +2 -2
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.d.cts +1 -1
- package/dist/lib/cjs/obsidian/plugin/path-settings.cjs +4 -5
- package/dist/lib/cjs/obsidian/plugin/plugin-settings-manager-base.cjs +2 -2
- package/dist/lib/cjs/obsidian/rename-delete-handler.cjs +2 -2
- package/dist/lib/cjs/obsidian/resource-url.cjs +3 -2
- package/dist/lib/cjs/obsidian/vault.cjs +2 -2
- package/dist/lib/cjs/reg-exp.cjs +5 -6
- package/dist/lib/cjs/script-utils/build.cjs +5 -5
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/changeExtensionPlugin.cjs +3 -3
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/copyToObsidianPluginsFolderPlugin.cjs +12 -11
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/dependency.cjs +4 -4
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/fixSourceMapsPlugin.cjs +6 -5
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/obsidian-plugin-builder.cjs +15 -12
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/preprocessPlugin.cjs +3 -3
- package/dist/lib/cjs/script-utils/bundlers/esbuild-impl/renameCssPlugin.cjs +5 -4
- package/dist/lib/cjs/script-utils/bundlers/esbuild.cjs +1 -1
- package/dist/lib/cjs/script-utils/cli-utils.cjs +14 -4
- package/dist/lib/cjs/script-utils/code-generator.cjs +3 -3
- package/dist/lib/cjs/script-utils/commitlint-config.cjs +134 -0
- package/dist/lib/cjs/script-utils/commitlint-config.d.cts +10 -0
- package/dist/lib/cjs/script-utils/exec.cjs +99 -10
- package/dist/lib/cjs/script-utils/exec.d.cts +35 -6
- package/dist/lib/cjs/script-utils/formatters/dprint.cjs +8 -6
- package/dist/lib/cjs/script-utils/formatters/dprint.d.cts +15 -2
- package/dist/lib/cjs/script-utils/fs.cjs +8 -11
- package/dist/lib/cjs/script-utils/fs.d.cts +1 -1
- package/dist/lib/cjs/script-utils/index.cjs +7 -4
- package/dist/lib/cjs/script-utils/index.d.cts +2 -1
- package/dist/lib/cjs/script-utils/json.cjs +9 -8
- package/dist/lib/cjs/script-utils/linters/cspell.cjs +5 -3
- package/dist/lib/cjs/script-utils/linters/cspell.d.cts +14 -1
- package/dist/lib/cjs/script-utils/linters/eslint-config.cjs +32 -20
- package/dist/lib/cjs/script-utils/linters/eslint-rules/index.cjs +142 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/index.d.cts +1 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/no-used-underscore-params.cjs +174 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/no-used-underscore-params.d.cts +12 -0
- package/dist/lib/cjs/script-utils/linters/eslint-types/@types/@eslint-community__eslint-plugin-eslint-comments__configs.d.cts +4 -2
- package/dist/lib/cjs/script-utils/linters/eslint.cjs +9 -6
- package/dist/lib/cjs/script-utils/linters/eslint.d.cts +15 -2
- package/dist/lib/cjs/script-utils/linters/index.cjs +4 -1
- package/dist/lib/cjs/script-utils/linters/index.d.cts +1 -0
- package/dist/lib/cjs/script-utils/linters/markdownlint.cjs +13 -10
- package/dist/lib/cjs/script-utils/linters/markdownlint.d.cts +15 -2
- package/dist/lib/cjs/script-utils/nano-staged-config.cjs +143 -0
- package/dist/lib/cjs/script-utils/nano-staged-config.d.cts +14 -0
- package/dist/lib/cjs/script-utils/npm-publish.cjs +16 -5
- package/dist/lib/cjs/script-utils/obsidian-dev-utils-repo-paths.cjs +2 -1
- package/dist/lib/cjs/script-utils/obsidian-dev-utils-repo-paths.d.cts +2 -0
- package/dist/lib/cjs/script-utils/root.cjs +3 -3
- package/dist/lib/cjs/script-utils/root.d.cts +3 -7
- package/dist/lib/cjs/script-utils/test-runners/vitest.cjs +6 -3
- package/dist/lib/cjs/script-utils/test-runners/vitest.d.cts +12 -1
- package/dist/lib/cjs/script-utils/version.cjs +22 -31
- package/dist/lib/cjs/string.cjs +4 -13
- package/dist/lib/cjs/string.d.cts +2 -2
- package/dist/lib/cjs/type-guards.cjs +8 -1
- package/dist/lib/cjs/type-guards.d.cts +11 -1
- package/dist/lib/esm/async.mjs +6 -3
- package/dist/lib/esm/blob.mjs +2 -2
- package/dist/lib/esm/debug.mjs +5 -6
- package/dist/lib/esm/library.mjs +1 -1
- package/dist/lib/esm/object-utils.mjs +24 -23
- package/dist/lib/esm/obsidian/app.mjs +4 -3
- package/dist/lib/esm/obsidian/components/setting-components/multiple-file-component.mjs +3 -2
- package/dist/lib/esm/obsidian/components/setting-components/typed-text-component.mjs +1 -1
- package/dist/lib/esm/obsidian/components/setting-components/validator-component.mjs +2 -2
- package/dist/lib/esm/obsidian/constructors/getDomEventsHandlersConstructor.d.mts +3 -1
- package/dist/lib/esm/obsidian/constructors/getDomEventsHandlersConstructor.mjs +1 -1
- package/dist/lib/esm/obsidian/dataview-link.d.mts +1 -1
- package/dist/lib/esm/obsidian/dataview-link.mjs +1 -1
- package/dist/lib/esm/obsidian/file-change.mjs +1 -1
- package/dist/lib/esm/obsidian/file-system.mjs +3 -2
- package/dist/lib/esm/obsidian/i18n/custom-type-options-base.d.mts +12 -6
- package/dist/lib/esm/obsidian/i18n/custom-type-options-base.mjs +1 -1
- package/dist/lib/esm/obsidian/index.d.mts +1 -0
- package/dist/lib/esm/obsidian/index.mjs +3 -1
- package/dist/lib/esm/obsidian/is-in-obsidian.d.mts +11 -0
- package/dist/lib/esm/obsidian/is-in-obsidian.mjs +39 -0
- package/dist/lib/esm/obsidian/link.mjs +38 -41
- package/dist/lib/esm/obsidian/markdown.mjs +1 -1
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.d.mts +1 -1
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.mjs +2 -2
- package/dist/lib/esm/obsidian/plugin/path-settings.mjs +4 -5
- package/dist/lib/esm/obsidian/plugin/plugin-settings-manager-base.mjs +3 -2
- package/dist/lib/esm/obsidian/rename-delete-handler.mjs +6 -3
- package/dist/lib/esm/obsidian/resource-url.mjs +3 -2
- package/dist/lib/esm/obsidian/vault.mjs +3 -2
- package/dist/lib/esm/reg-exp.mjs +5 -6
- package/dist/lib/esm/script-utils/build.mjs +6 -6
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/changeExtensionPlugin.mjs +2 -2
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/copyToObsidianPluginsFolderPlugin.mjs +8 -8
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/dependency.mjs +5 -5
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/fixSourceMapsPlugin.mjs +5 -5
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/obsidian-plugin-builder.mjs +10 -11
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/preprocessPlugin.mjs +2 -2
- package/dist/lib/esm/script-utils/bundlers/esbuild-impl/renameCssPlugin.mjs +3 -5
- package/dist/lib/esm/script-utils/bundlers/esbuild.mjs +1 -1
- package/dist/lib/esm/script-utils/cli-utils.mjs +2 -2
- package/dist/lib/esm/script-utils/code-generator.mjs +2 -2
- package/dist/lib/esm/script-utils/commitlint-config.d.mts +10 -0
- package/dist/lib/esm/script-utils/commitlint-config.mjs +28 -0
- package/dist/lib/esm/script-utils/exec.d.mts +35 -6
- package/dist/lib/esm/script-utils/exec.mjs +84 -8
- package/dist/lib/esm/script-utils/formatters/dprint.d.mts +15 -2
- package/dist/lib/esm/script-utils/formatters/dprint.mjs +6 -4
- package/dist/lib/esm/script-utils/fs.d.mts +1 -1
- package/dist/lib/esm/script-utils/fs.mjs +5 -8
- package/dist/lib/esm/script-utils/index.d.mts +2 -1
- package/dist/lib/esm/script-utils/index.mjs +5 -3
- package/dist/lib/esm/script-utils/json.mjs +7 -5
- package/dist/lib/esm/script-utils/linters/cspell.d.mts +14 -1
- package/dist/lib/esm/script-utils/linters/cspell.mjs +5 -3
- package/dist/lib/esm/script-utils/linters/eslint-config.mjs +32 -20
- package/dist/lib/esm/script-utils/linters/eslint-rules/index.d.mts +1 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/index.mjs +26 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/no-used-underscore-params.d.mts +12 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/no-used-underscore-params.mjs +68 -0
- package/dist/lib/esm/script-utils/linters/eslint-types/@types/@eslint-community__eslint-plugin-eslint-comments__configs.d.mts +4 -2
- package/dist/lib/esm/script-utils/linters/eslint.d.mts +15 -2
- package/dist/lib/esm/script-utils/linters/eslint.mjs +7 -7
- package/dist/lib/esm/script-utils/linters/index.d.mts +1 -0
- package/dist/lib/esm/script-utils/linters/index.mjs +3 -1
- package/dist/lib/esm/script-utils/linters/markdownlint.d.mts +15 -2
- package/dist/lib/esm/script-utils/linters/markdownlint.mjs +13 -11
- package/dist/lib/esm/script-utils/nano-staged-config.d.mts +14 -0
- package/dist/lib/esm/script-utils/nano-staged-config.mjs +37 -0
- package/dist/lib/esm/script-utils/npm-publish.mjs +3 -6
- package/dist/lib/esm/script-utils/obsidian-dev-utils-repo-paths.d.mts +2 -0
- package/dist/lib/esm/script-utils/obsidian-dev-utils-repo-paths.mjs +2 -1
- package/dist/lib/esm/script-utils/root.d.mts +3 -7
- package/dist/lib/esm/script-utils/root.mjs +2 -2
- package/dist/lib/esm/script-utils/test-runners/vitest.d.mts +12 -1
- package/dist/lib/esm/script-utils/test-runners/vitest.mjs +6 -3
- package/dist/lib/esm/script-utils/version.mjs +16 -27
- package/dist/lib/esm/string.d.mts +2 -2
- package/dist/lib/esm/string.mjs +7 -13
- package/dist/lib/esm/type-guards.d.mts +11 -1
- package/dist/lib/esm/type-guards.mjs +7 -1
- package/dist/scripts/build/build-clean.ts +4 -0
- package/dist/scripts/build/build-compile-svelte.ts +4 -0
- package/dist/scripts/build/build-compile-typescript.ts +4 -0
- package/dist/scripts/build/build-compile.ts +4 -0
- package/dist/scripts/build/build-static.ts +4 -0
- package/dist/scripts/bundlers/esbuild/build.ts +4 -0
- package/dist/scripts/bundlers/esbuild/dev.ts +4 -0
- package/dist/scripts/formatters/dprint/format-check.ts +8 -0
- package/dist/scripts/formatters/dprint/format.ts +8 -0
- package/dist/scripts/linters/cspell/spellcheck.ts +8 -0
- package/dist/scripts/linters/eslint/lint-fix.ts +8 -0
- package/dist/scripts/linters/eslint/lint.ts +8 -0
- package/dist/scripts/linters/markdownlint/lint-md-fix.ts +8 -0
- package/dist/scripts/linters/markdownlint/lint-md.ts +8 -0
- package/dist/scripts/test-runners/vitest/test-coverage.ts +4 -0
- package/dist/scripts/test-runners/vitest/test-watch.ts +4 -0
- package/dist/scripts/test-runners/vitest/test.ts +4 -0
- package/dist/scripts/version/version.ts +7 -0
- package/obsidian/is-in-obsidian/package.json +6 -0
- package/package.json +30 -4
- package/script-utils/commitlint-config/package.json +6 -0
- package/script-utils/linters/eslint-rules/index/package.json +6 -0
- package/script-utils/linters/eslint-rules/no-used-underscore-params/package.json +6 -0
- package/script-utils/linters/eslint-rules/package.json +6 -0
- package/script-utils/nano-staged-config/package.json +6 -0
- package/dist/lib/cjs/script-utils/linters/eslint-types/@types/@guardian__eslint-plugin-tsdoc-required.d.cts +0 -14
- package/dist/lib/cjs/script-utils/node-modules.cjs +0 -207
- package/dist/lib/cjs/script-utils/node-modules.d.cts +0 -17
- package/dist/lib/esm/script-utils/linters/eslint-types/@types/@guardian__eslint-plugin-tsdoc-required.d.mts +0 -14
- package/dist/lib/esm/script-utils/node-modules.d.mts +0 -17
- package/dist/lib/esm/script-utils/node-modules.mjs +0 -92
- package/dist/scripts/default/build-clean.ts +0 -5
- package/dist/scripts/default/build-compile-svelte.ts +0 -5
- package/dist/scripts/default/build-compile-typescript.ts +0 -5
- package/dist/scripts/default/build-compile.ts +0 -5
- package/dist/scripts/default/build-static.ts +0 -5
- package/dist/scripts/default/build.ts +0 -9
- package/dist/scripts/default/dev.ts +0 -10
- package/dist/scripts/default/format-check.ts +0 -5
- package/dist/scripts/default/format.ts +0 -5
- package/dist/scripts/default/lint-fix.ts +0 -5
- package/dist/scripts/default/lint.ts +0 -5
- package/dist/scripts/default/publish.ts +0 -5
- package/dist/scripts/default/spellcheck.ts +0 -5
- package/dist/scripts/default/version.ts +0 -5
- package/dist/scripts/examples/build.customPlugin.ts +0 -38
- package/dist/scripts/examples/build.svelteConditions.ts +0 -18
- package/dist/scripts/examples/eslint.config.extend.mts +0 -14
- package/dist/scripts/examples/eslint.config.no-dev-utils.mts +0 -15
- package/dist/scripts/examples/format.prettier.ts +0 -25
- package/script-utils/linters/eslint-types/@types/@guardian__eslint-plugin-tsdoc-required/package.json +0 -4
- package/script-utils/node-modules/package.json +0 -6
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
OnLoadResult,
|
|
3
|
-
Plugin
|
|
4
|
-
} from 'esbuild';
|
|
5
|
-
import {
|
|
6
|
-
BuildMode,
|
|
7
|
-
buildObsidianPlugin
|
|
8
|
-
} from 'obsidian-dev-utils/script-utils/bundlers/esbuild/obsidian-plugin-builder';
|
|
9
|
-
import type { CliTaskResult } from 'obsidian-dev-utils/script-utils/cli-utils';
|
|
10
|
-
import { readFile } from 'obsidian-dev-utils/script-utils/node-modules';
|
|
11
|
-
|
|
12
|
-
export async function invoke(): Promise<CliTaskResult> {
|
|
13
|
-
return await buildWithCustomPlugin();
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
export async function buildWithCustomPlugin(): Promise<CliTaskResult> {
|
|
17
|
-
return await buildObsidianPlugin({
|
|
18
|
-
mode: BuildMode.Production,
|
|
19
|
-
customEsbuildPlugins: [
|
|
20
|
-
customPlugin()
|
|
21
|
-
]
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
function customPlugin(): Plugin {
|
|
26
|
-
return {
|
|
27
|
-
name: 'custom-plugin',
|
|
28
|
-
setup(build): void {
|
|
29
|
-
build.onLoad({ filter: /\.png$/ }, async (args): Promise<OnLoadResult> => {
|
|
30
|
-
const contents = await readFile(args.path);
|
|
31
|
-
return {
|
|
32
|
-
loader: 'dataurl',
|
|
33
|
-
contents
|
|
34
|
-
};
|
|
35
|
-
});
|
|
36
|
-
}
|
|
37
|
-
};
|
|
38
|
-
}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
BuildMode,
|
|
3
|
-
buildObsidianPlugin
|
|
4
|
-
} from 'obsidian-dev-utils/script-utils/bundlers/esbuild/obsidian-plugin-builder';
|
|
5
|
-
import type { CliTaskResult } from 'obsidian-dev-utils/script-utils/cli-utils';
|
|
6
|
-
|
|
7
|
-
export async function invoke(): Promise<CliTaskResult> {
|
|
8
|
-
return await buildWithSvelteConditions();
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
export async function buildWithSvelteConditions(): Promise<CliTaskResult> {
|
|
12
|
-
return await buildObsidianPlugin({
|
|
13
|
-
mode: BuildMode.Production,
|
|
14
|
-
customizeEsbuildOptions: (buildOptions) => {
|
|
15
|
-
buildOptions.conditions = [...(buildOptions.conditions ?? []), 'svelte'];
|
|
16
|
-
}
|
|
17
|
-
});
|
|
18
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { Linter } from 'eslint';
|
|
2
|
-
import { obsidianDevUtilsConfigs } from 'obsidian-dev-utils/script-utils/eslint/eslint.config';
|
|
3
|
-
|
|
4
|
-
const configs: Linter.Config[] = [
|
|
5
|
-
...obsidianDevUtilsConfigs,
|
|
6
|
-
{
|
|
7
|
-
rules: {
|
|
8
|
-
'@typescript-eslint/explicit-function-return-type': 'off'
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
];
|
|
12
|
-
|
|
13
|
-
// eslint-disable-next-line import-x/no-default-export -- ESLint infrastructure requires a default export.
|
|
14
|
-
export default configs;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { Linter } from 'eslint';
|
|
2
|
-
|
|
3
|
-
const configs: Linter.Config[] = [
|
|
4
|
-
{
|
|
5
|
-
files: [
|
|
6
|
-
'**/*.ts'
|
|
7
|
-
],
|
|
8
|
-
rules: {
|
|
9
|
-
'no-console': 'error'
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
];
|
|
13
|
-
|
|
14
|
-
// eslint-disable-next-line import-x/no-default-export -- ESLint infrastructure requires a default export.
|
|
15
|
-
export default configs;
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { assertNonNullable } from 'obsidian-dev-utils/object-utils';
|
|
2
|
-
import { getFolderName } from 'obsidian-dev-utils/path';
|
|
3
|
-
import { existsSync } from 'obsidian-dev-utils/script-utils/node-modules';
|
|
4
|
-
import {
|
|
5
|
-
execFromRoot,
|
|
6
|
-
getRootFolder,
|
|
7
|
-
resolvePathFromRootSafe
|
|
8
|
-
} from 'obsidian-dev-utils/script-utils/root';
|
|
9
|
-
|
|
10
|
-
export async function invoke(): Promise<void> {
|
|
11
|
-
await formatWithPrettier(true);
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export async function formatWithPrettier(rewrite: boolean): Promise<void> {
|
|
15
|
-
const PRETTIER_CONFIG_FILE_NAME = '.prettierrc.json';
|
|
16
|
-
const prettierJsonPath = resolvePathFromRootSafe(PRETTIER_CONFIG_FILE_NAME);
|
|
17
|
-
if (!existsSync(prettierJsonPath)) {
|
|
18
|
-
const packageFolder = getRootFolder(getFolderName(import.meta.url));
|
|
19
|
-
assertNonNullable(packageFolder, () => 'Could not find package folder.');
|
|
20
|
-
throw new Error(`${PRETTIER_CONFIG_FILE_NAME} not found`);
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
const command = rewrite ? '--write' : '--check';
|
|
24
|
-
await execFromRoot(['npx', 'prettier', '.', command]);
|
|
25
|
-
}
|