obsidian-dev-utils 77.1.0 → 78.1.0

package/dist/lib/esm/obsidian/view-registrar.mjs

@@ -35,14 +35,13 @@ class PluginViewRegistrar {
   /**
    * Registers a view type with a view creator.
    *
-   * @param type - The view type to register.
-   * @param viewCreator - The view creator function that creates a view instance for the given type.
+   * @param params - The parameters for the view registration.
    */
-  registerView(type, viewCreator) {
-    this.plugin.registerView(type, viewCreator);
+  registerView(params) {
+    this.plugin.registerView(params.type, params.viewCreator);
   }
 }
 export {
   PluginViewRegistrar
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL3ZpZXctcmVnaXN0cmFyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVGhpcyBmaWxlIGRlZmluZXMgdGhlIHtAbGluayBWaWV3UmVnaXN0cmFyfSBpbnRlcmZhY2UgYW5kIHRoZSB7QGxpbmsgUGx1Z2luVmlld1JlZ2lzdHJhcn0gY2xhc3MuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBWaWV3Q3JlYXRvciB9IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHsgUGx1Z2luIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG4vKipcbiAqIEEgcmVnaXN0cmFyIGZvciB2aWV3cy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBWaWV3UmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIHZpZXcgdHlwZSB3aXRoIGEgdmlldyBjcmVhdG9yLlxuICAgKlxuICAgKiBAcGFyYW0gdHlwZSAtIFRoZSB2aWV3IHR5cGUgdG8gcmVnaXN0ZXIuXG4gICAqIEBwYXJhbSB2aWV3Q3JlYXRvciAtIFRoZSB2aWV3IGNyZWF0b3IgZnVuY3Rpb24gdGhhdCBjcmVhdGVzIGEgdmlldyBpbnN0YW5jZSBmb3IgdGhlIGdpdmVuIHR5cGUuXG4gICAqL1xuICByZWdpc3RlclZpZXcodHlwZTogc3RyaW5nLCB2aWV3Q3JlYXRvcjogVmlld0NyZWF0b3IpOiB2b2lkO1xufVxuXG4vKipcbiAqIEEgcmVnaXN0cmFyIGZvciB2aWV3cyB0aGF0IHJlZ2lzdGVycyB2aWV3cyB3aXRoIGEgcGx1Z2luLlxuICovXG5leHBvcnQgY2xhc3MgUGx1Z2luVmlld1JlZ2lzdHJhciBpbXBsZW1lbnRzIFZpZXdSZWdpc3RyYXIge1xuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBpbnN0YW5jZSBvZiB0aGUge0BsaW5rIFBsdWdpblZpZXdSZWdpc3RyYXJ9IGNsYXNzLlxuICAgKlxuICAgKiBAcGFyYW0gcGx1Z2luIC0gVGhlIE9ic2lkaWFuIHBsdWdpbiBpbnN0YW5jZSB1c2VkIHRvIHJlZ2lzdGVyIHZpZXdzLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKHByaXZhdGUgcmVhZG9ubHkgcGx1Z2luOiBQbHVnaW4pIHtcbiAgfVxuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSB2aWV3IHR5cGUgd2l0aCBhIHZpZXcgY3JlYXRvci5cbiAgICpcbiAgICogQHBhcmFtIHR5cGUgLSBUaGUgdmlldyB0eXBlIHRvIHJlZ2lzdGVyLlxuICAgKiBAcGFyYW0gdmlld0NyZWF0b3IgLSBUaGUgdmlldyBjcmVhdG9yIGZ1bmN0aW9uIHRoYXQgY3JlYXRlcyBhIHZpZXcgaW5zdGFuY2UgZm9yIHRoZSBnaXZlbiB0eXBlLlxuICAgKi9cbiAgcHVibGljIHJlZ2lzdGVyVmlldyh0eXBlOiBzdHJpbmcsIHZpZXdDcmVhdG9yOiBWaWV3Q3JlYXRvcik6IHZvaWQge1xuICAgIHRoaXMucGx1Z2luLnJlZ2lzdGVyVmlldyh0eXBlLCB2aWV3Q3JlYXRvcik7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBUUEsU0FBUyxjQUFjO0FBa0JoQixNQUFNLG9CQUE2QztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU1qRCxZQUE2QixRQUFnQjtBQUFoQjtBQUFBLEVBQ3BDO0FBQUEsRUFEb0M7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVM3QixhQUFhLE1BQWMsYUFBZ0M7QUFDaEUsU0FBSyxPQUFPLGFBQWEsTUFBTSxXQUFXO0FBQUEsRUFDNUM7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL3ZpZXctcmVnaXN0cmFyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVGhpcyBmaWxlIGRlZmluZXMgdGhlIHtAbGluayBWaWV3UmVnaXN0cmFyfSBpbnRlcmZhY2UgYW5kIHRoZSB7QGxpbmsgUGx1Z2luVmlld1JlZ2lzdHJhcn0gY2xhc3MuXG4gKi9cblxuaW1wb3J0IHR5cGUge1xuICBWaWV3LFxuICBXb3Jrc3BhY2VMZWFmXG59IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHsgUGx1Z2luIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG4vKipcbiAqIEEgcmVnaXN0cmFyIGZvciB2aWV3cy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBWaWV3UmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIHZpZXcgdHlwZSB3aXRoIGEgdmlldyBjcmVhdG9yLlxuICAgKlxuICAgKiBAcGFyYW0gcGFyYW1zIC0gVGhlIHBhcmFtZXRlcnMgZm9yIHRoZSB2aWV3IHJlZ2lzdHJhdGlvbi5cbiAgICovXG4gIHJlZ2lzdGVyVmlldyhwYXJhbXM6IFBsdWdpblZpZXdSZWdpc3RyYXJSZWdpc3RlclZpZXdQYXJhbXMpOiB2b2lkO1xufVxuXG50eXBlIFBsdWdpblZpZXdSZWdpc3RyYXJSZWdpc3RlclZpZXdQYXJhbXMgPSBWaWV3UmVnaXN0cmFyUmVnaXN0ZXJWaWV3UGFyYW1zO1xuXG5pbnRlcmZhY2UgVmlld1JlZ2lzdHJhclJlZ2lzdGVyVmlld1BhcmFtcyB7XG4gIC8qKlxuICAgKiBUaGUgdHlwZSBvZiB0aGUgdmlldyB0byByZWdpc3Rlci5cbiAgICovXG4gIHJlYWRvbmx5IHR5cGU6IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHZpZXcgY3JlYXRvciBmdW5jdGlvbiB0aGF0IGNyZWF0ZXMgYSB2aWV3IGluc3RhbmNlIGZvciB0aGUgZ2l2ZW4gdHlwZS5cbiAgICpcbiAgICogQHBhcmFtIGxlYWYgLSBUaGUgd29ya3NwYWNlIGxlYWYgd2hlcmUgdGhlIHZpZXcgd2lsbCBiZSBjcmVhdGVkLlxuICAgKiBAcmV0dXJucyBUaGUgY3JlYXRlZCB2aWV3IGluc3RhbmNlLlxuICAgKi9cbiAgdmlld0NyZWF0b3IodGhpczogdm9pZCwgbGVhZjogV29ya3NwYWNlTGVhZik6IFZpZXc7XG59XG5cbi8qKlxuICogQSByZWdpc3RyYXIgZm9yIHZpZXdzIHRoYXQgcmVnaXN0ZXJzIHZpZXdzIHdpdGggYSBwbHVnaW4uXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5WaWV3UmVnaXN0cmFyIGltcGxlbWVudHMgVmlld1JlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IGluc3RhbmNlIG9mIHRoZSB7QGxpbmsgUGx1Z2luVmlld1JlZ2lzdHJhcn0gY2xhc3MuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgT2JzaWRpYW4gcGx1Z2luIGluc3RhbmNlIHVzZWQgdG8gcmVnaXN0ZXIgdmlld3MuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocHJpdmF0ZSByZWFkb25seSBwbHVnaW46IFBsdWdpbikge1xuICB9XG5cbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIHZpZXcgdHlwZSB3aXRoIGEgdmlldyBjcmVhdG9yLlxuICAgKlxuICAgKiBAcGFyYW0gcGFyYW1zIC0gVGhlIHBhcmFtZXRlcnMgZm9yIHRoZSB2aWV3IHJlZ2lzdHJhdGlvbi5cbiAgICovXG4gIHB1YmxpYyByZWdpc3RlclZpZXcocGFyYW1zOiBQbHVnaW5WaWV3UmVnaXN0cmFyUmVnaXN0ZXJWaWV3UGFyYW1zKTogdm9pZCB7XG4gICAgdGhpcy5wbHVnaW4ucmVnaXN0ZXJWaWV3KHBhcmFtcy50eXBlLCBwYXJhbXMudmlld0NyZWF0b3IpO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVdBLFNBQVMsY0FBYztBQWtDaEIsTUFBTSxvQkFBNkM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFNakQsWUFBNkIsUUFBZ0I7QUFBaEI7QUFBQSxFQUNwQztBQUFBLEVBRG9DO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUTdCLGFBQWEsUUFBcUQ7QUFDdkUsU0FBSyxPQUFPLGFBQWEsT0FBTyxNQUFNLE9BQU8sV0FBVztBQUFBLEVBQzFEO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/script-utils/linters/over-exposure.d.mts

@@ -23,6 +23,13 @@
  * A member referenced only from test files is reported with {@link OverExposureFinding.isForcedByTestOnly}
  * set, surfacing members widened purely for testability — the canonical case for extracting logic
  * into an independently testable component instead.
+ *
+ * Beyond reporting, passing `shouldFix` to {@link findOverExposure} / {@link analyzeOverExposure}
+ * rewrites the source in place: dropping the `export` keyword, or replacing/inserting a `private`
+ * or `protected` modifier. Each finding then carries {@link OverExposureFinding.wasFixed} /
+ * {@link OverExposureFinding.skipReason}. Changes that cannot be safely automated — those forced
+ * only by test references, decorated members, or an `export` shared with a still-exported sibling —
+ * are reported as skipped and left untouched.
  */
 import type { CompilerOptions, LanguageService, LanguageServiceHost } from 'typescript';
 /**
@@ -37,12 +44,26 @@ export interface AnalyzeOverExposureParams {
      * appearing to hang.
      */
     onProgress?(this: void, progress: OverExposureProgress): void;
+    /**
+     * When `true`, each fixable finding is tightened in place via {@link writeFile} (which must then
+     * be provided), and the returned findings carry {@link OverExposureFinding.wasFixed} /
+     * {@link OverExposureFinding.skipReason}. When `false` or omitted, the analysis only reports.
+     */
+    readonly shouldFix?: boolean | undefined;
     /**
      * Absolute (canonical) path of the project's `src` folder. Only declarations in non-test files
      * under this folder are analyzed; declarations elsewhere (test files, dependencies) are ignored
      * but still counted as reference sites.
      */
     readonly srcFolder: string;
+    /**
+     * Writes the tightened contents of a changed file back to disk. Required when {@link shouldFix}
+     * is `true`; ignored otherwise.
+     *
+     * @param path - Absolute path of the file to write (original casing, as stored in the program).
+     * @param content - The full new file contents.
+     */
+    writeFile?(this: void, path: string, content: string): void;
 }
 /**
  * Parameters for {@link createLanguageServiceHost}.
@@ -77,6 +98,12 @@ export interface FindOverExposureParams {
     onProgress?(this: void, progress: OverExposureProgress): void;
     /** Absolute path to the project root (the folder containing `tsconfig.json` and `src`). */
     readonly projectFolder: string;
+    /**
+     * When `true`, fixable findings are tightened in place on disk (the `export` keyword is dropped,
+     * or a `private` / `protected` modifier is inserted/replaced). When `false` or omitted, the
+     * project is only analyzed.
+     */
+    readonly shouldFix?: boolean | undefined;
 }
 /**
  * Options for {@link formatOverExposureFindings}.
@@ -151,8 +178,15 @@ export interface OverExposureFinding {
     readonly line: number;
     /** The declared name. */
     readonly name: string;
