build: migrate to eslint "flat" config

remove airbnb, update eslint

Author: justinmk

.eslintignore

@@ -1,27 +1,23 @@
-import js from '@eslint/js';
 import globals from 'globals';
 import typescriptEslint from '@typescript-eslint/eslint-plugin';
 import typescriptParser from '@typescript-eslint/parser';
 import unicorn from 'eslint-plugin-unicorn';
 import importPlugin from 'eslint-plugin-import';
-import prettierConfig from 'eslint-config-prettier/flat';
 
 export default [
-  js.configs.recommended,
-  typescriptEslint.configs.recommended,
-  unicorn.configs.recommended,
-  prettierConfig,
   {
-    files: ['**/*.ts', '**/*.js'],
+    files: ['packages/neovim/bin/cli.js', '**/*.ts'],
     ignores: [
+      '**/*.d.ts',
       '.eslintrc.js',
-      'packages/*/lib/',
-      'packages/*/bin/',
+      'packages/*/lib/**',
+      'packages/*/bin/**',
       'packages/neovim/scripts/',
       'packages/integration-tests/__tests__/',
-      'examples/rplugin/node/',
-      'packages/example-plugin/',
-      'packages/example-plugin-decorators/',
+      '__tests__/integration/rplugin/node/',
+      'examples/rplugin/node/**',
+      'packages/example-plugin/**',
+      'packages/example-plugin-decorators/**',
     ],
     languageOptions: {
       parser: typescriptParser,
@@ -37,15 +33,16 @@ export default [
       },
     },
     plugins: {
+      '@typescript-eslint': typescriptEslint,
+      unicorn,
       import: importPlugin,
     },
-    settings: {
-      'import/resolver': { node: { extensions: ['.js', '.jsx', '.ts'] } },
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
     },
-    reportUnusedDisableDirectives: true,
     rules: {
-    curly: 'error', // Enforce braces on "if"/"for"/etc.
-    // Avoid accidental use of "==" instead of "===".
+      curly: 'error', // Enforce braces on "if"/"for"/etc.
+      // Avoid accidental use of "==" instead of "===".
       eqeqeq: 'error',
       camelcase: ['error', { properties: 'never' }],
       'class-methods-use-this': 'off',
@@ -68,21 +65,30 @@ export default [
       'max-classes-per-file': 'off',
       'operator-assignment': ['error', 'never'],
 
-    // For overloading (and typescript throws when dupe members anyway)
+      // For overloading (and typescript throws when dupe members anyway)
       'no-dupe-class-members': 'off',
 
-    // Causes issues with enums
+      // Causes issues with enums
       'no-shadow': 'off',
-    'prefer-destructuring': 'off', // Intentionally disabled trash.
+      'prefer-destructuring': 'off', // Intentionally disabled trash.
 
       'import/extensions': 'off',
       'import/prefer-default-export': 'off',
 
+      'global-require': 'error',
+      'import/no-extraneous-dependencies': 'error',
+      'import/no-mutable-exports': 'error',
+      'new-cap': 'error',
+      'no-console': 'error',
+      'no-param-reassign': ['error', { props: true }],
+      'no-void': 'error',
+
+      '@typescript-eslint/no-misused-new': 'error',
       '@typescript-eslint/no-namespace': 'error',
-    // TODO: '@typescript-eslint/no-floating-promises': 'error', // Promises must catch errors or be awaited.
-    // TODO? '@typescript-eslint/no-unsafe-assignment': 'error',
-    // TODO? '@typescript-eslint/no-unsafe-return': 'error',
-    // TODO? '@typescript-eslint/no-unsafe-call': 'error',
+      // TODO: '@typescript-eslint/no-floating-promises': 'error', // Promises must catch errors or be awaited.
+      // TODO? '@typescript-eslint/no-unsafe-assignment': 'error',
+      // TODO? '@typescript-eslint/no-unsafe-return': 'error',
+      // TODO? '@typescript-eslint/no-unsafe-call': 'error',
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/explicit-member-accessibility': 'off',
       '@typescript-eslint/no-unused-vars': 'error',
@@ -91,15 +97,15 @@ export default [
       '@typescript-eslint/ban-types': 'off',
       '@typescript-eslint/explicit-module-boundary-types': 'off',
 
-    // Rules from https://github.com/sindresorhus/eslint-plugin-unicorn
-    // TODO: 'unicorn/no-useless-promise-resolve-reject': 'error',
-    // TODO: 'unicorn/prefer-event-target': 'error',
-    // TODO: 'unicorn/prefer-string-slice': 'error',
-    // TODO? 'unicorn/custom-error-definition': 'error',
-    // TODO? 'unicorn/prefer-json-parse-buffer': 'error',
-    // TODO? ESM modules https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-module.md
-    // 'unicorn/prefer-module': 'error',
-    // 'unicorn/no-null': 'error',
+      // Rules from https://github.com/sindresorhus/eslint-plugin-unicorn
+      // TODO: 'unicorn/no-useless-promise-resolve-reject': 'error',
+      // TODO: 'unicorn/prefer-event-target': 'error',
+      // TODO: 'unicorn/prefer-string-slice': 'error',
+      // TODO? 'unicorn/custom-error-definition': 'error',
+      // TODO? 'unicorn/prefer-json-parse-buffer': 'error',
+      // TODO? ESM modules https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-module.md
+      // 'unicorn/prefer-module': 'error',
+      // 'unicorn/no-null': 'error',
       'unicorn/no-abusive-eslint-disable': 'error',
       'unicorn/prefer-at': 'error',
       'unicorn/prefer-negative-index': 'error',
@@ -134,6 +140,7 @@ export default [
       // `jest` against the compiled .js results (would require compiling
       // the test files as well)?
       'unicorn/prefer-at': 'off',
+      'new-cap': 'off',
       'import/no-extraneous-dependencies': [
         'error',
         { devDependencies: true, optionalDependencies: false, peerDependencies: false },

eslint.config.mjs

@@ -32,8 +32,8 @@
     "test-staged": "npm run test-staged --workspaces --if-present -- --",
     "test-missing-apis": "npm run test-missing-apis --workspaces --if-present",
     "test-lint": "npm run lint",
-    "lint": "prettier --check . && eslint --format=unix .",
-    "fixlint": "prettier --write . && eslint --fix --format=unix ."
+    "lint": "prettier --check . && eslint --format=unix --ignore-pattern 'packages/example*/**' --ignore-pattern 'packages/neovim/lib/**/*.js' .",
+    "fixlint": "prettier --write . && eslint --fix --format=unix --ignore-pattern 'packages/example*/**' --ignore-pattern 'packages/neovim/lib/**/*.js' ."
   },
   "husky": {
     "hooks": {

package.json

@@ -62,6 +62,7 @@ describe('Node host', () => {
 
   it('console.log is monkey-patched to logger.info #329', async () => {
     const spy = jestMock.spyOn(nvim.logger, 'info');
+    // eslint-disable-next-line no-console
     console.log('log message');
     expect(spy).toHaveBeenCalledWith('log message');
     // Still alive?

packages/integration-tests/__tests__/integration.test.ts

@@ -1,14 +1,12 @@
 #!/usr/bin/env node
 const { Host } = require('../lib/host');
-const { spawnSync } = require('child_process');
+const { spawnSync } = require('node:child_process');
 
 // node <current script> <rest of args>
 const [, , ...args] = process.argv;
 
 if (args[0] === '--version') {
-  // eslint-disable-next-line global-require
   const pkg = require('../package.json');
-  // eslint-disable-next-line no-console
   console.log(pkg.version);
   process.exit(0);
 }

packages/neovim/bin/cli.js

@@ -5,7 +5,7 @@ async function main() {
   const nvim = await require('./nvim');
   const results = await nvim.requestApi();
   const { functions } = results[1];
-  const lines = functions.filter(({ name }) => name.indexOf(search) > -1);
+  const lines = functions.filter(({ name }) => name.includes(search));
   lines
     .filter(metadata => typeof metadata.deprecated_since === 'undefined')
     .forEach(metadata => {

packages/neovim/scripts/api.js

@@ -56,7 +56,9 @@ const hasApiMethod = name => {
   const descriptor = Object.getOwnPropertyDescriptor(Constructor.prototype, methodName);
 
   // check property descriptors
-  if (descriptor && ((isSetter && descriptor.set) || (isGetter && descriptor.get))) return true;
+  if (descriptor && ((isSetter && descriptor.set) || (isGetter && descriptor.get))) {
+    return true;
+  }
 
   // check methods
   if (
@@ -82,7 +84,7 @@ async function main() {
   const nvim = await require('./nvim');
   const results = await nvim.requestApi();
   const { functions } = results[1];
-  const lines = functions.filter(({ name }) => name.indexOf(search) > -1);
+  const lines = functions.filter(({ name }) => name.includes(search));
   const missing = lines
     .filter(metadata => typeof metadata.deprecated_since === 'undefined')
     .filter(metadata => !hasApiMethod(metadata.name));

packages/neovim/scripts/findMissingApi.js

@@ -1,4 +1,4 @@
-const cp = require('child_process');
+const cp = require('node:child_process');
 const { attach } = require('../lib/attach');
 
 const proc = cp.spawn('nvim', ['-u', 'NONE', '--embed', '-n'], {
@@ -14,11 +14,15 @@ const typeMap = {
 };
 
 function convertType(type) {
-  if (typeMap[type]) return typeMap[type];
+  if (typeMap[type]) {
+    return typeMap[type];
+  }
   const genericMatch = /Of\((\w+)[^)]*\)/.exec(type);
   if (genericMatch) {
     const t = convertType(genericMatch[1]);
-    if (/^Array/.test(type)) return `Array<${t}>`;
+    if (/^Array/.test(type)) {
+      return `Array<${t}>`;
+    }
     return `{ [key: string]: ${t}; }`;
   }
   return type;
@@ -34,7 +38,7 @@ function metadataToSignature(method) {
     params.push(`${method.parameters[i]}: ${type}`);
   });
   const rtype = convertType(method.returnType);
-  // eslint-disable-next-line
+
   const returnTypeString = rtype === 'void' ? rtype : `Promise<${rtype}>`;
   return `  ${method.name}(${params.join(', ')}): ${returnTypeString};\n`;
 }
@@ -85,7 +89,6 @@ async function main() {
 try {
   main();
 } catch (err) {
-  // eslint-disable-next-line no-console
   console.error(err);
   process.exit(1);
 }

packages/neovim/bin/generate-typescript-interfaces.js renamed to packages/neovim/scripts/generate-typescript-interfaces.js

@@ -4,7 +4,7 @@
  * Spawns an embedded neovim instance and returns Neovim API
  */
 
-const cp = require('child_process');
+const cp = require('node:child_process');
 const { attach } = require('../');
 // const inspect = require('util').inspect;
 

packages/neovim/scripts/nvim.js

@@ -55,7 +55,7 @@ export class BaseApi extends EventEmitter {
   equals(other: BaseApi): boolean {
     try {
       return String(this.data) === String(other.data);
-    } catch (e) {
+    } catch {
       return false;
     }
   }