Merge #338 build: enforce type checks, fix type errors

Author: justinmk

packages/decorators/src/plugin/autocmd.ts

@@ -12,14 +12,15 @@ export function Autocmd(name: string, options?: AutocmdOptions) {
       pattern: '',
     };
 
+    // @ts-expect-error changing `option: keyof …` to `option: string` causes other errors.
     ['pattern', 'eval'].forEach((option: keyof AutocmdOptions) => {
       if (options && typeof options[option] !== 'undefined') {
         (opts[option] as any) = options[option];
       }
     });
 
     const nameWithPattern = `${name}${
-      options.pattern ? `:${options.pattern}` : ''
+      options?.pattern ? `:${options.pattern}` : ''
     }`;
     Object.defineProperty(f, NVIM_METHOD_NAME, {
       value: `autocmd:${nameWithPattern}`,

packages/decorators/src/plugin/command.ts

@@ -12,6 +12,7 @@ export function Command(name: string, options?: CommandOptions) {
     const f = isMethod ? cls[methodName] : cls;
     const opts: CommandOptions = {};
 
+    // @ts-expect-error changing `option: keyof …` to `option: string` causes other errors.
     ['range', 'nargs', 'complete'].forEach((option: keyof CommandOptions) => {
       if (options && typeof options[option] !== 'undefined') {
         (opts[option] as any) = options[option];

packages/decorators/src/plugin/plugin.ts

@@ -30,7 +30,7 @@ export interface PluginWrapperConstructor {
 }
 function wrapper(cls: PluginWrapperConstructor, options?: PluginOptions): any {
   return class WrapperClass extends cls implements PluginWrapperInterface {
-    public nvim: Neovim;
+    public nvim!: Neovim;
 
     constructor(plugin: NvimPlugin) {
       super(plugin.nvim, plugin);
@@ -57,7 +57,11 @@ function wrapper(cls: PluginWrapperConstructor, options?: PluginOptions): any {
                 autoCmdOpts.eval = spec.opts.eval;
               }
 
-              plugin.registerAutocmd(spec.name, [this, method], autoCmdOpts);
+              plugin.registerAutocmd(
+                spec.name,
+                [this, method],
+                autoCmdOpts as any
+              );
               break;
             case 'command':
               const cmdOpts: CommandOptions = {
@@ -94,7 +98,7 @@ function wrapper(cls: PluginWrapperConstructor, options?: PluginOptions): any {
       });
     }
 
-    setApi(nvim: Neovim) {
+    override setApi(nvim: Neovim) {
       this.nvim = nvim;
     }
   };

packages/decorators/src/plugin/types.ts

@@ -5,7 +5,7 @@ export interface FunctionOptions {
 }
 
 export interface AutocmdOptions {
-  pattern: string;
+  pattern?: string;
   eval?: string;
   sync?: boolean;
 }

packages/neovim/src/api/Base.ts

@@ -6,7 +6,7 @@ import { Logger, getLogger } from '../utils/logger';
 import { VimValue } from '../types/VimValue';
 
 export interface BaseConstructorOptions {
-  transport?: Transport;
+  transport: Transport;
   logger?: Logger;
   data?: Buffer;
   metadata?: any;
@@ -28,13 +28,13 @@ const DO_REQUEST = Symbol('DO_REQUEST');
 export class BaseApi extends EventEmitter {
   protected transport: Transport;
 
-  protected _isReady: Promise<boolean>;
+  protected _isReady: Promise<boolean> = Promise.resolve(false);
 
-  protected prefix: string;
+  protected prefix!: string;
 
   public logger: Logger;
 
-  public data: Buffer | number;
+  public data?: Buffer | number;
 
   // Node Buffer
   protected client: any;
@@ -48,7 +48,7 @@ export class BaseApi extends EventEmitter {
   }: BaseConstructorOptions) {
     super();
 
-    this.setTransport(transport);
+    this.transport = transport;
     this.data = data;
     this.logger = logger || getLogger();
     this.client = client;
@@ -58,10 +58,6 @@ export class BaseApi extends EventEmitter {
     }
   }
 
-  protected setTransport(transport: Transport): void {
-    this.transport = transport;
-  }
-
   equals(other: BaseApi): boolean {
     try {
       return String(this.data) === String(other.data);

packages/neovim/src/api/Buffer.ts

@@ -32,7 +32,7 @@ export const DETACH = Symbol('detachBuffer');
 export const ATTACH = Symbol('attachBuffer');
 
 export class Buffer extends BaseApi {
-  public prefix: string = Metadata[ExtType.Buffer].prefix;
+  public override prefix: string = Metadata[ExtType.Buffer].prefix;
 
   public get isAttached(): boolean {
     return this.client.isAttached(this);
@@ -106,9 +106,9 @@ export class Buffer extends BaseApi {
       strictIndexing: true,
     }
   ) {
-    // TODO: Error checking
-    // if (typeof start === 'undefined' || typeof end === 'undefined') {
-    // }
+    if (_start === undefined || _end === undefined) {
+      throw new Error('start and end are required');
+    }
     const indexing =
       typeof strictIndexing === 'undefined' ? true : strictIndexing;
     const lines = typeof _lines === 'string' ? [_lines] : _lines;

packages/neovim/src/api/Neovim.test.ts

@@ -1,6 +1,5 @@
 /* eslint-env jest */
 import * as path from 'node:path';
-import { Neovim } from './Neovim';
 import * as testUtil from '../testUtil';
 
 describe('Neovim API', () => {
@@ -14,14 +13,6 @@ describe('Neovim API', () => {
     testUtil.stopNvim();
   });
 
-  it('sets transport when initialized', () => {
-    const transport = {};
-    const spy = jest.spyOn(Neovim.prototype, 'setTransport');
-    const neovim = new Neovim({ transport });
-    expect(spy).toHaveBeenCalledWith(transport);
-    expect(neovim.transport).toBe(transport);
-  });
-
   describe('Normal API calls', () => {
     it('gets a list of buffers and switches buffers', async () => {
       const buffers = await nvim.buffers;

packages/neovim/src/api/Neovim.ts

@@ -128,7 +128,7 @@ export interface OpenWindowOptions {
  * Neovim API
  */
 export class Neovim extends BaseApi {
-  protected prefix = 'nvim_';
+  protected override prefix = 'nvim_';
 
   public Buffer = Buffer;
 
@@ -202,8 +202,8 @@ export class Neovim extends BaseApi {
   /**
    * Gets a map of buffer-local |user-commands|.
    *
-   * @param {Object} options Optional parameters (currently not used)
-   * @return {Object} Map of maps describing commands
+   * @param options Optional parameters (currently not used)
+   * @return Map of maps describing commands
    */
   getCommands(options = {}): Promise<Command> {
     return this.request(`${this.prefix}get_commands`, [options]);
@@ -248,7 +248,7 @@ export class Neovim extends BaseApi {
   /**
    * Gets the current window
    *
-   * @return {Window} Window handle
+   * @return Window handle
    */
   get window(): AsyncWindow {
     return this.getWindow();
@@ -257,7 +257,7 @@ export class Neovim extends BaseApi {
   /**
    * Sets the current window
    *
-   * @param {Window} Window handle
+   * @param win Window handle
    */
   set window(win: AsyncWindow) {
     if (win instanceof Window) this.setWindow(win);
@@ -287,7 +287,7 @@ export class Neovim extends BaseApi {
   /**
    * Sets the current window
    *
-   * @param {Window} Window handle
+   * @param win Window handle
    */
   setWindow(win: Window) {
     // Throw error if win is not instance of Window?
@@ -306,7 +306,7 @@ export class Neovim extends BaseApi {
   /**
    * Changes the global working directory
    *
-   * @param {String} Directory path
+   * @param dir Directory path
    *
    */
   set dir(dir: string) {
@@ -365,7 +365,7 @@ export class Neovim extends BaseApi {
   /**
    * Gets the current mode. |mode()| "blocking" is true if Nvim is waiting for input.
    *
-   * @return {Object} Dictionary { "mode": String, "blocking": Boolean }
+   * @return Mode info
    */
   get mode(): Promise<{ mode: string; blocking: boolean }> {
     return this.request(`${this.prefix}get_mode`);
@@ -374,7 +374,7 @@ export class Neovim extends BaseApi {
   /**
    * Gets map of defined colors
    *
-   * @return {Object} Color map
+   * @return Color map
    */
   get colorMap(): Promise<{ [name: string]: number }> {
     return this.request(`${this.prefix}get_color_map`);
@@ -383,8 +383,8 @@ export class Neovim extends BaseApi {
   /**
    * Get color by name
    *
-   * @param {String} name Color name
-   * @return {Number} Color value
+   * @param name Color name
+   * @return Color value
    */
   getColorByName(name: string): Promise<number> {
     return this.request(`${this.prefix}get_color_by_name`, [name]);
@@ -393,9 +393,9 @@ export class Neovim extends BaseApi {
   /**
    * Get highlight by name or id
    *
-   * @param {String|Number} nameOrId Name or ID
-   * @param {Boolean} isRgb Should export RGB colors
-   * @return {Object} Highlight definition map
+   * @param nameOrId Name or ID
+   * @param isRgb Should export RGB colors
+   * @return Highlight definition map
    */
   getHighlight(
     nameOrId: string | number,
@@ -411,9 +411,9 @@ export class Neovim extends BaseApi {
   /**
    * Get highlight definition by name
    *
-   * @param {String} name Highlight group name
-   * @param {Boolean} isRgb Should export RGB colors
-   * @return {Object} Highlight definition map
+   * @param name Highlight group name
+   * @param isRgb Should export RGB colors
+   * @return Highlight definition map
    */
   getHighlightByName(name: string, isRgb = true): Promise<object> {
     return this.request(`${this.prefix}get_hl_by_name`, [name, isRgb]);
@@ -422,9 +422,9 @@ export class Neovim extends BaseApi {
   /**
    * Get highlight definition by id |hlID()|
    *
-   * @param {Number} id Highlight id as returned by |hlID()|
-   * @param {Boolean} isRgb Should export RGB colors
-   * @return {Object} Highlight definition map
+   * @param id Highlight id as returned by |hlID()|
+   * @param isRgb Should export RGB colors
+   * @return Highlight definition map
    */
   getHighlightById(id: number, isRgb = true): Promise<object> {
     return this.request(`${this.prefix}get_hl_by_id`, [id, isRgb]);
@@ -839,8 +839,8 @@ export class Neovim extends BaseApi {
    * existing namespace, the associated id is returned. If `name`
    * is an empty string a new, anonymous namespace is created.
    *
-   * @param {String} name Namespace name or empty string
-   * @return {Number} Namespace id
+   * @param name Namespace name or empty string
+   * @return Namespace id
    */
   createNamespace(name = ''): Promise<number> {
     return this.request(`${this.prefix}create_namespace`, [name]);
@@ -962,10 +962,9 @@ export class Neovim extends BaseApi {
    * and `relative` must be reconfigured together. Only changing a
    * subset of these is an error.
    *
-   * @param {Window}  window Window handle
-   * @param {Number}  width  Width of window (in character cells)
-   * @param {Number}  height Height of window (in character cells)
-   * @Param {Object}  options Options object
+   * @param window Window handle
+   * @param options height, width of window (in character cells)
+   * @Param Options object
    */
   private winConfig(window: Window, options: object = {}) {
     return window.config(options);

packages/neovim/src/api/Tabpage.ts

@@ -4,7 +4,7 @@ import { createChainableApi } from './utils/createChainableApi';
 import { Window, AsyncWindow } from './Window';
 
 export class Tabpage extends BaseApi {
-  public prefix: string = Metadata[ExtType.Tabpage].prefix;
+  public override prefix: string = Metadata[ExtType.Tabpage].prefix;
 
   /** Returns all windows of tabpage */
   get windows(): Promise<Window[]> {
@@ -30,12 +30,12 @@ export class Tabpage extends BaseApi {
   }
 
   /** Invalid */
-  getOption(): void {
+  override getOption(): void {
     this.logger.error('Tabpage does not have `getOption`');
   }
 
   /** Invalid */
-  setOption(): void {
+  override setOption(): void {
     this.logger.error('Tabpage does not have `setOption`');
   }
 }

packages/neovim/src/api/Window.ts

@@ -5,7 +5,7 @@ import { Tabpage, AsyncTabpage } from './Tabpage';
 import { Buffer, AsyncBuffer } from './Buffer';
 
 export class Window extends BaseApi {
-  public prefix: string = Metadata[ExtType.Window].prefix;
+  public override prefix: string = Metadata[ExtType.Window].prefix;
 
   /**
    * The windowid that not change within a Vim session