@forinda/kickjs-view-language-server 0.1.2 → 0.3.0

package/README.md

@@ -5,7 +5,10 @@ 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.
+- Hover, go to definition, find references and formatting.
+- Rename pipes, components and layouts across templates; renaming a template file updates its uses, `ctx.render('…')` calls in TS / JS included.
+- Semantic tokens, so any LSP editor highlights the template syntax.
+- In TypeScript and JavaScript files, template names in `ctx.render('…')` and `views.render('…')`: completion, go to definition, and a warning for a name with no template. Nothing else in those files is touched.
 
 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.
 
@@ -25,6 +28,8 @@ Initialization options, relative to the workspace folder:
 | `viewsDir`      | `src/views`                                                                                      |
 | `componentsDir` | `components`                                                                                     |
 | `pipesFile`     | `<viewsDir>/pipes.ts`                                                                            |
+| `layout`        | none — the same as `createViews({ layout })`: one name, or folder prefix → layout                |
+| `baseLayout`    | none — the same as `createViews({ baseLayout })`                                                 |
 | `trusted`       | `false` — only `true` imports the project's `@forinda/kickjs-view` (its code runs in the server) |
 
 Any file ending in `.kick` is a template, whatever `languageId` the editor sends. The custom request `kick/templateNames` returns every template name except components.

package/dist/index.d.ts

@@ -12,6 +12,10 @@ interface ServerOptions {
   componentsDir?: string;
   /** Default `<viewsDir>/pipes.ts`. */
   pipesFile?: string;
+  /** `createViews({ layout })`: a page's layout when it declares none; one name, or folder prefix → layout. */
+  layout?: string | Record<string, string>;
+  /** `createViews({ baseLayout })`. */
+  baseLayout?: 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`.
@@ -46,6 +50,15 @@ interface WorkspaceOptions {
   read(path: string): Promise<string | undefined>;
   /** Every `.kick` file (absolute paths) under `dir`. */
   list(dir: string): Promise<string[]>;
+  /** `createViews({ layout })`: a page's layout when it declares none; one name, or folder prefix → layout. */
+  layout?: string | Record<string, string>;
+  /** `createViews({ baseLayout })`: the shell around every page's outermost layout. */
+  baseLayout?: string;
+  /** The project's TS / JS files with their text (an open buffer's when there is one), for `ctx.render('…')` names. */
+  scripts?(): Promise<Array<{
+    uri: string;
+    text: string;
+  }>>;
 }
 export declare class Workspace {
   private readonly opts;
@@ -57,6 +70,8 @@ export declare class Workspace {
   get view(): ViewModule;
   load(): Promise<void>;
   private nameOfPath;
+  /** `uri`'s path inside the views folder (`layouts/main.kick`, `layouts`); `undefined` outside it. */
+  relOf(uri: string): string | undefined;
   nameOf(uri: string): string | undefined;
   uriOf(name: string): string;
   componentsDir(): string;
@@ -82,6 +97,18 @@ export declare class Workspace {
   pipeDeclaration(name: string): PipeDeclaration | undefined;
   pipesFile(): string;
   project(): View.Project;
+  /** Templates that are layouts by configuration: the mapping's targets and the base layout. */
+  configuredLayouts(): Set<string>;
+  scripts(): Promise<Array<{
+    uri: string;
+    text: string;
+  }>>;
+  baseLayout(): string | undefined;
+  /**
+   * The layout `name` renders in: its own `@layout`, else the configured
+   * mapping's longest matching folder prefix (pages only, as `check` does).
+   */
+  layoutOf(name: string): string | undefined;
   /** Parse errors, else everything `check` reports — as LSP diagnostics. */
   diagnosticsFor(uri: string): Diagnostic[];
 }

package/dist/index.d.ts.map

@@ -1 +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;;wBAsBc;;;;;;;;UC/CC;;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;;;;qBCLlB,2BAA2B;WAOjB;WANZ;WACA;WACA,UAAU;WACV,UAAU;WACV,eAAe;EAExB,YAAqB;;qBA0CV,oBAAoB,eAAe;;;wBChRhC,wBAAwB,IAAI,YAAY;;;wBCmFlC,eACpB,cACA,OAAO;;AAEP,mBACC;EAAU,MAAM;EAAY;EAA+B"}
+{"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":";;;;;;;UAoBiB;;EAEf;;EAEA;;EAEA;;EAEA,kBAAkB;;EAElB;;;;;EAKA;;wBAgEc;;;;;;;;UC9FC;;EAEf;EACA;EACA;;;;KCKU,oBAAoB;UAEf;EACf;;EAEA;EACA;;EAEA;EACA,MAAM;EACN,KAAK,eAAe;;EAEpB,KAAK,cAAc;;EAEnB,kBAAkB;;EAElB;;EAEA,YAAY,QAAQ;IAAQ;IAAa;;;qBAa9B;mBAMkB;mBALZ;mBACA;UACT;UACA;EAER,YAA6B,MAAM;MAE/B,QAAQ;EAIN,QAAQ;UAUN;;EAOR,MAAM;EAKN,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;EAgB5B;;EAKA,gBAAgB,eAAe;EAI/B;EAIA,WAAW,KAAK;;EAWhB,qBAAqB;EAOrB,WAAW,QAAQ;IAAQ;IAAa;;EAIxC;;;;;EAQA,SAAS;;EAmBT,eAAe,cAAc;;;;qBC3BlB,2BAA2B;WAOjB;WANZ;WACA;WACA,UAAU;WACV,UAAU;WACV,eAAe;EAExB,YAAqB;;qBAgEV,oBAAoB,eAAe;;;wBCnUhC,wBAAwB,IAAI,YAAY;;;wBCgFlC,eACpB,cACA,OAAO;;AAEP,mBACC;EAAU,MAAM;EAAY;EAA+B"}

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @forinda/kickjs-view-language-server v0.1.2
+ * @forinda/kickjs-view-language-server v0.3.0
  *
  * Copyright (c) Felix Orinda
  *
@@ -8,4 +8,4 @@
  *
  * @license MIT
  */
-export { a as KickVirtualCode, n as Workspace, i as createKickServicePlugin, o as kickLanguagePlugin, r as loadViewModule, t as startServer } from "./server-CfzShU0v.js";
+export { a as KickVirtualCode, n as Workspace, i as createKickServicePlugin, o as kickLanguagePlugin, r as loadViewModule, t as startServer } from "./server-Biz_hJF3.js";

package/dist/main.js

@@ -1,5 +1,5 @@
 /**
- * @forinda/kickjs-view-language-server v0.1.2
+ * @forinda/kickjs-view-language-server v0.3.0
  *
  * Copyright (c) Felix Orinda
  *
@@ -8,7 +8,7 @@
  *
  * @license MIT
  */
-import { t as startServer } from "./server-CfzShU0v.js";
+import { t as startServer } from "./server-Biz_hJF3.js";
 //#region src/main.ts
 /** Runs the server — the entry editors launch (the bin and the VS Code bundle). */
 startServer();