@forinda/kickjs-view-language-server 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Felix Orinda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @forinda/kickjs-view-language-server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A language server for KickJS `.kick` views, built on [Volar](https://volarjs.dev/).
+
+- Errors as you type, from the same `parse` + `check` the runtime uses.
+- Completion for `@` keywords, pipes, components and their inputs, layout and slot names, and names in scope.
+- HTML, CSS and Emmet inside templates.
+- Hover, go to definition and formatting.
+
+When the client says the workspace is trusted, it loads the project's own `@forinda/kickjs-view` so the editor agrees with the build, and falls back to its bundled copy (with one warning) when the project has none.
+
+## Use
+
+The KickJS VS Code extension bundles this server. For other editors:
+
+```sh
+pnpm add -D @forinda/kickjs-view-language-server
+kick-view-ls --stdio
+```
+
+Initialization options, relative to the workspace folder:
+
+| option          | default                                                                                          |
+| --------------- | ------------------------------------------------------------------------------------------------ |
+| `viewsDir`      | `src/views`                                                                                      |
+| `componentsDir` | `components`                                                                                     |
+| `pipesFile`     | `<viewsDir>/pipes.ts`                                                                            |
+| `trusted`       | `false` — only `true` imports the project's `@forinda/kickjs-view` (its code runs in the server) |
+
+The custom request `kick/templateNames` returns every template name except components.
+
+See the [views guide](https://kickjs.app/guide/views#editor-support).

package/bin/kick-view-ls.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/main.js'

package/dist/index.d.ts

@@ -0,0 +1,114 @@
+
+import { URI } from "vscode-uri";
+import * as View from "@forinda/kickjs-view";
+import { Diagnostic, LanguageServicePlugin } from "@volar/language-service";
+import { CodeMapping, IScriptSnapshot, LanguagePlugin, VirtualCode } from "@volar/language-core";
+//#region src/server.d.ts
+/** `initializationOptions`; paths are relative to the workspace folder. */
+interface ServerOptions {
+  /** Default `src/views`. */
+  viewsDir?: string;
+  /** Default `components`, inside the views folder. */
+  componentsDir?: string;
+  /** Default `<viewsDir>/pipes.ts`. */
+  pipesFile?: string;
+  /**
+   * The editor trusts the workspace, so the project's own `@forinda/kickjs-view`
+   * may be imported. Otherwise the bundled copy is used. Default `false`.
+   */
+  trusted?: boolean;
+}
+export declare function startServer(): void;
+//#endregion
+//#region src/pipes.d.ts
+/**
+ * Where each pipe in `pipes.ts` is declared and what it takes — for hover and
+ * go to definition. Read lexically, like the engine's `readPipeExports`: only
+ * `export const|let|var name = (…) =>` and `export function name(…)` forms.
+ */
+interface PipeDeclaration {
+  /** 0-based. */
+  line: number;
+  column: number;
+  signature: string;
+}
+//#endregion
+//#region src/workspace.d.ts
+type ViewModule = typeof View;
+interface WorkspaceOptions {
+  root: string;
+  /** Absolute. */
+  viewsDir: string;
+  componentsDir: string;
+  /** Absolute. */
+  pipesFile: string;
+  view: ViewModule;
+  read(path: string): Promise<string | undefined>;
+  /** Every `.kick` file (absolute paths) under `dir`. */
+  list(dir: string): Promise<string[]>;
+}
+export declare class Workspace {
+  private readonly opts;
+  private readonly entries;
+  private readonly cache;
+  private pipes;
+  private pipeDecls;
+  constructor(opts: WorkspaceOptions);
+  get view(): ViewModule;
+  load(): Promise<void>;
+  private nameOfPath;
+  nameOf(uri: string): string | undefined;
+  uriOf(name: string): string;
+  componentsDir(): string;
+  pathOf(name: string): string;
+  names(): string[];
+  textOf(name: string): string | undefined;
+  astOf(name: string): View.TemplateAst | undefined;
+  /** An editor buffer for `uri`; `undefined` drops it and the file on disk applies again. */
+  setBuffer(uri: string, text: string | undefined): void;
+  /** `setBuffer`, skipped when the buffer is already `text`. */
+  sync(uri: string, text: string): void;
+  fileChanged(path: string): Promise<void>;
+  fileDeleted(path: string): Promise<void>;
+  private loadPipes;
+  private update;
+  private remove;
+  /** Drop cached diagnostics for `name` and every template that uses it, transitively. */
+  private invalidate;
+  /** Templates that use `name` as a component or a layout — a layout even after it's gone. */
+  dependentsOf(name: string): Set<string>;
+  pipeNames(): string[];
+  /** Where an app pipe is declared in `pipes.ts`, and its parameters. */
+  pipeDeclaration(name: string): PipeDeclaration | undefined;
+  pipesFile(): string;
+  project(): View.Project;
+  /** Parse errors, else everything `check` reports — as LSP diagnostics. */
+  diagnosticsFor(uri: string): Diagnostic[];
+}
+//#endregion
+//#region src/language-plugin.d.ts
+export declare class KickVirtualCode implements VirtualCode {
+  readonly text: string;
+  readonly id = "root";
+  readonly languageId = "kick";
+  readonly snapshot: IScriptSnapshot;
+  readonly mappings: CodeMapping[];
+  readonly embeddedCodes: VirtualCode[];
+  constructor(text: string);
+}
+export declare const kickLanguagePlugin: LanguagePlugin<URI>;
+//#endregion
+//#region src/plugin/index.d.ts
+export declare function createKickServicePlugin(ws: Workspace): LanguageServicePlugin;
+//#endregion
+//#region src/view-module.d.ts
+export declare function loadViewModule(root: string, warn: (message: string) => void,
+/** The editor trusts this workspace: only then is the project's code imported. */
+trusted: boolean): Promise<{
+  view: ViewModule;
+  source: 'project' | 'bundled';
+  version: string;
+}>;
+//#endregion
+export type { ServerOptions, ViewModule, WorkspaceOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/server.ts","../src/pipes.ts","../src/workspace.ts","../src/language-plugin.ts","../src/plugin/index.ts","../src/view-module.ts"],"mappings":";;;;;;;UAmBiB;;EAEf;;EAEA;;EAEA;;;;;EAKA;;wBAcc;;;;;;;;UCvCC;;EAEf;EACA;EACA;;;;KCKU,oBAAoB;UAEf;EACf;;EAEA;EACA;;EAEA;EACA,MAAM;EACN,KAAK,eAAe;;EAEpB,KAAK,cAAc;;qBAaR;mBAMkB;mBALZ;mBACA;UACT;UACA;EAER,YAA6B,MAAM;MAE/B,QAAQ;EAIN,QAAQ;UAUN;EAMR,OAAO;EAIP,MAAM;EAIN;EAIA,OAAO;EAIP;EAIA,OAAO;EAKP,MAAM,eAAe,KAAK;;EAO1B,UAAU,aAAa;;EAYvB,KAAK,aAAa;EAIZ,YAAY,eAAe;EAc3B,YAAY,eAAe;UAenB;UAON;UA8BA;;UAMA;;EAkBR,aAAa,eAAe;EAc5B;;EAKA,gBAAgB,eAAe;EAI/B;EAIA,WAAW,KAAK;;EAShB,eAAe,cAAc;;;;qBCNlB,2BAA2B;WAOjB;WANZ;WACA;WACA,UAAU;WACV,UAAU;WACV,eAAe;EAExB,YAAqB;;qBA0CV,oBAAoB,eAAe;;;wBC/QhC,wBAAwB,IAAI,YAAY;;;wBC0ClC,eACpB,cACA,OAAO;;AAEP,mBACC;EAAU,MAAM;EAAY;EAA+B"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * @forinda/kickjs-view-language-server v0.0.0
+ *
+ * Copyright (c) Felix Orinda
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+export { a as KickVirtualCode, n as Workspace, i as createKickServicePlugin, o as kickLanguagePlugin, r as loadViewModule, t as startServer } from "./server-BINLQyYR.js";

package/dist/main.d.ts

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

package/dist/main.js

@@ -0,0 +1,18 @@
+/**
+ * @forinda/kickjs-view-language-server v0.0.0
+ *
+ * Copyright (c) Felix Orinda
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+import { t as startServer } from "./server-BINLQyYR.js";
+//#region src/main.ts
+/** Runs the server — the entry editors launch (the bin and the VS Code bundle). */
+startServer();
+//#endregion
+export {};
+
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","names":[],"sources":["../src/main.ts"],"sourcesContent":["/** Runs the server — the entry editors launch (the bin and the VS Code bundle). */\nimport { startServer } from './server'\n\nstartServer()\n"],"mappings":";;;;;;;;;;;;;AAGA,YAAY"}