@akanjs/language 3.1.2-rc.3 → 3.2.0-rc.0

package/README.ko.md

@@ -40,3 +40,44 @@ index.renameAt(fileName, offset, "inFeed", readText);
 키에서 만들어진 이름 전부와 모듈 dictionary의 키와 함께 바꾸는 편집을 돌려줍니다.
 
 ES module과 CommonJS로 배포하며, 런타임 의존성은 없습니다.
+
+## 언어 서버
+
+`akan-language-server --stdio`는 같은 색인을 LSP로 냅니다. Akan 확장이 있는 VS Code와 Cursor 말고 다른 에디터를
+위한 것입니다. TypeScript 서버 옆에 띄우면 에디터가 두 서버의 답을 합쳐 줍니다. 정의, hover, 참조를 답합니다.
+에디터의 루트나 그 위에서 가장 가까운, `apps/*`나 `libs/*`에 `akan.config.ts`가 있는 폴더를 색인합니다. 에디터가
+watched-file 등록을 지원하면 디스크에서 바뀐 파일도 다시 읽습니다.
+
+설치 절처럼 워크스페이스에 추가해서 bin이 `node_modules/.bin`에 들어가게 하세요. 그러면 `bunx --no-install`이 그
+사본을 실행하고, 레지스트리에서 받아 오지 않습니다.
+
+Neovim 0.11 이상:
+
+```lua
+vim.lsp.config("akan", {
+  cmd = function(dispatchers, config)
+    return vim.lsp.rpc.start({ "bunx", "--no-install", "akan-language-server", "--stdio" }, dispatchers, {
+      cwd = config.root_dir,
+    })
+  end,
+  filetypes = { "typescript", "typescriptreact" },
+  root_markers = { "bun.lock" },
+})
+vim.lsp.enable("akan")
+```
+
+Helix의 `languages.toml`:
+
+```toml
+[language-server.akan]
+command = "bunx"
+args = ["--no-install", "akan-language-server", "--stdio"]
+
+[[language]]
+name = "typescript"
+language-servers = ["typescript-language-server", "akan"]
+
+[[language]]
+name = "tsx"
+language-servers = ["typescript-language-server", "akan"]
+```

package/README.md

@@ -40,3 +40,45 @@ name resolves within its own app and every lib, never another app. `renameAt` re
 query key together with every name derived from it and its key in the module dictionary.
 
 The package ships as an ES module and as CommonJS, with no runtime dependency.
+
+## Language server
+
+`akan-language-server --stdio` serves the same index over LSP. It is for editors other than VS Code and Cursor,
+which have the Akan extension. Run it next to TypeScript's server, and the editor merges the two servers' answers. It
+answers definition, hover and references. It indexes the nearest folder at or above the editor's root whose `apps/*`
+or `libs/*` holds an `akan.config.ts`. It rereads files changed on disk when the editor supports watched-file
+registration.
+
+Add it to the workspace, as in Install, so the bin lands in `node_modules/.bin`. `bunx --no-install` then runs that
+copy and never fetches one from the registry.
+
+Neovim 0.11 or later:
+
+```lua
+vim.lsp.config("akan", {
+  cmd = function(dispatchers, config)
+    return vim.lsp.rpc.start({ "bunx", "--no-install", "akan-language-server", "--stdio" }, dispatchers, {
+      cwd = config.root_dir,
+    })
+  end,
+  filetypes = { "typescript", "typescriptreact" },
+  root_markers = { "bun.lock" },
+})
+vim.lsp.enable("akan")
+```
+
+Helix, in `languages.toml`:
+
+```toml
+[language-server.akan]
+command = "bunx"
+args = ["--no-install", "akan-language-server", "--stdio"]
+
+[[language]]
+name = "typescript"
+language-servers = ["typescript-language-server", "akan"]
+
+[[language]]
+name = "tsx"
+language-servers = ["typescript-language-server", "akan"]
+```

package/akanGraph.d.ts

