Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
gzupanda
code-server
提交
6638daf6
C
code-server
项目概览
gzupanda
/
code-server
与 Fork 源项目一致
从无法访问的项目Fork
通知
2
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
C
code-server
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
未验证
提交
6638daf6
编写于
11月 03, 2020
作者:
A
Anmol Sethi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
plugin.d.ts: Add explicit path field and adjust types to reflect
See my discussion with Will in the PR.
上级
8d3a7721
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
42 addition
and
12 deletion
+42
-12
typings/plugin.d.ts
typings/plugin.d.ts
+42
-12
未找到文件。
typings/plugin.d.ts
浏览文件 @
6638daf6
...
...
@@ -10,7 +10,7 @@ import * as express from "express"
* The homepage of code-server will launch into VS Code. However, there will be an overlay
* button that when clicked, will show all available applications with their names,
* icons and provider plugins. When one clicks on an app's icon, they will be directed
* to <code-server-root>/<plugin-
name>/<app-name
> to access the application.
* to <code-server-root>/<plugin-
path>/<app-path
> to access the application.
*/
/**
...
...
@@ -51,11 +51,35 @@ import * as express from "express"
/**
* Your plugin module must implement this interface.
*
* The plugin's name, description and version are fetched from its module's package.json
*
* The plugin's router will be mounted at <code-sever-root>/<plugin-name>
* The plugin's router will be mounted at <code-sever-root>/<plugin-path>
*/
export
interface
Plugin
{
/**
* name is used as the plugin's unique identifier.
* No two plugins may share the same name.
*
* Fetched from package.json.
*/
name
?:
string
/**
* The version for the plugin in the overlay.
*
* Fetched from package.json.
*/
version
?:
string
/**
* These two are used in the overlay.
*/
displayName
:
string
description
:
string
/**
* The path at which the plugin router is to be registered.
*/
path
:
string
/**
* init is called so that the plugin may initialize itself with the config.
*/
...
...
@@ -63,6 +87,8 @@ export interface Plugin {
/**
* Returns the plugin's router.
*
* Mounted at <code-sever-root>/<plugin-path>
*/
router
():
express
.
Router
...
...
@@ -90,21 +116,25 @@ export interface PluginConfig {
/**
* Application represents a user accessible application.
*
* When the user clicks on the icon in the overlay, they will be
* redirected to <code-server-root>/<plugin-name>/<app-name>
* where the application should be accessible.
*
* If the app's name is the same as the plugin's name then
* <code-server-root>/<plugin-name> will be used instead.
*/
export
interface
Application
{
readonly
name
:
string
readonly
version
:
string
/**
* When the user clicks on the icon in the overlay, they will be
* redirected to <code-server-root>/<plugin-path>/<app-path>
* where the application should be accessible.
*
* If undefined, then <code-server-root>/<plugin-path> is used.
*/
readonly
path
?:
string
readonly
description
?:
string
/**
* The path at which the icon for this application can be accessed.
* <code-server-root>/<plugin-
name>/<app-name
>/<icon-path>
* <code-server-root>/<plugin-
path>/<app-path
>/<icon-path>
*/
readonly
iconPath
:
string
}
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录