reactive-vscode 0.2.0-beta.6 → 0.2.0-beta.8

package/README.md

@@ -12,6 +12,17 @@
 - [**Why reactive-vscode**](https://kermanx.github.io/reactive-vscode/guide/why)
 - [**All Functions**](https://kermanx.github.io/reactive-vscode/functions/)
 
+### Project Status
+
+Currently, most of the VSCode APIs are covered, and this project has been used in:
+
+- [Slidev for VSCode <sub><sub>![downloads](https://img.shields.io/visual-studio-marketplace/d/antfu.slidev.svg)</sub></sub>](https://github.com/slidevjs/slidev/tree/main/packages/vscode)
+- [Iconify IntelliSense <sub><sub>![downloads](https://img.shields.io/visual-studio-marketplace/d/antfu.iconify.svg)</sub></sub>](https://github.com/antfu/vscode-iconify)
+
+The [documentation](https://kermanx.github.io/reactive-vscode/) is complete, and the [VueUse integration](https://kermanx.github.io/reactive-vscode/guide/vueuse.html) is also available.
+
+However, the project is still in beta and may have minor API changes. If you encounter any problems, please feel free to [open an issue](https://github.com/KermanX/reactive-vscode/issues/new).
+
 ### Counter Example
 
 ```ts
@@ -70,12 +81,14 @@ export function activate(extensionContext: ExtensionContext) {
 
 [More examples](https://kermanx.github.io/reactive-vscode/examples/).
 
-## License
+### License
 
 [MIT](./LICENSE) License © 2024-PRESENT [_Kerman](https://github.com/KermanX)
 
 Source code in [the `./packages/reactivity` directory](https://github.com/KermanX/reactive-vscode/blob/main/packages/core/src/reactivity) is ported from [`@vue/runtime-core`](https://github.com/vuejs/core/blob/main/packages/runtime-core). Licensed under a [MIT License](https://github.com/vueuse/vueuse/blob/main/LICENSE).
 
+Source code in [the `./packages/mock` directory](https://github.com/KermanX/reactive-vscode/blob/main/packages/core/src/mock) references the implementation of [`VSCode`](https://github.com/microsoft/vscode). Licensed under a [MIT License](https://github.com/microsoft/vscode/blob/main/LICENSE.txt).
+
 The logo <img src="https://kermanx.github.io/reactive-vscode/logo.svg" width="14"> is modified from [Vue Reactity Artworks](https://github.com/vue-reactivity/art). Licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
 
 Part of the docs website is ported from [VueUse](https://github.com/vueuse/vueuse). Licensed under a [MIT License](https://github.com/vueuse/vueuse/blob/main/LICENSE).

package/dist/index.d.ts

@@ -16,6 +16,7 @@ import { EventEmitter } from 'vscode';
 import { Extension } from 'vscode';
 import { ExtensionContext } from 'vscode';
 import { ExtensionTerminalOptions } from 'vscode';
+import { FileSystemWatcher } from 'vscode';
 import { FoldingRangeProvider } from 'vscode';
 import { GlobPattern } from 'vscode';
 import { LogLevel } from 'vscode';
@@ -24,6 +25,9 @@ import { MaybeRefOrGetter } from '@reactive-vscode/reactivity';
 import { NotebookEditor } from 'vscode';
 import { NotebookRange } from 'vscode';
 import { OutputChannel } from 'vscode';
+import { QuickInputButton } from 'vscode';
+import { QuickPickItem } from 'vscode';
+import { QuickPickItemButtonEvent } from 'vscode';
 import { Range } from 'vscode';
 import { Ref } from '@reactive-vscode/reactivity';
 import { Selection } from 'vscode';
@@ -46,6 +50,7 @@ import { TreeDataProvider } from 'vscode';
 import { TreeItem } from 'vscode';
 import { TreeView } from 'vscode';
 import { TreeViewOptions } from 'vscode';
+import { UnwrapNestedRefs } from '@reactive-vscode/reactivity';
 import { Uri } from 'vscode';
 import { ViewBadge } from 'vscode';
 import { ViewColumn } from 'vscode';
@@ -61,7 +66,7 @@ export declare interface Commands extends Record<string, (...args: any[]) => any
     'vscode.open': (uri: Uri) => void;
 }
 
-export declare type ConfigObject<C extends object> = ShallowReactive<C & {
+export declare type ConfigObject<C extends object> = UnwrapNestedRefs<C> & {
     /**
      * Write the configuration value to the workspace.
      *
@@ -72,7 +77,7 @@ export declare type ConfigObject<C extends object> = ShallowReactive<C & {
      * Set the value without updating the workspace.
      */
     $set: (key: keyof C, value: C[keyof C]) => void;
-}>;
+};
 
 export declare interface ConfigRef<T> extends WritableComputedRef<T> {
     /**
@@ -222,6 +227,80 @@ export declare type ParseConfigTypeOptions<C extends ConfigTypeOptions> = {
     -readonly [K in keyof C]: ParseConfigType<C[K]>;
 };
 
+export declare interface QuickPickOptions<T extends QuickPickItem> {
+    /**
+     * Items to pick from. This can be read and updated by the extension.
+     */
+    items?: MaybeRefOrGetter<readonly T[]>;
+    /**
+     * Buttons for actions in the UI.
+     */
+    buttons?: MaybeRefOrGetter<readonly QuickInputButton[]>;
+    /**
+     * An optional title.
+     */
+    title?: MaybeRefOrGetter<string | undefined>;
+    /**
+     * An optional current step count.
+     */
+    step?: MaybeRefOrGetter<number | undefined>;
+    /**
+     * An optional total step count.
+     */
+    totalSteps?: MaybeRefOrGetter<number | undefined>;
+    /**
+     * If the UI should allow for user input. Defaults to true.
+     *
+     * Change this to false, e.g., while validating user input or
+     * loading data for the next step in user input.
+     */
+    enabled?: MaybeRefOrGetter<boolean>;
+    /**
+     * If the UI should show a progress indicator. Defaults to false.
+     *
+     * Change this to true, e.g., while loading more data or validating
+     * user input.
+     */
+    busy?: MaybeRefOrGetter<boolean>;
+    /**
+     * If the UI should stay open even when loosing UI focus. Defaults to false.
+     * This setting is ignored on iPad and is always false.
+     */
+    ignoreFocusOut?: MaybeRefOrGetter<boolean>;
+    /**
+     * Optional placeholder shown in the filter textbox when no filter has been entered.
+     */
+    placeholder?: MaybeRefOrGetter<string | undefined>;
+    /**
+     * If multiple items can be selected at the same time. Defaults to false.
+     */
+    canSelectMany?: MaybeRefOrGetter<boolean>;
+    /**
+     * If the filter text should also be matched against the description of the items. Defaults to false.
+     */
+    matchOnDescription?: MaybeRefOrGetter<boolean>;
+    /**
+     * If the filter text should also be matched against the detail of the items. Defaults to false.
+     */
+    matchOnDetail?: MaybeRefOrGetter<boolean>;
+    /**
+     * An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.
+     */
+    keepScrollPosition?: MaybeRefOrGetter<boolean>;
+    /**
+     * Initial value of the filter text.
+     */
+    value?: string;
+    /**
+     * Initial active items. This can be read and updated by the extension.
+     */
+    activeItems?: readonly T[];
+    /**
+     * Initial selected items. This can be read and updated by the extension.
+     */
+    selectedItems?: readonly T[];
+}
+
 export declare type TextEditorCommandCallback = (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void;
 
 declare type ToConfigRefs<C extends object> = {
@@ -285,6 +364,7 @@ export declare const useActiveTextEditor: () => ShallowRef<TextEditor | undefine
 
 /**
  * @reactive `extensions.all`
+ * @category extension
  */
 export declare const useAllExtensions: () => ComputedRef<readonly Extension<any>[]>;
 
@@ -356,7 +436,7 @@ export declare function useEditorDecorations(editor: MaybeRefOrGetter<Nullable<T
  * @category utilities
  * @reactive `Event`
  */
-export declare function useEvent<T>(event: Event_2<T>, listeners?: ((e: T) => any)[]): Event_2<T>;
+export declare function useEvent<T>(event: Event_2<T>, listeners?: ((e: T) => any)[]): (listener: (e: T) => any, thisArgs?: any, disposables?: Disposable_2[]) => void;
 
 /**
  * @category utilities
@@ -372,6 +452,17 @@ declare interface UseEventEmitterReturn<T> {
     addListener: (listener: (e: T) => any) => void;
 }
 
+/**
+ * Get a reactive secret value from the extension's secrets.
+ *
+ * @reactive `ExtensionContext.secrets`
+ * @category extension
+ */
+export declare function useExtensionSecret(key: string): Promise<Ref<string | undefined> & {
+    set: (newValue: string) => Promise<void>;
+    remove: () => Promise<void>;
+}>;
+
 /**
  * @reactive `tasks.fetchTasks`
  */
@@ -404,17 +495,17 @@ toJSON(): any;
  */
 export declare function useFoldingRangeProvider(selector: DocumentSelector, provideFoldingRanges: MaybeRefOrGetter<FoldingRangeProvider['provideFoldingRanges']>): void;
 
+export declare interface UseFSWatcher {
+    readonly watchers: ShallowReactive<Map<GlobPattern, FileSystemWatcher>>;
+    readonly onDidCreate: Event_2<Uri>;
+    readonly onDidChange: Event_2<Uri>;
+    readonly onDidDelete: Event_2<Uri>;
+}
+
 /**
  * @reactive `workspace.createFileSystemWatcher`
  */
-export declare function useFsWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean | undefined, ignoreChangeEvents?: boolean | undefined, ignoreDeleteEvents?: boolean | undefined): {
-    onDidCreate: Event_2<Uri>;
-    onDidChange: Event_2<Uri>;
-    onDidDelete: Event_2<Uri>;
-    ignoreCreateEvents: boolean;
-    ignoreChangeEvents: boolean;
-    ignoreDeleteEvents: boolean;
-};
+export declare function useFsWatcher(globPattern: MaybeRefOrGetter<GlobPattern | GlobPattern[]>, ignoreCreateEvents?: MaybeNullableRefOrGetter<boolean>, ignoreChangeEvents?: MaybeNullableRefOrGetter<boolean>, ignoreDeleteEvents?: MaybeNullableRefOrGetter<boolean>): UseFSWatcher;
 
 /**
  * Determines if the current color theme is dark. See `vscode::ColorTheme.kind`.
@@ -497,6 +588,40 @@ export declare const useOpenedTerminals: () => ShallowRef<readonly Terminal[]>;
  */
 export declare function useOutputChannel(name: string, languageId?: string): OutputChannel;
 
+/**
+ * Creates a customizable quick pick UI.
+ *
+ * @reactive `window.createQuickPick`
+ */
+export declare function useQuickPick<T extends QuickPickItem>(options?: QuickPickOptions<T>): {
+    onDidChangeActive: (listener: (e: readonly T[]) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    onDidChangeSelection: (listener: (e: readonly T[]) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    onDidAccept: (listener: (e: void) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    onDidHide: (listener: (e: void) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    onDidTriggerButton: (listener: (e: QuickInputButton) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    onDidChangeValue: (listener: (e: string) => any, thisArgs?: any, disposables?: Disposable_2[] | undefined) => void;
+    value: ShallowRef<string>;
+    activeItems: ShallowRef<readonly T[]>;
+    selectedItems: ShallowRef<readonly T[]>;
+    placeholder: string | undefined;
+    buttons: readonly QuickInputButton[];
+    onDidTriggerItemButton: Event_2<QuickPickItemButtonEvent<T>>;
+    items: readonly T[];
+    canSelectMany: boolean;
+    matchOnDescription: boolean;
+    matchOnDetail: boolean;
+    keepScrollPosition?: boolean | undefined;
+    title: string | undefined;
+    step: number | undefined;
+    totalSteps: number | undefined;
+    enabled: boolean;
+    busy: boolean;
+    ignoreFocusOut: boolean;
+    show(): void;
+    hide(): void;
+    dispose(): void;
+};
+
 /**
  * @reactive `window.createStatusBarItem`
  */