Add Document symbols aka outline

README.md

@@ -45,7 +45,7 @@ You can **install the extension in VSCode from [HERE](https://marketplace.visual
 - [x] **Hover information**
 - [x] **Signature type hints** Trigger characters are both `(` and ` `  (space)
 - [x] **Document highlight**
-- [ ] *missing* Document symbols ("Outline"): Removed again, as they mainly led to problems. If you want symbols, additionally install [Yorkxin's extension](https://github.com/yorkxin/vscode-coffeescript-support). It's marked as deprecated but can provide this feature well.
+- [x] Document symbols ("Outline")
 - [x] **Find definition**
 - [x] **Find references**
 - **Code actions**: Organize imports only. Probably only rarely works as you intend it to. Auto imports: Not implemented as code actions, but works while autocompleting.

client/client.ts

@@ -40,7 +40,8 @@ export function initializeLanguageClient(lspModulePath: string): LanguageClient
   const clientOptions: LanguageClientOptions = {
     documentSelector,
     synchronize: {
-      configurationSection: ['coffeesense', 'javascript', 'typescript', 'files.associations'],
+      // Also sync VS Code outline settings so the server can sort DocumentSymbols accordingly
+      configurationSection: ['coffeesense', 'javascript', 'typescript', 'files.associations', 'outline'],
       fileEvents: vscode.workspace.createFileSystemWatcher('{**/*.js,**/*.ts,**/*.json}', false, false, true)
     },
     initializationOptions: {

server/package.json

@@ -22,7 +22,7 @@
   },
   "homepage": "https://github.com/phil294/coffeesense/tree/master/server",
   "dependencies": {
-    "coffeescript": "github:edemaine/coffeescript#var-assign",
+    "coffeescript": "github:sergioalcaraz/coffeescript#var-assign",
     "jshashes": "^1.0.8",
     "typescript": "^5.1.6",
     "volatile-map": "^2.0.0",

server/src/embeddedSupport/languageModes.ts

@@ -11,7 +11,8 @@ import {
   Position,
   CodeActionContext,
   CodeAction,
-  TextDocumentEdit
+  TextDocumentEdit,
+  DocumentSymbol
 } from 'vscode-languageserver-types';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
 
@@ -50,6 +51,7 @@ export interface LanguageMode {
   findDocumentHighlight?(document: TextDocument, position: Position): DocumentHighlight[];
   findDefinition?(document: TextDocument, position: Position): Definition;
   findReferences?(document: TextDocument, position: Position): Location[];
+  findDocumentSymbols?(document: TextDocument): DocumentSymbol[];
 
   onDocumentChanged?(filePath: string): void;
   onDocumentRemoved(document: TextDocument): void;

server/src/modes/script/javascript.ts

@@ -4,7 +4,7 @@ import {
   CodeAction, CodeActionContext, CodeActionKind, CompletionItem, CompletionItemKind, CompletionItemTag, CompletionList, Definition, Diagnostic,
   DiagnosticSeverity, DiagnosticTag, DocumentHighlight,
   DocumentHighlightKind, Hover, Location, MarkedString, MarkupContent, ParameterInformation, Position, Range, SignatureHelp,
-  SignatureInformation, TextEdit
+  SignatureInformation, TextEdit, DocumentSymbol, SymbolKind
 } from 'vscode-languageserver-types';
 import { URI } from 'vscode-uri';
 import { CoffeescriptDocumentRegions, LanguageId } from '../../embeddedSupport/embeddedSupport';
@@ -15,6 +15,7 @@ import { DependencyService, RuntimeLibrary } from '../../services/dependencyServ
 import { DocumentService } from '../../services/documentService';
 import { EnvironmentService } from '../../services/EnvironmentService';
 import transpile_service, { common_js_variable_name_character, get_line_at_line_no, get_word_around_position, pseudo_compile_coffee } from '../../services/transpileService';
+import { getDocumentSymbolsFromCoffee } from '../../services/coffeeAstService';
 import { IServiceHost } from '../../services/typescriptService/serviceHost';
 import { toCompletionItemKind } from '../../services/typescriptService/util';
 import { CodeActionData, CodeActionDataKind, OrganizeImportsActionData } from '../../types';
@@ -23,6 +24,7 @@ import { getFileFsPath, getFilePath } from '../../utils/paths';
 import { NULL_SIGNATURE } from '../nullMode';
 import * as Previewer from './previewer';
 import { HighlightSpanKind } from 'typescript';
+import { logger } from '../../log';
 
 
 
@@ -896,9 +898,74 @@ export async function getJavascriptMode(
       delete action.data;
       return action;
     },
+    findDocumentSymbols(coffee_doc: TextDocument): DocumentSymbol[] {
+      try {
+        const symbols = getDocumentSymbolsFromCoffee(coffee_doc);
+        if (symbols && symbols.length) return symbols;
+      } catch (e: any) {
+        logger.logDebug('coffeeAstService failed: ' + (e && e.message));
+      }
+
+      // Fallback: TypeScript navigation + source maps (existing logic)
+      const transpilation = transpile_service.result_by_uri.get(coffee_doc.uri)
+      const { scriptDoc: js_doc, service } = updateCurrentCoffeescriptTextDocument(coffee_doc);
+      if (!languageServiceIncludesFile(service, coffee_doc.uri)) {
+        return [];
+      }
+      const fileFsPath = getFileFsPath(js_doc.uri);
+      const nav = service.getNavigationTree(fileFsPath);
+      if (!nav || !nav.childItems) return [];
+      const mapKind = (k: string) => {
+        switch ((k || '').toLowerCase()) {
+          case 'module': return SymbolKind.Module;
+          case 'class': return SymbolKind.Class;
+          case 'method': return SymbolKind.Method;
+          case 'function': return SymbolKind.Function;
+          case 'constructor': return SymbolKind.Constructor;
+          case 'property': return SymbolKind.Property;
+          case 'var':
+          case 'local':
+          case 'const':
+          case 'let':
+            return SymbolKind.Variable;
+          case 'interface': return SymbolKind.Interface;
+          case 'enum': return SymbolKind.Enum;
+          default: return SymbolKind.Object;
+        }
+      };
+      const convertNode = (node: any): DocumentSymbol | null => {
+        const span = (node.spans && node.spans.length) ? node.spans[0] : node.textSpan || node.nameSpan;
+        if (!span) return null;
+        let range = convertRange(js_doc, span);
+        let selectionRange = range;
+        if (node.nameSpan) selectionRange = convertRange(js_doc, node.nameSpan);
+        if (transpilation?.source_map) {
+          const coffee_range = transpile_service.range_js_to_coffee(transpilation, range, coffee_doc);
+          const coffee_selection = transpile_service.range_js_to_coffee(transpilation, selectionRange, coffee_doc);
+          if (coffee_range) range = coffee_range;
+          if (coffee_selection) selectionRange = coffee_selection;
+          else if (coffee_range) selectionRange = range;
+        } else {
+          return null;
+        }
+        const children = (node.childItems || []).map((c: any) => convertNode(c)).filter((c: any) => c) as DocumentSymbol[];
+        return {
+          name: node.text || node.kind || '',
+          detail: '',
+          kind: mapKind(node.kind),
+          range,
+          selectionRange,
+          children: children.length ? children : undefined
+        } as DocumentSymbol;
+      };
+      const symbols = (nav.childItems || []).map((c: any) => convertNode(c)).filter((s: any) => s) as DocumentSymbol[];
+      return symbols;
+    },
+
     onDocumentRemoved(document: TextDocument) {
       jsDocuments.onDocumentRemoved(document);
     },
+
     onDocumentChanged(filePath: string) {
       serviceHost.updateExternalDocument(filePath);
     },