Class GitHubPluginRegistry

Client for the lessel GitHub-based plugin registry. Fetches plugin index and code from raw.githubusercontent.com.

Index

Constructors

Methods

downloadPlugin fetchIndex getPlugin installPlugin openPullRequest search

Constructors

constructor

new GitHubPluginRegistry(
repoOwner?: string,
repoName?: string,
): GitHubPluginRegistry
Parameters
- OptionalrepoOwner: string
- OptionalrepoName: string
Returns GitHubPluginRegistry
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:43

Methods

downloadPlugin

downloadPlugin(
name: string,
version?: string,
): Promise<{ code: string; version: string }>
Download a plugin's index.js code.
Parameters
- name: string
- Optionalversion: string
Returns Promise<{ code: string; version: string }>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:95

fetchIndex

fetchIndex(): Promise<RegistryIndex>
Fetch the full registry index.

Returns Promise<RegistryIndex>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:52

getPlugin

getPlugin(name: string): Promise<GitHubPluginInfo>
Get a specific plugin by name.
Parameters
- name: string
Returns Promise<GitHubPluginInfo>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:83

installPlugin

installPlugin(
    name: string,
    version?: string,
    targetDir?: string,
): Promise<string>
Install a plugin from the registry into the local plugins directory.
Parameters
- name: string
- Optionalversion: string
- OptionaltargetDir: string
Returns Promise<string>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:117

openPullRequest

openPullRequest(name: string, pluginDir: string): Promise<void>
Generate a plugin submission (opens a browser to create a PR).
Parameters
- name: string
- pluginDir: string
Returns Promise<void>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:160

search

search(query: string): Promise<GitHubPluginInfo[]>
Search plugins by query string.
Parameters
- query: string
Returns Promise<GitHubPluginInfo[]>
- Defined in packages/core/src/registry/GitHubPluginRegistry.ts:66