+    /**
+     * In a fix run, why this finding was left untouched instead of tightened; `null` when it was
+     * fixed or when the analysis only reported (`shouldFix` off).
+     */
+    readonly skipReason: null | OverExposureSkipReason;
     /** The exposure the declaration could be tightened to. */
     readonly suggestedExposure: SuggestedExposure;
+    /** `true` when a fix run tightened this declaration in place. Always `false` in a report run. */
+    readonly wasFixed: boolean;
 }
 /**
  * Progress reported while analyzing a project, one event per analyzed source file.
@@ -165,6 +199,14 @@ export interface OverExposureProgress {
     /** Total number of source files that will be analyzed. */
     readonly totalFileCount: number;
 }
+/**
+ * Why a fix run left a finding untouched:
+ *
+ * - `decorated` — the member carries a decorator, so the modifier insertion point is ambiguous.
+ * - `shared-export` — the `export` keyword is shared with a still-exported sibling declarator.
+ * - `test-only` — the declaration is exposed purely for tests, so tightening would break the test.
+ */
+export type OverExposureSkipReason = 'decorated' | 'shared-export' | 'test-only';
 /**
  * The (tighter) exposure level a declaration could be reduced to.
  */
@@ -176,7 +218,11 @@ export type SuggestedExposure = 'file-local' | 'private' | 'protected';
  */
 export declare const LIFECYCLE_ALLOWLIST: ReadonlySet<string>;
 /**
- * Analyzes a project (already loaded into a language service) for over-exposed declarations.
+ * Analyzes a project (already loaded into a language service) for over-exposed declarations, and —
+ * when {@link AnalyzeOverExposureParams.shouldFix} is set — tightens every fixable finding in place
+ * via {@link AnalyzeOverExposureParams.writeFile}. Findings that cannot be safely automated (exposed
+ * only for tests, decorated, or sharing an `export` keyword with a still-exported sibling) carry a
+ * {@link OverExposureFinding.skipReason} and are left untouched.
  *
  * @param params - The {@link AnalyzeOverExposureParams}.
  * @returns The over-exposed declarations, in discovery order.
@@ -197,17 +243,24 @@ export declare function createLanguageServiceHost(params: CreateLanguageServiceH
  */
 export declare function createProjectLanguageService(params: CreateProjectLanguageServiceParams): LanguageService;
 /**
- * Finds over-exposed declarations in a project on disk.
+ * Finds over-exposed declarations in a project on disk. When
+ * {@link FindOverExposureParams.shouldFix} is set, each fixable finding is also tightened in place
+ * (rewriting the affected source files via `typescript`'s `sys.writeFile`).
  *
  * @param params - The {@link FindOverExposureParams}.
  * @returns The over-exposed declarations.
  */
 export declare function findOverExposure(params: FindOverExposureParams): OverExposureFinding[];
 /**
- * Formats over-exposure findings as a human-readable report. Findings are grouped by file and sorted
- * by line. Each finding spans two lines — a `path:line:column` location (which terminals such as VS
- * Code render as a clickable link that jumps to the declaration) followed by the suggested change and
- * its reason — separated from the next finding by a blank line.
+ * Formats over-exposure findings as a human-readable report, using the grouped layout of ESLint's
+ * `stylish` formatter. Findings are grouped by file and sorted by line: each file is rendered as a
+ * `path` header line, followed by one indented `  line:column  change -- reason` row per finding (the
+ * `line:column` is right-padded so the rows align within a file). Terminals such as VS Code render
+ * each indented `line:column` as a clickable link — resolved against the file header above it — that
+ * jumps straight to the declaration. File groups are separated by a blank line. In a fix run (findings
+ * carrying {@link OverExposureFinding.wasFixed} / {@link OverExposureFinding.skipReason}) each change
+ * row is suffixed with `[fixed]` or `[skipped: …]`, and the trailing summary appends the fixed/skipped
+ * counts.
  *
  * @param findings - The findings to format.
  * @param options - The {@link FormatOverExposureFindingsOptions}.