@pulsar-edit/types 1.128.1 → 1.131.0

package/dependencies/text-buffer/src/marker.d.ts

@@ -129,8 +129,10 @@ export interface Marker {
   /**
    * Merge an object containing new properties into the marker's existing
    * properties. Use this to set custom data on your markers.
+   *
+   * Returns a boolean indicating whether any properties were changed.
    */
-  setProperties(properties: Record<string, unknown>);
+  setProperties(properties: Record<string, unknown>): boolean;
 
   /**
    * Retrieve an object of key/value pairs that you set earlier via

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pulsar-edit/types",
-  "version": "1.128.1",
+  "version": "1.131.0",
   "description": "TypeScript definitions for Pulsar",
   "homepage": "https://github.com/pulsar-edit/types",
   "license": "MIT",
@@ -47,7 +47,6 @@
   },
   "dependencies": {
     "@types/emscripten": "^1.40.1",
-    "@types/node": "*",
     "@types/semver": "^5.5.0",
     "web-tree-sitter": "^0.25.3"
   },
@@ -56,6 +55,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
+    "@types/node": "~20.17",
     "typescript": "^5.8.3"
   }
 }

package/src/package.d.ts

@@ -30,4 +30,10 @@ export interface Package {
 
   /** If a previous rebuild failed, get the contents of stderr. */
   getBuildFailureOutput(): string | null;
+
+  /** Private: Load the package but do not activate it. */
+  preload(): void;
+
+  /** Private: Activate the package immediately. */
+  activateNow(): void;
 }

package/src/pane.d.ts

@@ -7,6 +7,10 @@ type PaneItemLocation = 'left' | 'right' | 'bottom' | 'center';
 type PaneItemSerializer = { deserializer: string } & Record<string, unknown>;
 type PaneItemFileFilter = { name: string, extensions: string[] };
 
+interface PaneContainer {
+  getLocation(): PaneItemLocation;
+}
+
 /**
  * Properties to apply to the save dialog:
  *
@@ -141,7 +145,7 @@ interface AbstractPaneItem extends ViewModel {
    *
    * Must return a {@link Disposable}.
    */
-  onDidDestroy?(callback): Disposable;
+  onDidDestroy?(callback: () => unknown): Disposable;
 
   /**
    * Indicate whether this pane has already been destroyed.
@@ -367,7 +371,7 @@ interface AbstractPaneItem extends ViewModel {
    * read-only.
    *
    * You must also, of course, do the work of invoking these callbacks when you
-   * attach or reattatch an editor to your view.
+   * attach or reattach an editor to your view.
    */
   observeEmbeddedTextEditor?(
     callback: (editor: TextEditor) => unknown
@@ -453,6 +457,12 @@ export interface Pane {
   /** Get the active pane item in this pane. */
   getActiveItem(): PaneItem;
 
+  /** Gets the pane's container. */
+  getContainer(): PaneContainer;
+
+  /** Sets the pane's container. */
+  setContainer(container: PaneContainer): void;
+
   /** Return the item at the given index. */
   itemAtIndex(index: number): PaneItem | undefined;
 

package/src/project.d.ts

@@ -101,10 +101,31 @@ export interface Project {
    */
   contains(pathToCheck: string): boolean;
 
+  /**
+   * Layers the contents of a project-specific configuration on top of the
+   * current global configuration.
+   */
+  replace(projectSpecification: ProjectSpecification): void;
+
 }
 
+/**
+ * A serialized representation of the attributes that identify this project.
+ *
+ * Most projects are opened against a single root path and can be described
+ * entirely by that root path. But if customization does take place — addition
+ * of other project roots, configuration overrides — the project now needs a
+ * way to describe and serialize those customizations.
+ *
+ * Eventually, the destination for this information might be a project file.
+ * For now, it's an object that can be passed to {@link Project#replace} and
+ * will be included in the calllback to {@link Project#onDidReplace}.
+ */
 export interface ProjectSpecification {
+  /** A set of project paths. */
   paths: string[];
+  /** The location on disk of the project's configuration file. */
   originPath: string;
+  /** The configuration overrides to be applied to this project. */
   config?: ConfigValues | undefined;
 }

package/src/wasm-tree-sitter-grammar.d.ts

@@ -159,11 +159,11 @@ export interface WASMTreeSitterGrammar extends Grammar {
   /** Undocumented: Root scope name of the grammar. */
   readonly scopeName: string;
 
-  constructor(
+  new(
     registry: GrammarRegistry,
     grammarPath: string,
     params: WASMTreeSitterGrammarParams
-  );
+  ): WASMTreeSitterGrammar;
 
   // Callbacks
   onDidUpdate(callback: () => void): Disposable;