Skip to content

feat: sync types with plugin API 1.3 (spell-check dictionaries) #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hamidfzm wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −4
Open

feat: sync types with plugin API 1.3 (spell-check dictionaries) #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions types/glyph.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
// Glyph plugin API (v1.2). Mirrors what the host passes to `activate(ctx)`.
// Glyph plugin API (v1.3). Mirrors what the host passes to `activate(ctx)`.
// Imported as `import type { PluginModule } from "glyph"`; type-only, so the
// bundler drops it (there is no runtime "glyph" package).
//
// Sandboxed plugins ("sandbox": true in manifest.json) run in an isolated
// worker and get a subset of this ctx: commands, ui.addStyles, exporters,
// workspace, settings, notify, and registerTranslations. The markdown APIs
// and DOM mounts (addStatusBarItem/addSidebarPanel/addSettingsPanel) are
// main-context only.
// workspace, settings, notify, and registerTranslations. The markdown APIs,
// spellcheck dictionaries, and DOM mounts
// (addStatusBarItem/addSidebarPanel/addSettingsPanel) are main-context only.
declare module "glyph" {
export type Disposer = () => void;

Expand Down Expand Up @@ -44,6 +44,19 @@ declare module "glyph" {
/** remark/rehype plugin in the shape react-markdown accepts. */
export type MarkdownPlugin = unknown;

/**
* A spell-check dictionary for one language. `load` resolves the two
* Hunspell files as UTF-8 text and runs only when the user first selects
* the language in Settings → Editor → Spell Check.
*/
export interface DictionaryContribution {
/** Language code stored in the editor setting, e.g. "fa". */
language: string;
/** Label shown in the Settings language picker, e.g. "فارسی (Persian)". */
label: string;
load: () => Promise<{ aff: string; dic: string }>;
}

export interface GlyphPluginContext {
readonly apiVersion: string;
readonly commands: { register(command: CommandContribution): Disposer };
Expand Down Expand Up @@ -71,6 +84,14 @@ declare module "glyph" {
};
/** API 1.1 */
readonly exporters: { register(exporter: ExporterContribution): Disposer };
/**
* API 1.3: contribute spell-check dictionaries. Registering a known code
* (including the built-in "en") replaces it; the disposer removes the
* language and drops any cached checker. Main-context only.
*/
readonly spellcheck: {
registerDictionary(dictionary: DictionaryContribution): Disposer;
};
/**
* API 1.1: per-plugin persisted settings. Hydrated before activate, so
* `get` is synchronous; `set` persists in the background.
Expand Down