feat: add expanded option to expand all symbols on startup

Author: Gerrnperl

package.json

@@ -227,14 +227,16 @@
 					"enum": [
 						"cursor",
 						"viewport",
-						"manual"
+						"manual",
+						"expanded"
 					],
 					"default": "viewport",
 					"description": "%om.config.expand.description%",
 					"markdownEnumDescriptions": [
 						"%om.config.expand.enumDescriptions.cursor%",
 						"%om.config.expand.enumDescriptions.viewport%",
-						"%om.config.expand.enumDescriptions.manual%"
+						"%om.config.expand.enumDescriptions.manual%",
+						"%om.config.expand.enumDescriptions.expanded%"
 					],
 					"order": 4
 				},

package.nls.json

@@ -18,11 +18,12 @@
     "om.config.follow.description": "Choose when to scroll the outline. If set to manual, the outline will not scroll automatically.",	
     "om.config.follow.enumDescriptions.cursor": "Scroll when the cursor moves to the symbol.",
     "om.config.follow.enumDescriptions.viewport": "Scroll when the editor view scrolls.",
-    "om.config.follow.enumDescriptions.manual": "Manual scroll.",
+    "om.config.follow.enumDescriptions.manual": "Manually scroll.",
     "om.config.expand.description": "Choose when to expand the outline. If set to manual, the outline will not expand automatically.",
     "om.config.expand.enumDescriptions.cursor": "Expand to the symbol where the cursor is.",
     "om.config.expand.enumDescriptions.viewport": "Expand all visible symbols in the editor view. When `Follow` is set to `cursor`, it will only expand when the cursor moves.",
-    "om.config.expand.enumDescriptions.manual": "Manual expand.",
+    "om.config.expand.enumDescriptions.manual": "Manually expand, and the outline is initially collapsed.",
+    "om.config.expand.enumDescriptions.expanded": "Manually expand, but the outline is initially expanded.",
     "om.config.hiddenItem.description": "Choose items to hide in the outline.",
     "om.config.defaultMaxDepth.description": "Set the default maximum depth of the outline, set to 0 to not limit.",
     "om.config.customFont.description": "Set custom font. Syntax `[ <family-name> | <generic-family> ]#`",

package.nls.zh-cn.json

@@ -22,7 +22,8 @@
 	"om.config.expand.description": "选择何时展开大纲。",
 	"om.config.expand.enumDescriptions.cursor": "展开到光标所在的符号。",
 	"om.config.expand.enumDescriptions.viewport": "展开编辑器视图内的所有可见符号。当`Follow`设置为`cursor`时，仅会在光标移动时展开。",
-	"om.config.expand.enumDescriptions.manual": "手动展开。",
+	"om.config.expand.enumDescriptions.manual": "手动展开，且大纲初始为收起。",
+	"om.config.expand.enumDescriptions.expanded": "手动展开，但大纲初始为展开。",
 	"om.config.hiddenItem.description": "选择要在大纲中隐藏的项目。",
 	"om.config.defaultMaxDepth.description": "设置默认的大纲最大深度，设为0则不限制。",
 	"om.config.customFont.description": "设置自定义字体。语法`[ <family-name> | <generic-family> ]#`",

src/common.ts

@@ -93,6 +93,7 @@ export class SymbolNode {
 
 		const root: SymbolNode[] = [];
 		const hiddenItem = config.hiddenItem();
+		const expandOnInit = config.expand() === 'expanded';
 
 		// A known issue of vscode is that the DocumentSymbols returned by 
 		// command 'vscode.executeDocumentSymbolProvider' does not include the 
@@ -150,6 +151,9 @@ export class SymbolNode {
 				if (hiddenItem.includes(node.kind.toLowerCase())) {
 					return;
 				}
+				if (expandOnInit) {
+					node.expand = true;
+				}
 				if (Array.isArray(parent)) {
 					parent.push(node);
 					node.selector = node.selector.concat(`[data-key="${node.kind}-${node.name}"]`);

src/extension/config.ts

@@ -15,7 +15,7 @@ export const config = {
 	//#endregion DEPRECATED
 	/** When to expand the outline. */
 	follow: () => getConfig('follow') as 'cursor' | 'viewport' | 'manual',
-	expand: () => getConfig('expand') as 'cursor' | 'viewport' | 'manual',
+	expand: () => getConfig('expand') as 'cursor' | 'viewport' | 'manual' | 'expanded',
 	/** Hide specified items. */
 	hiddenItem: () => getConfig('hiddenItem') as string[],
 	/** The initial maximum depth of the outline. */

src/extension/outline.ts

@@ -216,7 +216,7 @@ export class OutlineView implements WebviewViewProvider {
 		// 1. remove all nodes in the viewport
 		for (const node of this.inView) {
 			node.inView = false;
-			if (config.expand() !== 'manual') {
+			if (config.expand() === 'cursor' || config.expand() === 'viewport') {
 				node.expand = false;
 			}
 		}
@@ -265,7 +265,7 @@ export class OutlineView implements WebviewViewProvider {
 				property: 'inview',
 				value: node.inView,
 			} as UpdateOp);
-			if (this.pinStatus === PinStatus.unpinned && config.expand() !== 'manual') {
+			if (this.pinStatus === PinStatus.unpinned && (config.expand() === 'cursor' || config.expand() === 'viewport')) {
 				Ops.push({
 					type: 'update',
 					selector: node.selector.join(' >.outline-children> '),

src/webview/index.ts

@@ -244,6 +244,7 @@ function renderSymbolNode(symbolNode: SymbolNode, depth = 0): HTMLDivElement {
 		})
 	);
 	container.classList.toggle('leaf', symbolNode.children.length === 0);
+	container.classList.toggle('expand', depth >= maxDepth ? false : symbolNode.expand);
 	container.style.setProperty('--depth', depth.toString());
 
 	container.innerHTML = /*html*/`