feat: fix types and use tsd

Author: shadowgate15

.xo-config.js

@@ -15,28 +15,34 @@ module.exports = {
     'unicorn/prefer-logical-operator-over-ternary': 'warn'
   },
   overrides: [
+    {
+      files: '**/*.mjs',
+      parserOptions: {
+        sourceType: 'module'
+      }
+    },
     {
       files: 'test/jobs/*.js',
       rules: {
         'unicorn/no-process-exit': 'off'
       }
     },
     {
-      files: ['*.ts', '**/*.ts'],
-      parserOptions: {
-        project: 'types/tsconfig.json'
-      },
+      files: ['**/*.d.ts'],
+      rules: {
+        'no-unused-vars': 'off',
+        '@typescript-eslint/naming-convention': 'off',
+        'no-redeclare': 'off',
+        '@typescript-eslint/no-redeclare': 'off'
+      }
+    },
+    {
+      files: ['**/*.test-d.ts'],
       rules: {
-        'no-redeclare': 'warn',
-        'no-unused-vars': 'warn',
-        '@typescript-eslint/no-unsafe-assignment': 'warn',
-        '@typescript-eslint/no-unsafe-call': 'warn',
-        '@typescript-eslint/no-unused-vars': 'warn',
-        '@typescript-eslint/no-empty-function': 'warn',
-        '@typescript-eslint/consistent-type-definitions': 'off',
-        '@typescript-eslint/consistent-type-imports': 'off'
+        '@typescript-eslint/no-unsafe-call': 'off',
+        '@typescript-eslint/no-confusing-void-expression': 'off', // Conflicts with `expectError` assertion.
+        '@typescript-eslint/no-unsafe-assignment': 'off'
       }
     }
-  ],
-  parser: '@typescript-eslint/parser'
+  ]
 };

package.json

@@ -52,8 +52,7 @@
     "node": ">=12.17.0 <13.0.0-0||>=13.2.0"
   },
   "files": [
-    "src",
-    "types"
+    "src"
   ],
   "homepage": "https://github.com/breejs/bree",
   "keywords": [
@@ -157,5 +156,5 @@
     "test": "npm run ava && tsd",
     "test-coverage": "cross-env NODE_ENV=test nyc npm run test"
   },
-  "types": "types"
+  "types": "src/index.d.ts"
 }

types/index.d.ts renamed to src/index.d.ts

@@ -1,8 +1,8 @@
 // Definitions by: Taylor Schley <https://github.com/shadowgate15>
 
 import { EventEmitter } from 'node:events';
-import { WorkerOptions, Worker } from 'node:worker_threads';
-import { Timeout, Interval } from 'safe-timers';
+import { type WorkerOptions, type Worker } from 'node:worker_threads';
+import { type Timeout, type Interval } from 'safe-timers';
 
 export = Bree;
 
@@ -68,7 +68,7 @@ declare class Bree extends EventEmitter {
 }
 
 declare namespace Bree {
-  interface Job {
+  type Job = {
     name: string;
     path: string | (() => void);
     timeout: number | string | boolean;
@@ -81,11 +81,11 @@ declare namespace Bree {
     worker?: Partial<WorkerOptions>;
     outputWorkerMetadata?: boolean;
     timezone?: string;
-  }
+  };
 
   type JobOptions = Required<Pick<Job, 'name'>> & Partial<Omit<Job, 'name'>>;
 
-  interface BreeConfigs {
+  type BreeConfigs = {
     logger: BreeLogger | boolean;
     root: string | boolean;
     silenceRootCheckError: boolean;
@@ -105,7 +105,7 @@ declare namespace Bree {
     errorHandler?: (error: any, workerMetadata: any) => void;
     workerMessageHandler?: (message: any, workerMetadata: any) => void;
     outputWorkerMetadata: boolean;
-  }
+  };
 
   type BreeOptions = Partial<Omit<BreeConfigs, 'jobs'>> & {
     jobs?: Array<string | (() => void) | JobOptions>;
@@ -115,9 +115,9 @@ declare namespace Bree {
 
   function extend<T = unknown>(plugin: PluginFunc<T>, options?: T): Bree;
 
-  interface BreeLogger {
+  type BreeLogger = {
     info: (...args: any[]) => any;
     warn: (...args: any[]) => any;
     error: (...args: any[]) => any;
-  }
+  };
 }

test-d/index.test-d.ts

@@ -1,7 +1,13 @@
-import { expectType, expectNotType } from 'tsd';
-import Bree from '..';
+import { expectType } from 'tsd';
+import Bree from '../src';
 
 const bree = new Bree({});
 
-expectType<Bree.Constructor>(Bree);
-expectType<Bree.Bree>(bree);
+expectType<Bree>(bree);
+
+expectType<Bree['start']>(bree.start);
+expectType<Bree['stop']>(bree.stop);
+expectType<Bree['run']>(bree.run);
+expectType<Bree['add']>(bree.add);
+expectType<Bree['remove']>(bree.remove);
+expectType<Bree['createWorker']>(bree.createWorker);