Skip to content

Commit

Permalink
[1.3.0] new release
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrnperl committed Nov 6, 2023
1 parent 320287b commit 7c9f6c3
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 17 deletions.
23 changes: 22 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,25 @@ typo

#### Add

- Text decoration for region and tag #49
- Text decoration for region and tag #49

### [1.3.0] - 2023-11-06

#### Add

- (preview) Workspace symbols
- zh-cn translations for package.json
- Add option whether to register region provider

#### Fix

- keep expand state when editing
- Keep the visibility of search field #47
- Keep highlight on the closest outline node when the cursor is out of any symbol #34
- Missed message when no symbol found
- Disable auto-expansion when `follow` to cursor

#### Deprecate

- configuration: `outline-map.color`, use `workbench.colorCustomizations` instead

22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,37 @@ You can define regions to group code symbols anywhere in the code (usually comme

![region and tag](screenshots/region.png)

### Workspace symbols

You can display symbols of multiple files in the workspace, such as regions, tags, functions, etc., and quickly jump to the corresponding location.

After enabling this feature, the symbols of newly opened files will be automatically added to the list. You can manage the symbols in the list in the following ways:

- Set an interval to automatically remove inactive files from the list
- Manually close the symbols of files that are not needed, exclude a specific symbol, or exclude symbols that match a pattern
- Sort the list by last access time to find the symbols of the recently used files

By default, region and tag symbols will be added. You can customize the symbols to be added by modifying the `outline-map.IncludeSymbols` setting.

---

## Configuration
Changes will take effect after restarting the outline view

### Customization

- `outline-map.color`: Color table for specific symbols

- `outline-map.customFont`: Custom font for the outline.

Syntax: `[ <family-name> | <generic-family> ]#`

- `outline-map.customCSS`: Custom css for the outline. The css will be injected into the outline's webview.

- You can customize the color of the outline by `workbench.colorCustomizations`. Outline Map uses the symbol color settings built into vscode, i.e. `symbolsIcon.*Foreground`, and you can also set the color for the two symbols added by the extension and some UI elements:
- `symbolIcon.om_TagForeground` - The color of the tag symbol
- `symbolIcon.om_RegionForeground` - The color of the region symbol
- `outline-map.visibleRangeBackground` - The background color of the visible area in the outline view
- `outline-map.focusingItemBackground` - The background color of the focusing item in the outline view
- `outline-map.focusingItemForeground` - The foreground color of the focusing item in the outline view

### Behavior

- `outline-map.follow`: Scroll the outline when the cursor moves or the viewport scrolls
Expand Down
26 changes: 22 additions & 4 deletions README_ZH_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,38 @@

![region and tag](screenshots/region.png)

## 设置
### 工作区符号

可以在一个列表中显示工作区中多个文件的符号,例如区域、标签、函数等,并且可以快速跳转到相应的位置。

启用这个功能后,新打开的文件的符号会自动添加到列表中。可以通过以下方式管理列表中的符号:

- 设置一个时间间隔,自动从列表中移除不活跃的文件

- 手动关闭不需要的文件的符号,排除某个特定的符号或排除匹配某个模式的符号

- 按照最后访问的时间来排序列表,方便找到最近使用的文件的符号

更改将在重启大纲视图后生效
默认情况下会添加区域和标签符号。可以通过修改 `outline-map.IncludeSymbols` 的设置来自定义需要添加的符号。


## 设置

### 样式

- `outline-map.color`: 为特定符号设置颜色

- `outline-map.customFont`: 设置自定义字体.

语法: `[ <family-name> | <generic-family> ]#`

- `outline-map.customCSS`: 设置自定义CSS. 这些CSS会被插入大纲的Webview视图

- 可以通过`workbench.colorCustomizations`自定义大纲的颜色,Outline Map沿用vscode内置的符号颜色设置,即`symbolsIcon.*Foreground`,此外还可为扩展添加的两个符号以及一些UI元素设置颜色:
- `symbolIcon.om_TagForeground` - 标签符号的颜色
- `symbolIcon.om_RegionForeground` - 区域符号的颜色
- `outline-map.visibleRangeBackground` - 大纲视图中可见区域的背景色
- `outline-map.focusingItemBackground` - 大纲视图中聚焦项目的背景色
- `outline-map.focusingItemForeground` - 大纲视图中聚焦项目的前景色

### 行为

- `outline-map.follow`: 设置大纲视图自动跟随光标|视口
Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "outline-map",
"displayName": "Outline Map",
"description": "A visual, interactive outline map that combinesAlternative Minimap. the clarity of the outline with the intuitive overview of the minimap. Enhanced version of vscode built-in outline.",
"version": "1.2.2",
"version": "1.3.0",
"repository": {
"url": "https://github.com/Gerrnperl/outline-map.git"
},
Expand Down Expand Up @@ -471,16 +471,16 @@
"id": "outlineMap.visibleRangeBackground",
"description": "%om.colors.outlineMap.visibleRangeBackground%",
"defaults": {
"dark": "scrollbarSlider.background",
"light": "scrollbarSlider.background"
"dark": "list.hoverBackground",
"light": "list.hoverBackground"
}
},
{
"id": "outlineMap.focusingItemBackground",
"description": "%om.colors.outlineMap.focusingItemBackground%",
"defaults": {
"dark": "list.hoverBackground",
"light": "list.hoverBackground"
"dark": "list.inactiveSelectionBackground",
"light": "list.inactiveSelectionBackground"
}
},
{
Expand Down
3 changes: 2 additions & 1 deletion package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
"om.cmd.workspace.excludeGlobally.title": "Exclude Globally",
"om.cmd.workspace.goToLocation.title": "Go To Symbol Location",
"om.colors.outlineMap.visibleRangeBackground": "The color of the visible range in the outline.",
"om.colors.outlineMap.focusingItemBackground": "The color of the focusing item in the outline.",
"om.colors.outlineMap.focusingItemBackground": "The background color of the focusing item in the outline.",
"om.colors.outlineMap.focusingItemForeground": "The color of the focusing item in the outline.",
"om.colors.symbolIcon.om_RegionForeground": "The color of the Outline-Map region symbols in the outline.",
"om.colors.symbolIcon.om_TagForeground": "The color of the Outline-Map tag symbols in the outline."
}
7 changes: 4 additions & 3 deletions package.nls.zh-cn.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
"om.config.workspace.closeFileTimeout.description": "指定未单击时关闭文件的时间(以秒为单位)。设置为0以禁用超时关闭。",
"om.cmd.reduceDepth.title": "减少大纲深度",
"om.cmd.addDepth.title": "增加大纲深度",
"om.cmd.unpin.title": "取消固定",
"om.cmd.pin.title": "固定",
"om.cmd.freeze.title": "冻结",
"om.cmd.unpin.title": "大纲: 取消固定",
"om.cmd.pin.title": "大纲: 固定",
"om.cmd.freeze.title": "大纲: 冻结",
"om.cmd.toggleSearch.title": "切换搜索",
"om.cmd.focusSearch.title": "聚焦搜索",
"om.cmd.workspace.closeFile.title": "关闭文件",
Expand All @@ -43,6 +43,7 @@
"om.cmd.workspace.goToLocation.title": "转到符号位置",
"om.colors.outlineMap.visibleRangeBackground": "大纲可见范围背景色",
"om.colors.outlineMap.focusingItemBackground": "大纲聚焦项背景色",
"om.colors.outlineMap.focusingItemForeground": "大纲聚焦项前景色",
"om.colors.symbolIcon.om_RegionForeground": "Outline-Map 区域符号颜色",
"om.colors.symbolIcon.om_TagForeground": "Outline-Map 标签符号颜色"
}

0 comments on commit 7c9f6c3

Please sign in to comment.