feat: add missing Atom types

Author: aminya

src-commons-ui/float-pane/FloatPane.tsx

@@ -1,4 +1,5 @@
-import { DisplayMarker, Decoration, TextEditor, Disposable, DisposableLike, CompositeDisposable } from "atom"
+import { DisplayMarker, Decoration, TextEditor, Disposable, DisposableLike, CompositeDisposable, TextEditorElement } from "atom"
+import "../../types-packages/atom"
 import { Observable, fromEvent } from "rxjs"
 import type {Subscription} from "rxjs"
 import { disposableFromSubscription } from "../../src-commons-atom/disposable"

types-packages/atom.d.ts

@@ -0,0 +1,113 @@
+// TODO add to @types/Atom
+
+export {}
+
+// An {Object} with the following fields:
+interface BufferChangeEvent {
+  // The deleted text
+  oldText: string
+
+  // The {Range} of the deleted text before the change took place.
+  oldRange: Range
+
+  // The inserted text
+  newText: string
+
+  // The {Range} of the inserted text after the change took place.
+  newRange: Range
+}
+
+type HighlightingChangeEvent = (range: Range) => void
+
+declare module "atom" {
+  interface TextEditor {
+    // Get the Element for the editor.
+    getElement(): TextEditorElement
+
+    // Controls visibility based on the given {Boolean}.
+    setVisible(visible: boolean): void
+
+    // Experimental: Get a notification when async tokenization is completed.
+    onDidTokenize(callback: () => any): Disposable
+
+    component: {
+      getNextUpdatePromise(): Promise<unknown>
+    }
+
+    isDestroyed(): boolean
+  }
+
+  interface LanguageMode {
+    // A {Function} that returns a {String} identifying the language.
+    getLanguageId(): string
+
+    // A {Function} that is called whenever the buffer changes.
+    bufferDidChange(change: BufferChangeEvent): void
+
+    // A {Function} that takes a callback {Function} and calls it with a {Range} argument whenever the syntax of a given part of the buffer is updated.
+    onDidChangeHighlighting(callback: HighlightingChangeEvent): void
+
+    // A function that returns an iterator object with the following methods:
+    buildHighlightIterator(): {
+      // A {Function} that takes a {Point} and resets the iterator to that position.
+      seek(point: Point): any
+
+      // A {Function} that advances the iterator to the next token
+      moveToSuccessor(): void
+
+      // A {Function} that returns a {Point} representing the iterator's current position in the buffer.
+      getPosition(): Point
+
+      //  A {Function} that returns an {Array} of {Number}s representing tokens that end at the current position.
+      getCloseTags(): Array<number>
+
+      // A {Function} that returns an {Array} of {Number}s representing tokens that begin at the current position.
+      getOpenTags(): Array<number>
+    }
+  }
+
+  interface TextMateLanguageMode {
+    fullyTokenized: boolean
+
+    // Get the suggested indentation level for an existing line in the buffer.
+    //
+    // * bufferRow - A {Number} indicating the buffer row
+    //
+    // Returns a {Number}.
+    suggestedIndentForBufferRow(bufferRow: number, tabLength: number, options: object): number
+
+    // Get the suggested indentation level for a given line of text, if it were inserted at the given
+    // row in the buffer.
+    //
+    // * bufferRow - A {Number} indicating the buffer row
+    //
+    // Returns a {Number}.
+    suggestedIndentForLineAtBufferRow(bufferRow: number, line: number, tabLength: number): number
+
+    // Get the suggested indentation level for a line in the buffer on which the user is currently
+    // typing. This may return a different result from {::suggestedIndentForBufferRow} in order
+    // to avoid unexpected changes in indentation. It may also return undefined if no change should
+    // be made.
+    //
+    // * bufferRow - The row {Number}
+    //
+    // Returns a {Number}.
+    suggestedIndentForEditedBufferRow(bufferRow: number, tabLength: number): number
+  }
+
+  interface TextBuffer {
+    // Experimental: Get the language mode associated with this buffer.
+    //
+    // Returns a language mode {Object} (See {TextBuffer::setLanguageMode} for its interface).
+    getLanguageMode(): LanguageMode | TextMateLanguageMode
+
+    // Experimental: Set the LanguageMode for this buffer.
+    //
+    // * `languageMode` - an {Object} with the following methods:
+    setLanguageMode(languageMode: LanguageMode | TextMateLanguageMode): void
+  }
+
+  interface TextEditorElement {
+    setUpdatedSynchronously(val: boolean): void
+  }
+}