add new method to js bindings

Author: psteinroe

crates/pgt_workspace/src/workspace.rs

@@ -5,6 +5,8 @@ use pgt_analyse::RuleCategories;
 use pgt_configuration::{PartialConfiguration, RuleSelector};
 use pgt_fs::PgTPath;
 use pgt_text_size::TextRange;
+#[cfg(feature = "schema")]
+use schemars::{JsonSchema, SchemaGenerator, schema::Schema};
 use serde::{Deserialize, Serialize};
 use slotmap::{DenseSlotMap, new_key_type};
 
@@ -255,6 +257,17 @@ new_key_type! {
     pub struct ProjectKey;
 }
 
+#[cfg(feature = "schema")]
+impl JsonSchema for ProjectKey {
+    fn schema_name() -> String {
+        "ProjectKey".to_string()
+    }
+
+    fn json_schema(generator: &mut SchemaGenerator) -> Schema {
+        <String>::json_schema(generator)
+    }
+}
+
 #[derive(Debug, Default)]
 pub struct WorkspaceData<V> {
     /// [DenseSlotMap] is the slowest type in insertion/removal, but the fastest in iteration

crates/pgt_workspace/src/workspace_types.rs

@@ -457,9 +457,10 @@ macro_rules! workspace_method {
 }
 
 /// Returns a list of signature for all the methods in the [Workspace] trait
-pub fn methods() -> [WorkspaceMethod; 8] {
+pub fn methods() -> [WorkspaceMethod; 9] {
     [
         workspace_method!(is_path_ignored),
+        workspace_method!(register_project_folder),
         workspace_method!(get_file_content),
         workspace_method!(pull_diagnostics),
         workspace_method!(get_completions),

packages/@postgrestools/backend-jsonrpc/src/workspace.ts

@@ -19,6 +19,11 @@ export type FileKind = FileKind2[];
  * The priority of the file
  */
 export type FileKind2 = "Config" | "Ignore" | "Inspectable" | "Handleable";
+export interface RegisterProjectFolderParams {
+	path?: string;
+	setAsCurrentWorkspace: boolean;
+}
+export type ProjectKey = string;
 export interface GetFileContentParams {
 	path: PgTPath;
 }
@@ -92,7 +97,7 @@ export type DiagnosticTags = DiagnosticTag[];
 /**
 	* Serializable representation of a [Diagnostic](super::Diagnostic) advice
 
-See the [Visitor] trait for additional documentation on all the supported advice types. 
+See the [Visitor] trait for additional documentation on all the supported advice types.
 	 */
 export type Advice =
 	| { log: [LogCategory, MarkupBuf] }
@@ -197,7 +202,7 @@ export interface CompletionItem {
 /**
 	* The text that the editor should fill in. If `None`, the `label` should be used. Tables, for example, might have different completion_texts:
 
-label: "users", description: "Schema: auth", completion_text: "auth.users". 
+label: "users", description: "Schema: auth", completion_text: "auth.users".
 	 */
 export interface CompletionText {
 	is_snippet: boolean;
@@ -350,7 +355,7 @@ export interface PartialVcsConfiguration {
 	/**
 	* The folder where we should check for VCS files. By default, we will use the same folder where `postgrestools.jsonc` was found.
 
-If we can't find the configuration, it will attempt to use the current working directory. If no current working directory can't be found, we won't use the VCS integration, and a diagnostic will be emitted 
+If we can't find the configuration, it will attempt to use the current working directory. If no current working directory can't be found, we won't use the VCS integration, and a diagnostic will be emitted
 	 */
 	root?: string;
 	/**
@@ -436,6 +441,9 @@ export interface CloseFileParams {
 export type Configuration = PartialConfiguration;
 export interface Workspace {
 	isPathIgnored(params: IsPathIgnoredParams): Promise<boolean>;
+	registerProjectFolder(
+		params: RegisterProjectFolderParams,
+	): Promise<ProjectKey>;
 	getFileContent(params: GetFileContentParams): Promise<string>;
 	pullDiagnostics(
 		params: PullDiagnosticsParams,
@@ -452,6 +460,9 @@ export function createWorkspace(transport: Transport): Workspace {
 		isPathIgnored(params) {
 			return transport.request("pgt/is_path_ignored", params);
 		},
+		registerProjectFolder(params) {
+			return transport.request("pgt/register_project_folder", params);
+		},
 		getFileContent(params) {
 			return transport.request("pgt/get_file_content", params);
 		},

packages/@postgrestools/backend-jsonrpc/tests/workspace.test.mjs

@@ -2,7 +2,7 @@ import { resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import { describe, expect, it } from "vitest";
 
-import { createWorkspaceWithBinary } from "../dist";
+import { createWorkspaceWithBinary } from "../src";
 
 describe("Workspace API", () => {
 	it("should process remote requests", async () => {
@@ -14,6 +14,9 @@ describe("Workspace API", () => {
 		);
 
 		const workspace = await createWorkspaceWithBinary(command);
+		workspace.registerProjectFolder({
+			setAsCurrentWorkspace: true,
+		});
 		await workspace.openFile({
 			path: {
 				path: "test.sql",