@pulsar-edit/types 1.128.1

package/index.d.ts

@@ -0,0 +1,72 @@
+// NOTE: Only those classes exported within this file should retain that status
+// below.
+// https://github.com/pulsar-edit/pulsar/blob/v1.128.0/exports/atom.js
+
+/// <reference types="node" />
+
+import { AtomEnvironment } from "./src/atom-environment";
+import { TextEditorElement } from "./src/text-editor-element";
+
+// Imports ======================================================
+declare global {
+  const atom: AtomEnvironment;
+
+  interface HTMLElementTagNameMap {
+    "atom-text-editor": TextEditorElement;
+  }
+}
+
+export * from "./dependencies/event-kit";
+export * from "./dependencies/first-mate";
+export * from "./dependencies/pathwatcher";
+export * from "./dependencies/text-buffer";
+export { ServiceHub } from "./dependencies/service-hub";
+export * from "./src/atom-environment";
+export * from './src/branding';
+export * from "./src/buffered-node-process";
+export * from "./src/buffered-process";
+export * from "./src/clipboard";
+export * from "./src/color";
+export * from "./src/command-registry";
+export * from "./src/config";
+export * from "./src/config-schema";
+export * from "./src/context-menu-manager";
+export * from "./src/cursor";
+export * from "./src/decoration";
+export * from "./src/deserializer-manager";
+export * from "./src/dock";
+export * from "./src/get-window-load-settings";
+export * from "./src/git-repository";
+export * from "./src/grammar-registry";
+export * from "./src/gutter";
+export * from "./src/history-manager";
+export * from "./src/keymap-extensions";
+export * from "./src/language-mode";
+export * from "./src/layer-decoration";
+export * from "./src/menu-manager";
+export * from "./src/notification";
+export * from "./src/notification-manager";
+export * from "./src/other-types";
+export * from "./src/package";
+export * from "./src/package-manager";
+export * from "./src/pane";
+export * from "./src/panel";
+export * from "./src/path-watcher";
+export * from "./src/project";
+export * from "./src/scope-descriptor";
+export * from "./src/selection";
+export * from "./src/style-manager";
+export * from "./src/task";
+export * from "./src/text-editor";
+export * from "./src/text-editor-component";
+export * from "./src/text-editor-element";
+export * from "./src/text-editor-registry";
+export * from "./src/theme-manager";
+export * from "./src/tooltip";
+export * from "./src/tooltip-manager";
+export * from "./src/view-registry";
+export * from "./src/ui";
+export { WASMTreeSitterGrammar } from './src/wasm-tree-sitter-grammar';
+export { WASMTreeSitterLanguageMode } from './src/wasm-tree-sitter-language-mode';
+export * from "./src/workspace";
+export * from "./src/workspace-center";

package/linter/config.d.ts

@@ -0,0 +1,26 @@
+import "../index";
+
+declare module "atom" {
+  interface ConfigValues {
+    /** Lint tabs while they are still in preview status. */
+    "linter.lintPreviewTabs": boolean;
+
+    /** Lint files automatically when they are opened. */
+    "linter.lintOnOpen": boolean;
+
+    /**
+    *  Lint files while typing, without the need to save (only for supported
+    *  providers).
+    */
+    "linter.lintOnChange": boolean;
+
+    /** Interval at which linting is done as you type (in ms). */
+    "linter.lintOnChangeInterval": number;
+
+    /** Ignore files matching this Glob. */
+    "linter.ignoreGlob": string;
+
+    /** Disabled providers. */
+    "linter.disabledProviders": string[];
+  }
+}

package/linter/index.d.ts

