Merge pull request #57 from atom-community/types

Author: aminya

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Fix atom-package-deps issues (#60)
 -
+
 ### 2.3.4
 
 - Fix copying from overlays on MacOS (#58)

types-packages/busy-signal.d.ts

@@ -1,24 +1,27 @@
+import type { IdeUri } from "./uri"
+
 export interface BusySignalOptions {
   /**
    * Can say that a busy signal will only appear when a given file is open.
    * Default = `null`, meaning the busy signal applies to all files.
    */
-  onlyForFile?: string
+  onlyForFile?: IdeUri
 
   /**
    * Is user waiting for computer to finish a task? (traditional busy spinner)
    * or is the computer waiting for user to finish a task? (action required)
-   * Default = `"computer"`.
+   * @defaultValue `'computer'`
    */
   waitingFor?: "computer" | "user"
 
   /**
-   * Debounce it? default = `true` for busy-signal, and false for action-required.
+   * Debounce it? default = `true` for busy-signal, and `false` for action-required.
    */
   debounce?: boolean
 
   /**
-   * If `onClick` is set, then the tooltip will be clickable. Default = `null`.
+   * If `onClick` is set, then the tooltip will be clickable.
+   * @defaultValue `null`
    */
   onDidClick?: () => void
 

types-packages/code-actions.d.ts

@@ -1,5 +1,16 @@
 import * as Atom from "atom"
 import { Message } from "atom/linter"
+// TODO add code action support to Atom linter?
+
+export type DiagnosticType = "Error" | "Warning" | "Info"
+
+export interface Diagnostic {
+  providerName: string
+  type: DiagnosticType
+  filePath: string
+  text?: string
+  range: Atom.Range
+}
 
 export interface CodeAction {
   apply(): Promise<void>
@@ -13,7 +24,7 @@ export interface CodeActionProvider {
   getCodeActions(
     editor: Atom.TextEditor,
     range: Atom.Range,
-    diagnostics: Message[]
+    diagnostics: Diagnostic[] // | Message[]
   ): Promise<CodeAction[] | null | undefined>
 }
 
@@ -24,5 +35,5 @@ export interface CodeActionProvider {
  * extended to provide a stream of CodeActions based on the cursor position.
  */
 export interface CodeActionFetcher {
-  getCodeActionForDiagnostic: (diagnostic: Message, editor: Atom.TextEditor) => Promise<CodeAction[]>
+  getCodeActionForDiagnostic: (diagnostic: Diagnostic /* | Message */, editor: Atom.TextEditor) => Promise<CodeAction[]>
 }

types-packages/code-format.d.ts

@@ -0,0 +1,26 @@
+import type { TextEditor, Point, Range } from "atom"
+import type { TextEdit } from "./text-edit"
+
+export interface FileCodeFormatProvider {
+  formatEntireFile: (editor: TextEditor, range: Range) => Promise<TextEdit[]>
+  priority: number
+  grammarScopes: string[]
+}
+
+export interface RangeCodeFormatProvider {
+  formatCode: (editor: TextEditor, range: Range) => Promise<TextEdit[]>
+  priority: number
+  grammarScopes: string[]
+}
+
+export interface OnSaveCodeFormatProvider {
+  formatOnSave: (editor: TextEditor) => Promise<TextEdit[]>
+  priority: number
+  grammarScopes: string[]
+}
+
+export interface OnTypeCodeFormatProvider {
+  formatAtPosition: (editor: TextEditor, position: Point, character: string) => Promise<TextEdit[]>
+  priority: number
+  grammarScopes: string[]
+}

types-packages/console.d.ts

@@ -0,0 +1,34 @@
+export interface SourceInfo {
+  id: string
+  name: string
+  start?: () => void
+  stop?: () => void
+}
+
+export type ConsoleService = (options: SourceInfo) => ConsoleApi
+
+export interface ConsoleApi {
+  setStatus(status: OutputProviderStatus): void
+  append(message: Message): void
+  dispose(): void
+  log(object: string): void
+  error(object: string): void
+  warn(object: string): void
+  info(object: string): void
+}
+
+export type OutputProviderStatus = "starting" | "running" | "stopped"
+
+export interface Message {
+  text: string
+  level: Level
+  tags?: string[] | null
+  kind?: MessageKind | null
+  scopeName?: string | null
+}
+
+export type TaskLevelType = "info" | "log" | "warning" | "error" | "debug" | "success"
+export type Level = TaskLevelType | Color
+type Color = "red" | "orange" | "yellow" | "green" | "blue" | "purple" | "violet" | "rainbow"
+
+export type MessageKind = "message" | "request" | "response"

types-packages/datatip.d.ts

@@ -21,13 +21,27 @@ export type PinnedDatatipPosition = "end-of-line" | "above-range"
 
 export interface DatatipProvider {
   priority: number
-  grammarScopes?: ReadonlyArray<string>
+
   /**
    * A unique name for the provider to be used for analytics.
    * It is recommended that it be the name of the provider's package.
    */
   providerName: string
-  datatip(editor: Atom.TextEditor, bufferPosition: Atom.Point): Promise<Datatip | undefined | null>
+  datatip(
+    editor: Atom.TextEditor,
+    bufferPosition: Atom.Point,
+    /**
+     * The mouse event that triggered the datatip.
+     * This is null for manually toggled datatips.
+     */
+    mouseEvent?: MouseEvent | null
+  ): Promise<Datatip | undefined | null>
+
+  /** Either pass this or `validForScope` */
+  grammarScopes?: ReadonlyArray<string>
+
+  /** Either pass `grammarScopes` or this function. */
+  validForScope?(scopeName: string): boolean
 }
 
 export interface ModifierDatatipProvider {

types-packages/definitions.d.ts

@@ -1,10 +1,11 @@
 import * as Atom from "atom"
+import { IdeUri } from "./uri"
 
 export interface Definition {
   /**
    * Path of the file in which the definition is located.
    */
-  path: string
+  path: IdeUri
   /**
    * First character of the definition's identifier.
    * e.g. "F" in `class Foo {}`
@@ -23,7 +24,7 @@ export interface Definition {
   /**
    * If provided, `projectRoot` will be used to display a relativized version of `path`.
    */
-  projectRoot?: string
+  projectRoot?: IdeUri
   /**
    * `language` may be used by consumers to identify the source of definitions.
    */
@@ -48,6 +49,7 @@ export interface DefinitionQueryResult {
  * Provides definitions for a set of language grammars.
  */
 export interface DefinitionProvider {
+  name: string
   /**
    * If there are multiple providers for a given grammar,
    * the one with the highest priority will be used.

types-packages/find-references.d.ts

@@ -1,10 +1,11 @@
 import * as Atom from "atom"
+import { IdeUri } from "./uri"
 
 export interface FindReferencesProvider {
   /**
    * Return true if your provider supports finding references for the provided Atom.TextEditor.
    */
-  isEditorSupported(editor: Atom.TextEditor): Promise<boolean>
+  isEditorSupported(editor: Atom.TextEditor): boolean | Promise<boolean>
 
   /**
    * `findReferences` will only be called if `isEditorSupported` previously returned true
@@ -15,9 +16,9 @@ export interface FindReferencesProvider {
 
 export interface Reference {
   /**
-   * Nuclide URI of the file path
+   * URI of the file path
    */
-  uri: string
+  uri: IdeUri
   /**
    * name of calling method/function/symbol
    */
@@ -27,7 +28,7 @@ export interface Reference {
 
 export interface FindReferencesData {
   type: "data"
-  baseUri: string
+  baseUri: IdeUri
   referencedSymbolName: string
   references: Reference[]
   /**

types-packages/main.d.ts

@@ -3,6 +3,7 @@
  * @see https://github.com/atom-ide-community/atom-ide-base
  */
 
+export * from "./uri"
 export * from "./busy-signal"
 export * from "./code-actions"
 export * from "./code-highlight"
@@ -13,6 +14,10 @@ export * from "./hyperclick"
 export * from "./outline"
 export * from "./sig-help"
 export * from "./markdown-service"
+export * from "./code-format"
+export * from "./text-edit"
+export * from "./refactor"
+export * from "./console"
 
 import { BusySignalProvider } from "./busy-signal.d"
 import { CodeActionProvider } from "./code-actions"

types-packages/outline.d.ts

@@ -14,7 +14,7 @@ export interface OutlineProvider {
 
 export interface OutlineTree {
   /**
-   * from Atom.Octicon (that type's not allowed over rpc so we use string)
+   * from Atom.Octicon or Atom.OcticonsPrivate (types not allowed over rpc so we use string)
    */
   icon?: string
   /**
@@ -23,9 +23,12 @@ export interface OutlineTree {
   kind?: OutlineTreeKind
 
   /**
-   * Must be one or the other. If both are present, tokenizedText is preferred.
+   * Must have `plainText` or the `tokenizedText` property. If both are present, `tokenizedText` is preferred.
    */
   plainText?: string
+  /**
+   * Must have `plainText` or the `tokenizedText` property. If both are present, `tokenizedText` is preferred.
+   */
   tokenizedText?: TokenizedText
 
   /**