stan-language-server 0.4.9 → 0.5.0

package/README.md

@@ -105,73 +105,25 @@ and add the following to the settings file:
 
 ### Emacs (eglot)
 
+For emacs users, we recommend using [mason.el](github.com/mason-org/mason.el)
+to download from the same source as neovim above.
+
 Assuming you are using [stan-ts-mode](https://github.com/WardBrian/stan-ts-mode),
 add the following to your `init.el`.
-This will download the latest release the first time you load a Stan file.
 
 ```elisp
-(require 'package)
-;; elgot is built in to emacs 29+, but some features work better if you use the
-;; latest version from GNU ELPA
-(add-to-list 'package-archives '("gnu-devel" . "https://elpa.gnu.org/devel/"))
-(package-initialize)
-
-;; work around https://debbugs.gnu.org/cgi/bugreport.cgi?bug=69423
-(assq-delete-all 'eglot package--builtins)
-(assq-delete-all 'eglot package--builtin-versions)
-
-(defcustom bmw/stan-language-server-location
-  (expand-file-name (concat "bin/stan-language-server" (car exec-suffixes)) user-emacs-directory)
-  "Location to download the stan-language-server binary to."
-  :type 'file
-  :group 'stan)
-
-(use-package url)
-
-(defun bmw/download-stan-language-server (&optional force)
-  "Download the latest copy of the stan-language-server.
-The location is determined by stan-ts-mode-language-server-location.
-Argument FORCE will make the download proceed even if the file exists."
-  (interactive "P")
-  (when (or force (not (file-exists-p bmw/stan-language-server-location)))
-    (let*
-        ((version
-          (with-temp-buffer
-            (url-insert-file-contents
-             "https://api.github.com/repos/tomatitito/stan-language-server/releases/latest")
-            (let ((json  (json-parse-buffer)))
-              (gethash "tag_name" json))))
-         (os-tag
-          (pcase system-type
-            ((or 'windows-nt 'cygwin 'ms-dos) "windows-x86_64")
-            ('darwin (concat "macos-"
-                             (if (string-match-p "aarch64\\|arm" system-configuration ) "aarch64" "x86_64") ))
-            (_  (concat "linux-"
-                        (if (string-match-p "aarch64\\|arm" system-configuration ) "arm64" "x86_64")))))
-         (url
-          (concat
-           "https://github.com/tomatitito/stan-language-server/releases/download/"
-           version
-           "/stan-ls-"
-           version
-           "-"
-           os-tag
-           (car exec-suffixes)))
-         (file bmw/stan-language-server-location))
-      (make-empty-file file t)
-      (delete-file file)
-      (url-copy-file url file)
-      (chmod file 500))))
+(use-package mason
+  :config
+  (mason-setup
+    (dolist (pkg '("stan-language-server"))
+      (unless (mason-installed-p pkg)
+        (ignore-errors (mason-install pkg))))) )
 
 (use-package eglot
-  :ensure t
-  :pin gnu-devel
-  :hook ((stan-ts-base-mode . bmw/download-stan-language-server)
-         (stan-ts-base-mode . eglot-ensure))
+  :hook (stan-ts-base-mode . eglot-ensure)
   :config
-  (add-to-list
-   'eglot-server-programs
-   `(stan-ts-base-mode . (,bmw/stan-language-server-location "--stdio"))))
+  (add-to-list 'eglot-server-programs '(stan-ts-base-mode
+                                        . ("stan-language-server" "--stdio")))
 ```
 
 ## For developers

package/dist/__tests__/e2e/lsp-client.d.ts

@@ -1,4 +1,4 @@
-import type { CompletionItem, CompletionList, DocumentDiagnosticReport, Hover, InitializeResult, LSPAny, TextEdit } from "vscode-languageserver-protocol";
+import type { CompletionItem, CompletionList, DidChangeTextDocumentParams, DocumentDiagnosticReport, Hover, InitializeResult, LSPAny, PrepareRenameResult, TextEdit, WorkspaceEdit } from "vscode-languageserver-protocol";
 export interface LSPMessage {
     jsonrpc: "2.0";
     id?: number | string;
@@ -22,6 +22,8 @@ export declare class LSPTestClient {
     private openDocumentUris;
     serverMessages: LSPMessage[];
     numRefreshRequest: number;
+    stdoutChunks: string[];
+    stderrChunks: string[];
     start(): Promise<void>;
     stop(): Promise<void>;
     private handleServerMessage;
@@ -40,6 +42,7 @@ export declare class LSPTestClient {
     exit(): Promise<void>;
     didOpen(uri: string, languageId: string, text: string): Promise<void>;
     didChange(uri: string, text: string, version: number): Promise<void>;
+    didChangeRanges(uri: string, contentChanges: DidChangeTextDocumentParams["contentChanges"], version: number): Promise<void>;
     didClose(uri: string): Promise<void>;
     closeAll(): Promise<void>;
     didChangeConfiguration(settings?: LSPAny): Promise<void>;
@@ -47,4 +50,6 @@ export declare class LSPTestClient {
     formatting(uri: string): Promise<TextEdit[]>;
     hover(uri: string, line: number, character: number): Promise<Hover | null>;
     diagnostics(uri: string): Promise<DocumentDiagnosticReport>;
+    prepareRename(uri: string, line: number, character: number): Promise<PrepareRenameResult | null>;
+    rename(uri: string, line: number, character: number, newName: string): Promise<WorkspaceEdit | null>;
 }

package/dist/__tests__/handlers/rename.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/ast/parser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/ast/symbol.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/ast/workspace_index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/rename/prepare.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/rename/provider.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/language/stan-symbols/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/server/document_state.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/server/workspace_state.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/handlers/compilation/compilation.d.ts

@@ -1,6 +1,6 @@
 import type { TextDocument } from "vscode-languageserver-textdocument";
-import { type TextDocuments, type WorkspaceFolder, type RemoteConsole } from "vscode-languageserver";
-import type { FileSystemReader } from "../../types/common";
+import { type WorkspaceFolder, type RemoteConsole } from "vscode-languageserver";
+import type { FileSystemReader, TextDocumentProvider } from "../../types/common";
 import { type StancReturn } from "stanc3";
 export interface Settings {
     maxLineLength: number;
@@ -9,4 +9,4 @@ export interface Settings {
 }
 export declare const defaultSettings: Settings;
 export type Purpose = "formatting" | "linting";
-export declare function handleCompilation(document: TextDocument, documentManager: TextDocuments<TextDocument>, workspaceFolders: WorkspaceFolder[], settings: Settings, purpose: Purpose, logger: RemoteConsole, reader?: FileSystemReader): Promise<StancReturn>;
+export declare function handleCompilation(document: TextDocument, documentManager: TextDocumentProvider, workspaceFolders: WorkspaceFolder[], settings: Settings, purpose: Purpose, logger: RemoteConsole, reader?: FileSystemReader): Promise<StancReturn>;

package/dist/handlers/compilation/includes.d.ts

@@ -1,6 +1,6 @@
-import { TextDocuments, WorkspaceFolder, type RemoteConsole } from "vscode-languageserver";
+import { WorkspaceFolder, type RemoteConsole } from "vscode-languageserver";
 import { TextDocument } from "vscode-languageserver-textdocument";
-import type { FileSystemReader } from "../../types";
+import type { FileSystemReader, TextDocumentProvider } from "../../types";
 export type Filename = string;
 export type FileContent = string;
 export type FilePathError = {
@@ -8,4 +8,4 @@ export type FilePathError = {
 };
 export declare function getFilenames(fileContent: string): Filename[];
 export declare function isFilePathError(value: unknown): value is FilePathError;
-export declare function handleIncludes(document: TextDocument, documentManager: TextDocuments<TextDocument>, workspaceFolders: WorkspaceFolder[], includePaths: string[], logger: RemoteConsole, reader?: FileSystemReader, alreadyIncluded?: Set<Filename>): Promise<Record<Filename, FileContent>>;
+export declare function handleIncludes(document: TextDocument, documentManager: TextDocumentProvider, workspaceFolders: WorkspaceFolder[], includePaths: string[], logger: RemoteConsole, reader?: FileSystemReader, alreadyIncluded?: Set<Filename>): Promise<Record<Filename, FileContent>>;

package/dist/handlers/completion.d.ts

@@ -1,4 +1,5 @@
-import { type CompletionParams, TextDocuments, CompletionItem } from "vscode-languageserver";
-import { TextDocument, type Position } from "vscode-languageserver-textdocument";
+import { type CompletionParams, CompletionItem } from "vscode-languageserver";
+import { type Position } from "vscode-languageserver-textdocument";
+import type { TextDocumentProvider } from "../types/common";
 export declare const getTextUpToCursor: (text: string, position: Position) => string;
-export declare function handleCompletion({ position, textDocument }: CompletionParams, documents: TextDocuments<TextDocument>, supportsSnippets: boolean): CompletionItem[];
+export declare function handleCompletion({ position, textDocument }: CompletionParams, documents: TextDocumentProvider, supportsSnippets: boolean): CompletionItem[];

package/dist/handlers/diagnostics.d.ts

@@ -1,5 +1,4 @@
-import { Diagnostic, TextDocuments, WorkspaceFolder, type DocumentDiagnosticParams, type RemoteConsole } from "vscode-languageserver";
-import { TextDocument } from "vscode-languageserver-textdocument";
-import type { FileSystemReader } from "../types";
+import { Diagnostic, WorkspaceFolder, type DocumentDiagnosticParams, type RemoteConsole } from "vscode-languageserver";
+import type { FileSystemReader, TextDocumentProvider } from "../types";
 import { type Settings } from "./compilation/compilation";
-export declare function handleDiagnostics(params: DocumentDiagnosticParams, documents: TextDocuments<TextDocument>, workspaceFolders: WorkspaceFolder[], settings: Settings, logger: RemoteConsole, reader?: FileSystemReader): Promise<Diagnostic[]>;
+export declare function handleDiagnostics(params: DocumentDiagnosticParams, documents: TextDocumentProvider, workspaceFolders: WorkspaceFolder[], settings: Settings, logger: RemoteConsole, reader?: FileSystemReader): Promise<Diagnostic[]>;

package/dist/handlers/formatting.d.ts

@@ -1,7 +1,6 @@
-import type { DocumentFormattingParams, RemoteConsole, TextDocuments, TextEdit, WorkspaceFolder } from "vscode-languageserver";
-import type { TextDocument } from "vscode-languageserver-textdocument";
+import type { DocumentFormattingParams, RemoteConsole, TextEdit, WorkspaceFolder } from "vscode-languageserver";
 import { type Settings } from "./compilation/compilation";
-import type { FileSystemReader } from "../types";
-export declare function handleFormatting(params: DocumentFormattingParams, documents: TextDocuments<TextDocument>, workspaceFolders: WorkspaceFolder[], settings: Settings, logger: RemoteConsole, reader?: FileSystemReader): Promise<TextEdit[] | {
+import type { FileSystemReader, TextDocumentProvider } from "../types";
+export declare function handleFormatting(params: DocumentFormattingParams, documents: TextDocumentProvider, workspaceFolders: WorkspaceFolder[], settings: Settings, logger: RemoteConsole, reader?: FileSystemReader): Promise<TextEdit[] | {
     errors: string[];
 }>;

package/dist/handlers/hover.d.ts

@@ -1,5 +1,4 @@
 import type { HoverParams, Hover } from "vscode-languageserver";
 import type { TextDocument } from "vscode-languageserver-textdocument";
-export declare const manual_functions: string[];
 declare function handleHover(document: TextDocument, params: HoverParams): Promise<Hover | null>;
 export default handleHover;

package/dist/handlers/index.d.ts

@@ -2,3 +2,4 @@ export { handleCompletion } from "./completion";
 export { handleDiagnostics } from "./diagnostics";
 export { default as handleHover } from "./hover";
 export { handleFormatting } from "./formatting";
+export { handlePrepareRename, handleRename } from "./rename";

package/dist/handlers/rename.d.ts

@@ -0,0 +1,5 @@
+import type { PrepareRenameParams, PrepareRenameResult, RenameParams, WorkspaceEdit } from "vscode-languageserver-protocol";
+import type { TextDocument } from "vscode-languageserver-textdocument";
+import type { WorkspaceIndex } from "../language/ast/types";
+export declare function handlePrepareRename(document: TextDocument, params: PrepareRenameParams, workspaceIndex: WorkspaceIndex): PrepareRenameResult | null;
+export declare function handleRename(document: TextDocument, params: RenameParams, workspaceIndex: WorkspaceIndex): WorkspaceEdit;

package/dist/language/ast/semantic_index.d.ts

@@ -0,0 +1,11 @@
+import type { Node } from "web-tree-sitter";
+import type { SemanticIndex, SemanticIndexEntry, SourcePosition } from "./types";
+export declare const sourcePositionToTreeSitterPoint: (source: string, position: SourcePosition) => {
+    row: number;
+    column: number;
+};
+export declare const nodeToRange: (lines: string[], node: Node) => {
+    start: SourcePosition;
+    end: SourcePosition;
+};
+export declare const buildSemanticIndex: (source: string, tree: SemanticIndexEntry["tree"]) => SemanticIndex;

package/dist/language/ast/symbol.d.ts

@@ -0,0 +1,6 @@
+import type { SemanticIndexEntry, SourcePosition, SymbolId } from "./types";
+import { nodeToRange } from "./semantic_index";
+export declare const symbolAtPosition: (index: Pick<SemanticIndexEntry, "tree" | "semanticIndex">, source: string, position: SourcePosition) => {
+    symbolId: SymbolId;
+    range: ReturnType<typeof nodeToRange>;
+} | undefined;

package/dist/language/ast/types.d.ts

@@ -0,0 +1,50 @@
+import type { Tree } from "web-tree-sitter";
+export type SourcePosition = {
+    line: number;
+    character: number;
+};
+export type SourceRange = {
+    start: SourcePosition;
+    end: SourcePosition;
+};
+export type SymbolId = string;
+export type ReferenceId = string;
+export type SymbolKind = "function" | "value";
+export type SymbolInfo = {
+    id: SymbolId;
+    name: string;
+    kind: SymbolKind;
+    range: SourceRange;
+    nodeId: number;
+};
+export type ReferenceInfo = {
+    id: ReferenceId;
+    symbolId: SymbolId;
+    range: SourceRange;
+    nodeId: number;
+};
+export type NameInfo = {
+    kind: "declaration";
+    symbolId: SymbolId;
+    renameable: boolean;
+} | {
+    kind: "reference";
+    refId?: ReferenceId;
+    renameable: boolean;
+};
+export type SemanticIndex = {
+    nameInfoByNodeId: Map<number, NameInfo>;
+    symbolsById: Map<SymbolId, SymbolInfo>;
+    referencesById: Map<ReferenceId, ReferenceInfo>;
+    referenceIdsBySymbolId: Map<SymbolId, ReferenceId[]>;
+};
+export type SemanticIndexEntry = {
+    uri: string;
+    version: number;
+    text: string;
+    tree: Tree;
+    semanticIndex: SemanticIndex;
+};
+export type WorkspaceIndex = {
+    entries: Map<string, SemanticIndexEntry>;
+};