@@ -0,0 +1,108 @@
+// Linter 2.x
+// https://web.pulsar-edit.dev/packages/linter
+
+/// <reference path="./config.d.ts" />
+
+import { Disposable, Point, Range, TextEditor } from "../index";
+
+export interface Config {
+  name: string;
+}
+
+export interface ReplacementSolution {
+  title?: string;
+  position: Range;
+  priority?: number;
+  currentText?: string;
+  replaceWith: string;
+}
+
+export interface CallbackSolution {
+  title?: string;
+  position: Range;
+  priority?: number;
+  apply(): any;
+}
+
+export type MessageSolution = ReplacementSolution | CallbackSolution;
+
+export interface Message {
+  /** The location of the issue (aka where to highlight). */
+  location: {
+    /** The path to the file to which the message applies. */
+    file: string;
+
+    /** The range of the message in the editor. */
+    position: Range;
+  };
+
+  /** A reference to a different location in the editor. */
+  reference?: {
+    /** The path to the file being referenced. */
+    file: string;
+
+    /** The point being referenced in that file. */
+    position?: Point;
+  };
+
+  /**
+   * An HTTP link to a resource explaining the issue. Default is a google
+   * search.
+   */
+  url?: string;
+
+  /** The name of the octicon to show in the gutter. */
+  icon?: string;
+
+  /** The message's key. */
+  key?: string;
+
+  /** The API version under which this message operates. */
+  version?: number;
+
+  /** The text for the message. */
+  excerpt: string;
+
+  /** The severity level for the message. */
+  severity: "error" | "warning" | "info";
+
+  /** Possible solutions (which the user can invoke at will). */
+  solutions?:
+    | Array<MessageSolution>
+    | Promise<Array<MessageSolution>>
+    | (() => Promise<Array<MessageSolution>>);
+
+  /**
+   * Markdown long description of the error. Accepts a callback so that you can
+   * do things like HTTP requests.
+   */
+  description?: string | (() => Promise<string> | string);
+
+  /**
+   * Optionally override the displayed linter name. Defaults to provider name.
+   */
+  linterName?: string;
+}
+
+export interface IndieDelegate {
+  name: string;
+  getMessages(): Message[];
+  clearMessages(): void;
+  setMessages(filePath: string, messages: Message[]): void;
+  setAllMessages(messages: Message[]): void;
+  onDidUpdate(callback: () => void): Disposable;
+  onDidDestroy(callback: () => void): Disposable;
+  dispose(): void;
+}
+
+export type LintResult = Message[] | null;
+
+export interface LinterProvider {
+  name: string;
+  scope: "file" | "project";
+  lintsOnChange: boolean;
+  grammarScopes: string[];
+  lint(editor: TextEditor): LintResult | Promise<LintResult>;
+}
+
+export type IndieProvider = (register: (config: Config) => IndieDelegate) => void;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@pulsar-edit/types",
+  "version": "1.128.1",
+  "description": "TypeScript definitions for Pulsar",
+  "homepage": "https://github.com/pulsar-edit/types",
+  "license": "MIT",
+  "keywords": [
+    "pulsar-edit",
+    "typescript",
+    "types"
+  ],
+  "contributors": [
+    {
+      "name": "GlenCFL",
+      "githubUsername": "GlenCFL",
+      "url": "https://github.com/GlenCFL"
+    },
+    {
+      "name": "smhxx",
+      "githubUsername": "smhxx",
+      "url": "https://github.com/smhxx"
+    },
+    {
+      "name": "lierdakil",
+      "githubUsername": "lierdakil",
+      "url": "https://github.com/lierdakil"
+    },
+    {
+      "name": "aminya",
+      "githubUsername": "aminya",
+      "url": "https://github.com/aminya"
+    },
+    {
+      "name": "savetheclocktower",
+      "githubUsername": "savetheclocktower",
+      "url": "https://github.com/savetheclocktower"
+    }
+  ],
+  "main": "./index.d.ts",
+  "types": "./index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pulsar-edit/types.git"
+  },
+  "scripts": {
+    "test": "tsc --noEmit index.d.ts"
+  },
+  "dependencies": {
+    "@types/emscripten": "^1.40.1",
+    "@types/node": "*",
+    "@types/semver": "^5.5.0",
+    "web-tree-sitter": "^0.25.3"
+  },
+  "peerDependencies": {
+    "typescript": ">= 4.0.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
+    "typescript": "^5.8.3"
+  }
+}

package/src/atom-environment.d.ts