@@ -1,7 +1,7 @@
 import type { AkanGraph } from "akanjs/common/akanGraph.ts";
 import type * as TS from "typescript";
 import type { Ts } from "./ast";
-import type { FileFacts } from "./moduleFacts";
+import { type AkanFactReader, type FileFacts } from "./moduleFacts";
 import type { AkanTarget } from "./nameTable";
 export interface AkanGraphSource {
     ts: Ts;
@@ -12,6 +12,8 @@ export interface AkanGraphSource {
     resolve: (fileName: string, identifier: TS.Identifier) => AkanTarget[];
     relative: (fileName: string) => string;
     ownerOf: (fileName: string) => string | null;
+    reader: AkanFactReader;
+    digests?: boolean;
 }
 export declare class GraphBuilder {
     #private;

package/akanGraphDiff.d.ts

@@ -0,0 +1,10 @@
+import type { AkanGraph, AkanGraphChange } from "akanjs/common/akanGraph.ts";
+export interface AkanGraphChanges extends AkanGraph {
+    summary: {
+        [change in AkanGraphChange]: number;
+    };
+}
+export declare class AkanGraphDiff {
+    #private;
+    static between(base: AkanGraph, head: AkanGraph): AkanGraphChanges;
+}

package/akanIndex.d.ts

@@ -33,7 +33,9 @@ export declare class AkanIndex {
     sourceKeysOf(givenName: string): AkanSourceKey[];
     sourceKeyAt(givenName: string, offset: number): AkanSourceKey | null;
     referencesAt(givenName: string, offset: number, readText: (fileName: string) => string | undefined): AkanSpan[];
-    graph(readText: (fileName: string) => string | undefined): AkanGraph;
+    graph(readText: (fileName: string) => string | undefined, { digests }?: {
+        digests?: boolean | undefined;
+    }): AkanGraph;
     renameTargetAt(givenName: string, offset: number): {
         family: AkanFamily;
         sourceKey: string;

package/frameworkChannelReader.d.ts

@@ -0,0 +1,16 @@
+import type { FrameworkChannel } from "akanjs/common/frameworkMap.ts";
+import type * as TS from "typescript";
+import type { Ts } from "./ast";
+export interface FrameworkChannelSpec {
+    file: string;
+    union: string;
+    label: string;
+    /** Classes that route the channel's messages by `type` on their way to the handlers, who sit beyond the reader. */
+    relays?: string[];
+}
+export declare class FrameworkChannelReader {
+    #private;
+    constructor(ts: Ts, specs: FrameworkChannelSpec[], sources: Map<string, TS.SourceFile>);
+    get missing(): string[];
+    channels(): FrameworkChannel[];
+}

package/frameworkMapBuilder.d.ts

@@ -0,0 +1,20 @@
+import type { FrameworkMap } from "akanjs/common/frameworkMap.ts";
+import type { Ts } from "./ast";
+import { type FrameworkChannelSpec } from "./frameworkChannelReader";
+export interface FrameworkSourcePackage {
+    name: string;
+    root: string;
+    split: boolean;
+}
+export interface FrameworkMapSource {
+    ts: Ts;
+    packages: FrameworkSourcePackage[];
+    files: [file: string, text: string][];
+    channels: FrameworkChannelSpec[];
+}
+export declare class FrameworkMapBuilder {
+    #private;
+    constructor(source: FrameworkMapSource);
+    static isSourcePath(file: string): boolean;
+    build(): FrameworkMap;
+}

package/frameworkMapDoc.d.ts

@@ -0,0 +1,10 @@
+import type { FrameworkMap } from "akanjs/common/frameworkMap.ts";
+export declare class FrameworkMapDoc {
+    #private;
+    static readonly regenerate = "bun run akan sync-architecture";
+    static render(map: FrameworkMap, docDir: string): string;
+    static generatedOf(markdown: string): string | null;
+    static splice(markdown: string, generated: string): string;
+    static citedClasses(markdown: string): string[];
+    static unknownClasses(markdown: string, map: FrameworkMap): string[];
+}