chore: fix the types for lint function

Author: aminya

spec/linter-eslint-spec.js

@@ -4,7 +4,7 @@ import * as path from 'path'
 import * as fs from 'fs'
 import { tmpdir } from 'os'
 import rimraf from 'rimraf'
-import linterEslint from '../dist/main'
+import * as linterEslint from '../dist/main'
 
 import { processESLintMessages } from '../dist/helpers'
 
@@ -76,6 +76,10 @@ async function getNotification(expectedMessage) {
   })
 }
 
+/**
+ * @param {import("atom").TextEditor} textEditor
+ * @returns {Promise<void>}
+ */
 async function makeFixes(textEditor) {
   const editorReloadPromise = new Promise((resolve) => {
     // Subscribe to file reload events
@@ -280,6 +284,10 @@ describe('The eslint provider for Linter', () => {
       rimraf.sync(tempDir)
     })
 
+    /**
+     * @param {import("atom").TextEditor} textEditor
+     * @returns {Promise<void>}
+     */
     async function firstLint(textEditor) {
       const messages = await lint(textEditor)
       // The original file has two errors
@@ -290,7 +298,6 @@ describe('The eslint provider for Linter', () => {
       await firstLint(editor)
       await makeFixes(editor)
       const messagesAfterFixing = await lint(editor)
-
       expect(messagesAfterFixing.length).toBe(0)
     })
 

src/helpers.js

@@ -160,7 +160,7 @@ export async function generateDebugString() {
  * @param  {string} [options.severity='error'] Can be one of: 'error', 'warning', 'info'
  * @param  {string} [options.excerpt=''] Short text to use in the message
  * @param  {string|Function} [options.description] Used to provide additional information
- * @return {Array}            Message to user generated from the parameters
+ * @return {import("atom/linter").Message[]} Message to user generated from the parameters
  */
 export function generateUserMessage(textEditor, options) {
   const {
@@ -182,9 +182,9 @@ export function generateUserMessage(textEditor, options) {
 /**
  * Generates a message to the user in order to nicely display the Error being
  * thrown instead of depending on generic error handling.
- * @param  {TextEditor} textEditor The TextEditor to use to build the message
+ * @param  {import("atom").TextEditor} textEditor The TextEditor to use to build the message
  * @param  {Error} error      Error to generate a message for
- * @return {Array}            Message to user generated from the Error
+ * @return {import("atom/linter").Message[]} Message to user generated from the Error
  */
 export function handleError(textEditor, error) {
   const { stack, message } = error

src/main.js

@@ -173,6 +173,10 @@ module.exports = {
       grammarScopes: scopes,
       scope: 'file',
       lintsOnChange: true,
+      /**
+       * @param {import("atom").TextEditor} textEditor
+       * @returns {Promise<import("atom/linter").Message[]>}
+       */
       lint: async (textEditor) => {
         if (!atom.workspace.isTextEditor(textEditor)) {
           // If we somehow get fed an invalid TextEditor just immediately return