@@ -0,0 +1,361 @@
+import {
+  Branding,
+  Clipboard,
+  CommandRegistry,
+  Config,
+  ContextMenuManager,
+  DeserializerManager,
+  Disposable,
+  GrammarRegistry,
+  HistoryManager,
+  KeymapManager,
+  MenuManager,
+  NotificationManager,
+  PackageManager,
+  Project,
+  StyleManager,
+  TextEditorRegistry,
+  ThemeManager,
+  TooltipManager,
+  ViewRegistry,
+  WindowLoadSettings,
+  Workspace,
+  UI
+} from "../index";
+
+
+/**
+ *  Atom global for dealing with packages, themes, menus, and the window.
+ *  An instance of this class is always available as the atom global.
+ */
+export interface AtomEnvironment {
+  // Properties
+  /** Branding information. */
+  readonly branding: Branding;
+
+  /** A CommandRegistry instance. */
+  readonly commands: CommandRegistry;
+
+  /** A Config instance. */
+  readonly config: Config;
+
+  /** A Clipboard instance. */
+  readonly clipboard: Clipboard;
+
+  /** A ContextMenuManager instance. */
+  readonly contextMenu: ContextMenuManager;
+
+  /** A MenuManager instance. */
+  readonly menu: MenuManager;
+
+  /** A KeymapManager instance. */
+  readonly keymaps: KeymapManager;
+
+  /** A TooltipManager instance. */
+  readonly tooltips: TooltipManager;
+
+  /** A NotificationManager instance. */
+  readonly notifications: NotificationManager;
+
+  /** A Project instance. */
+  readonly project: Project;
+
+  /** A GrammarRegistry instance. */
+  readonly grammars: GrammarRegistry;
+
+  /** A HistoryManager instance. */
+  readonly history: HistoryManager;
+
+  /** A PackageManager instance. */
+  readonly packages: PackageManager;
+
+  /** A ThemeManager instance. */
+  readonly themes: ThemeManager;
+
+  /** A StyleManager instance. */
+  readonly styles: StyleManager;
+
+  /** A DeserializerManager instance. */
+  readonly deserializers: DeserializerManager;
+
+  /** A ViewRegistry instance. */
+  readonly views: ViewRegistry;
+
+  /** A Workspace instance. */
+  readonly workspace: Workspace;
+
+  /** A TextEditorRegistry instance. */
+  readonly textEditors: TextEditorRegistry;
+
+  /** A UI module. */
+  readonly ui: UI;
+
+  // Event Subscription
+  /** Invoke the given callback whenever ::beep is called. */
+  onDidBeep(callback: () => void): Disposable;
+
+  /**
+  *  Invoke the given callback when there is an unhandled error, but before
+  *  the devtools pop open.
+  */
+  onWillThrowError(callback: (event: PreventableExceptionThrownEvent) => void): Disposable;
+
+  /** Invoke the given callback whenever there is an unhandled error. */
+  onDidThrowError(callback: (event: ExceptionThrownEvent) => void): Disposable;
+
+  /**
+  *  Invoke the given callback as soon as the shell environment is loaded (or
+  *  immediately if it was already loaded).
+  */
+  whenShellEnvironmentLoaded(callback: () => void): Disposable;
+
+  // Atom Details
+  /** Returns a boolean that is true if the current window is in development mode. */
+  inDevMode(): boolean;
+
+  /** Returns a boolean that is true if the current window is in safe mode. */
+  inSafeMode(): boolean;
+
+  /** Returns a boolean that is true if the current window is running specs. */
+  inSpecMode(): boolean;
+
+  /** Get the full name of this Atom release (e.g. "Atom", "Atom Beta") */
+  getAppName(): string;
+
+  /** Get the version of the Atom application. */
+  getVersion(): string;
+
+  /**
+  *  Gets the release channel of the Atom application.
+  *  Returns the release channel, which can be 'dev', 'nightly', 'beta', or 'stable'.
+  */
+  getReleaseChannel(): "dev" | "nightly" | "beta" | "stable";
+
+  /** Returns a boolean that is true if the current version is an official release. */
+  isReleasedVersion(): boolean;
+
+  /** Get the time taken to completely load the current window. */
+  getWindowLoadTime(): number;
+
+  /** Get the all the markers with the information about startup time. */
+  getStartupMarkers(): TimingMarker[];
+
+  /** Get the load settings for the current window. */
+  getLoadSettings(): WindowLoadSettings;
+
+  // Managing the Atom Window
+  /** Open a new Atom window using the given options. */
+  open(params?: {
+    pathsToOpen: readonly string[];
+    newWindow?: boolean | undefined;
+    devMode?: boolean | undefined;
+    safeMode?: boolean | undefined;
+  }): void;
+
+  /** Close the current window. */
+  close(): void;
+
+  /** Get the size of current window. */
+  getSize(): { width: number; height: number };
+
+  /** Set the size of current window. */
+  setSize(width: number, height: number): void;
+
+  /** Get the position of current window. */
+  getPosition(): { x: number; y: number };
+
+  /** Set the position of current window. */
+  setPosition(x: number, y: number): void;
+
+  /** Prompt the user to select one or more folders. */
+  pickFolder(callback: (paths: string[] | null) => void): void;
+
+  /** Get the current window. */
+  getCurrentWindow(): object;
+
+  /** Move current window to the center of the screen. */
+  center(): void;
+
+  /** Focus the current window. */
+  focus(): void;
+
+  /** Show the current window. */
+  show(): void;
+
+  /** Hide the current window. */
+  hide(): void;
+
+  /** Reload the current window. */
+  reload(): void;
+
+  /** Relaunch the entire application. */
+  restartApplication(): void;
+
+  /** Returns a boolean that is true if the current window is maximized. */
+  isMaximized(): boolean;
+
+  /** Returns a boolean that is true if the current window is in full screen mode. */
+  isFullScreen(): boolean;
+
+  /** Set the full screen state of the current window. */
+  setFullScreen(fullScreen: boolean): void;
+
+  /** Toggle the full screen state of the current window. */
+  toggleFullScreen(): void;
+
+  /**
+  * Restores the full screen and maximized state after the window has resized to prevent resize
+  * glitches.
+  */
+  displayWindow(): Promise<undefined>;
+
+  /** Get the dimensions of this window. */
+  getWindowDimensions(): { x: number; y: number; width: number; height: number };
+
+  /** Set the dimensions of the window. */
+  setWindowDimensions(
+    dimensions: {
+      x?: number | undefined;
+      y?: number | undefined;
+      width?: number | undefined;
+      height?: number | undefined;
+    },
+  ): Promise<object>;
+
+  // Messaging the User
+  /** Visually and audibly trigger a beep. */
+  beep(): void;
+
+  /**
+  *  A flexible way to open a dialog akin to an alert dialog. If a callback
+  *  is provided, then the confirmation will work asynchronously, which is
+  *  recommended.
+  *
+  *  If the dialog is closed (via `Esc` key or `X` in the top corner) without
+  *  selecting a button the first button will be clicked unless a "Cancel" or "No"
+  *  button is provided.
+  *
+  *  Returns the chosen button index number if the buttons option was an array.
+  *  @param response The index of the button that was clicked.
+  *  @param checkboxChecked The checked state of the checkbox if `checkboxLabel` was set.
+  *  Otherwise false.
+  */
+  confirm(options: ConfirmationOptions, callback: (response: number, checkboxChecked: boolean) => void): void;
+
+  /**
+  *  A flexible way to open a dialog akin to an alert dialog. If a callback
+  *  is provided, then the confirmation will work asynchronously, which is
+  *  recommended.
+  *
+  *  If the dialog is closed (via `Esc` key or `X` in the top corner) without
+  *  selecting a button the first button will be clicked unless a "Cancel" or "No"
+  *  button is provided.
+  *
+  *  Returns the chosen button index number if the buttons option was an array.
+  */
+  confirm(
+    options: { message: string; detailedMessage?: string | undefined; buttons?: readonly string[] | undefined },
+  ): void;
+
+  /**
+  *  A flexible way to open a dialog akin to an alert dialog. If a callback
+  *  is provided, then the confirmation will work asynchronously, which is
+  *  recommended.
+  *
+  *  If the dialog is closed (via `Esc` key or `X` in the top corner) without
+  *  selecting a button the first button will be clicked unless a "Cancel" or "No"
+  *  button is provided.
+  *
+  *  Returns the chosen button index number if the buttons option was an array.
+  */
+  confirm(options: {
+    message: string;
+    detailedMessage?: string | undefined;
+    buttons?: readonly string[] | {
+      [key: string]: () => void;
+    } | undefined;
+  }): number;
+
+  // Managing the Dev Tools
+  /** Open the dev tools for the current window. */
+  openDevTools(): Promise<null>;
+
+  /** Toggle the visibility of the dev tools for the current window. */
+  toggleDevTools(): Promise<null>;
+
+  /** Execute code in dev tools. */
+  executeJavaScriptInDevTools(code: string): void;
+
+  /** Undocumented: get Atom config directory path */
+  getConfigDirPath(): string;
+}
+
+export interface ExceptionThrownEvent {
+  originalError: Error;
+  message: string;
+  url: string;
+  line: number;
+  column: number;
+}
+
+export interface PreventableExceptionThrownEvent extends ExceptionThrownEvent {
+  preventDefault(): void;
+}
+
+export interface ConfirmationOptions {
+  /** The type of the confirmation prompt. */
+  type?: "none" | "info" | "error" | "question" | "warning" | undefined;
+
+  /** The text for the buttons. */
+  buttons?: readonly string[] | undefined;
+
+  /** The index for the button to be selected by default in the prompt. */
+  defaultId?: number | undefined;
+
+  /** The title for the prompt. */
+  title?: string | undefined;
+
+  /** The content of the message box. */
+  message?: string | undefined;
+
+  /** Additional information regarding the message. */
+  detail?: string | undefined;
+
+  /** If provided, the message box will include a checkbox with the given label. */
+  checkboxLabel?: string | undefined;
+
+  /** Initial checked state of the checkbox. false by default. */
+  checkboxChecked?: boolean | undefined;
+
+  /** An Electron NativeImage to use as the prompt's icon. */
+  icon?: object | undefined;
+
+  /**
+  *  The index of the button to be used to cancel the dialog, via the `Esc` key.
+  *  By default this is assigned to the first button with "cancel" or "no" as the
+  *  label. If no such labeled buttons exist and this option is not set, 0 will be
+  *  used as the return value or callback response.
+  *
+  *  This option is ignored on Windows.
+  */
+  cancelId?: number | undefined;
+
+  /**
+  *  On Windows, Electron will try to figure out which one of the buttons are
+  *  common buttons (like `Cancel` or `Yes`), and show the others as command links
+  *  in the dialog. This can make the dialog appear in the style of modern Windows
+  *  apps. If you don't like this behavior, you can set noLink to true.
+  */
+  noLink?: boolean | undefined;
+
+  /**
+  * Normalize the keyboard access keys across platforms.
+  * Atom defaults this to true.
+  */
+  normalizeAccessKeys?: boolean | undefined;
+}
+
+export interface TimingMarker {
+  label: string;
+  time: number;
+}

package/src/branding.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Represents the current name of the app and other details that may vary if
+ * Atom is forked.
+*/
+export interface Branding {
+  /** A lower-case fragment without spaces or special characters. */
+  readonly id: string;
+  /** The human-readable name of the application. */
+  readonly name: string;
+
+  /** The URL where the source code repository can be found. */
+  readonly urlCoreRepo: string
+  /** The URL for a discussion forum for the application. */
+  readonly urlForum: string
+  /** The URL of the organization on GitHub. */
+  readonly urlGH: string
+  /** The URL of the web site for the application */
+  readonly urlWeb: string
+}

package/src/buffered-node-process.d.ts

@@ -0,0 +1,10 @@
+import { BufferedProcess, NodeProcessOptions } from "../index";
+
+/**
+ *  Like BufferedProcess, but accepts a Node script as the command to run.
+ *  This is necessary on Windows since it doesn't support shebang #! lines.
+ */
+export class BufferedNodeProcess extends BufferedProcess {
+  /** Runs the given Node script by spawning a new child process. */
+  constructor(options: NodeProcessOptions);
+}