chore: lint

Co-authored-by: lukasIO <[email protected]>
livekit · May 17, 2024 · e37a48c · e37a48c
1 parent d085134
commit e37a48c
Show file tree

Hide file tree

Showing 24 changed files with 1,315 additions and 220 deletions.
diff --git a/agents/package.json b/agents/package.json
@@ -8,17 +8,13 @@
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint src",
+    "lint": "eslint -f unix \"src/**/*.ts\"",
     "api:check": "api-extractor run --typescript-compiler-folder ../node_modules/typescript",
     "api:update": "api-extractor run --local --typescript-compiler-folder ../node_modules/typescript --verbose"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.35.0",
-    "@types/ws": "^8.5.10",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "typescript-eslint": "^7.4.0"
+    "@types/ws": "^8.5.10"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"

diff --git a/agents/src/cli.ts b/agents/src/cli.ts
@@ -1,12 +1,11 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { version } from './version.js';
-import { Option, Command } from 'commander';
-import { WorkerOptions, Worker } from './worker.js';
-import { EventEmitter } from 'events';
+import { Command, Option } from 'commander';
+import type { EventEmitter } from 'events';
 import { log } from './log.js';
+import { version } from './version.js';
+import { Worker, type WorkerOptions } from './worker.js';
 
 type CliArgs = {
   opts: WorkerOptions;

diff --git a/agents/src/http_server.ts b/agents/src/http_server.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { createServer, ServerResponse, Server, IncomingMessage } from 'http';
+import { type IncomingMessage, type Server, type ServerResponse, createServer } from 'http';
 
 const healthCheck = async (res: ServerResponse) => {
   res.writeHead(200);

diff --git a/agents/src/index.ts b/agents/src/index.ts
@@ -1,6 +1,9 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
+import * as cli from './cli.js';
+import * as stt from './stt/index.js';
+import * as tts from './tts/index.js';
 
 export * from './vad.js';
 export * from './plugin.js';
@@ -10,6 +13,5 @@ export * from './job_request.js';
 export * from './worker.js';
 export * from './utils.js';
 export * from './log.js';
-export * as cli from './cli.js';
-export * as stt from './stt/index.js';
-export * as tts from './tts/index.js';
+
+export { cli, stt, tts };
diff --git a/agents/src/ipc/job_main.ts b/agents/src/ipc/job_main.ts
@@ -1,14 +1,13 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { IPC_MESSAGE, JobMainArgs, Message, Ping } from './protocol.js';
+import { type JobAssignment, ServerMessage } from '@livekit/protocol';
 import { Room } from '@livekit/rtc-node';
+import { type ChildProcess, fork } from 'child_process';
 import { EventEmitter, once } from 'events';
 import { JobContext } from '../job_context.js';
 import { log } from '../log.js';
-import { ChildProcess, fork } from 'child_process';
-import { JobAssignment, ServerMessage } from '@livekit/protocol';
+import { IPC_MESSAGE, type JobMainArgs, type Message, type Ping } from './protocol.js';
 
 export const runJob = (args: JobMainArgs): ChildProcess => {
   return fork(__filename, [args.raw, args.entry, args.fallbackURL]);

diff --git a/agents/src/ipc/job_process.ts b/agents/src/ipc/job_process.ts
@@ -1,15 +1,20 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { Job } from '@livekit/protocol';
-import { IPC_MESSAGE, JobMainArgs, Message, Pong, StartJobResponse } from './protocol.js';
-import { runJob } from './job_main.js';
+import type { Job } from '@livekit/protocol';
+import type { ChildProcess } from 'child_process';
 import { once } from 'events';
+import type { Logger } from 'pino';
+import type { AcceptData } from '../job_request.js';
 import { log } from '../log.js';
-import { Logger } from 'pino';
-import { AcceptData } from '../job_request.js';
-import { ChildProcess } from 'child_process';
+import { runJob } from './job_main.js';
+import {
+  IPC_MESSAGE,
+  type JobMainArgs,
+  type Message,
+  type Pong,
+  type StartJobResponse,
+} from './protocol.js';
 
 const START_TIMEOUT = 90 * 1000;
 const PING_INTERVAL = 5 * 1000;
@@ -21,9 +26,9 @@ export class JobProcess {
   args: JobMainArgs;
   logger: Logger;
   process?: ChildProcess;
-  startTimeout?: Timer;
-  pongTimeout?: Timer;
-  pingInterval?: Timer;
+  startTimeout?: ReturnType<typeof setTimeout>;
+  pongTimeout?: ReturnType<typeof setTimeout>;
+  pingInterval?: ReturnType<typeof setInterval>;
 
   constructor(job: Job, acceptData: AcceptData, raw: string, fallbackURL: string) {
     this.#job = job;

diff --git a/agents/src/job_context.ts b/agents/src/job_context.ts
@@ -1,10 +1,9 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { Room, LocalParticipant, RemoteParticipant } from '@livekit/rtc-node';
-import { Job } from '@livekit/protocol';
-import { EventEmitter } from 'events';
+import type { Job } from '@livekit/protocol';
+import type { LocalParticipant, RemoteParticipant, Room } from '@livekit/rtc-node';
+import type { EventEmitter } from 'events';
 
 export class JobContext {
   #job: Job;

diff --git a/agents/src/job_request.ts b/agents/src/job_request.ts
@@ -1,10 +1,9 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { Job, ParticipantInfo, Room } from '@livekit/protocol';
-import { log } from './log.js';
+import type { Job, ParticipantInfo, Room } from '@livekit/protocol';
 import { EventEmitter } from 'events';
+import { log } from './log.js';
 
 class AnsweredError extends Error {
   constructor() {

diff --git a/agents/src/log.ts b/agents/src/log.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import pino from 'pino';
+import { pino } from 'pino';
 
 export const log = pino({
   transport: {

diff --git a/agents/src/stt/stream_adapter.ts b/agents/src/stt/stream_adapter.ts
@@ -1,11 +1,10 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
+import type { AudioFrame } from '@livekit/rtc-node';
+import { type AudioBuffer, mergeFrames } from '../utils.js';
+import { VADEventType, type VADStream } from '../vad.js';
 import { STT, SpeechEvent, SpeechEventType, SpeechStream } from './stt.js';
-import { VADEventType, VADStream } from '../vad.js';
-import { AudioFrame } from '@livekit/rtc-node';
-import { AudioBuffer, mergeFrames } from '../utils.js';
 
 export class StreamAdapterWrapper extends SpeechStream {
   closed: boolean;

diff --git a/agents/src/stt/stt.ts b/agents/src/stt/stt.ts
@@ -1,9 +1,8 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { AudioFrame } from '@livekit/rtc-node';
-import { AudioBuffer } from '../utils.js';
+import type { AudioFrame } from '@livekit/rtc-node';
+import type { AudioBuffer } from '../utils.js';
 
 export enum SpeechEventType {
   START_OF_SPEECH = 0,

diff --git a/agents/src/tts/index.ts b/agents/src/tts/index.ts
@@ -1,12 +1,21 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
+import { StreamAdapter, StreamAdapterWrapper } from './stream_adapter.js';
+import {
+  SynthesisEvent,
+  SynthesisEventType,
+  SynthesizeStream,
+  type SynthesizedAudio,
+  TTS,
+} from './tts.js';
 
 export {
   TTS,
   SynthesisEvent,
   SynthesisEventType,
   SynthesizedAudio,
   SynthesizeStream,
-} from './tts.js';
-export { StreamAdapter, StreamAdapterWrapper } from './stream_adapter.js';
+  StreamAdapter,
+  StreamAdapterWrapper,
+};
diff --git a/agents/src/tts/stream_adapter.ts b/agents/src/tts/stream_adapter.ts
@@ -1,15 +1,14 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
+import type { SentenceStream, SentenceTokenizer } from '../tokenize.js';
 import {
-  TTS,
   SynthesisEvent,
   SynthesisEventType,
-  SynthesizedAudio,
   SynthesizeStream,
+  type SynthesizedAudio,
+  TTS,
 } from './tts.js';
-import { SentenceStream, SentenceTokenizer } from '../tokenize.js';
 
 export class StreamAdapterWrapper extends SynthesizeStream {
   closed: boolean;

diff --git a/agents/src/tts/tts.ts b/agents/src/tts/tts.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { AudioFrame } from '@livekit/rtc-node';
+import type { AudioFrame } from '@livekit/rtc-node';
 
 export interface SynthesizedAudio {
   text: string;

diff --git a/agents/src/utils.ts b/agents/src/utils.ts
@@ -1,7 +1,6 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
 import { AudioFrame } from '@livekit/rtc-node';
 
 export type AudioBuffer = AudioFrame[] | AudioFrame;

diff --git a/agents/src/vad.ts b/agents/src/vad.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { AudioFrame } from '@livekit/rtc-node';
+import type { AudioFrame } from '@livekit/rtc-node';
 
 export enum VADEventType {
   START_OF_SPEECH = 1,

diff --git a/agents/src/worker.ts b/agents/src/worker.ts
@@ -1,26 +1,25 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import os from 'os';
-import { WebSocket } from 'ws';
-import { AvailRes, JobRequest } from './job_request.js';
 import {
+  type AvailabilityRequest,
+  type Job,
+  type JobAssignment,
   JobType,
-  Job,
-  WorkerMessage,
   ParticipantPermission,
   ServerMessage,
-  AvailabilityRequest,
-  JobAssignment,
+  WorkerMessage,
 } from '@livekit/protocol';
-import { AcceptData } from './job_request.js';
+import { EventEmitter } from 'events';
+import { AccessToken } from 'livekit-server-sdk';
+import os from 'os';
+import { WebSocket } from 'ws';
 import { HTTPServer } from './http_server.js';
+import { JobProcess } from './ipc/job_process.js';
+import { type AvailRes, JobRequest } from './job_request.js';
+import type { AcceptData } from './job_request.js';
 import { log } from './log.js';
 import { version } from './version.js';
-import { AccessToken } from 'livekit-server-sdk';
-import { EventEmitter } from 'events';
-import { JobProcess } from './ipc/job_process.js';
 
 const MAX_RECONNECT_ATTEMPTS = 10;
 const ASSIGNMENT_TIMEOUT = 15 * 1000;

diff --git a/examples/package.json b/examples/package.json
@@ -4,10 +4,7 @@
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint src"
-  },
-  "devDependencies": {
-    "@types/bun": "latest"
+    "lint": "eslint -f unix \"src/**/*.ts\""
   },
   "peerDependencies": {
     "typescript": "^5.0.0"

diff --git a/examples/src/minimal.ts b/examples/src/minimal.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { cli, JobContext, JobRequest, WorkerOptions } from '@livekit/agents';
+import { type JobContext, type JobRequest, WorkerOptions, cli } from '@livekit/agents';
 import { fileURLToPath } from 'url';
 
 // your entry file *has* to include an exported function [entry].

diff --git a/examples/src/tts.ts b/examples/src/tts.ts
@@ -1,8 +1,7 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { cli, JobContext, JobRequest, log, WorkerOptions } from '@livekit/agents';
+import { type JobContext, type JobRequest, WorkerOptions, cli, log } from '@livekit/agents';
 import { TTS } from '@livekit/agents-plugin-elevenlabs';
 import { AudioSource, LocalAudioTrack, TrackPublishOptions, TrackSource } from '@livekit/rtc-node';
 import { fileURLToPath } from 'url';

diff --git a/package.json b/package.json
@@ -8,6 +8,8 @@
     "build:plugins": "turbo run build --filter=@livekit/agents-plugin-*...",
     "api:check": "turbo run api:check",
     "api:update": "turbo run api:update",
+    "format:check": "prettier --check \"**/src/**/*.{ts,tsx,md,json}\"",
+    "format:write": "prettier --write \"**/src/**/*.{ts,tsx,md,json}\"",
     "lint": "turbo lint",
     "test": "vitest run",
     "test:watch": "vitest"
@@ -16,6 +18,20 @@
     "@changesets/cli": "^2.27.1",
     "@livekit/changesets-changelog-github": "^0.0.4",
     "@rushstack/heft": "^0.66.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "^8.56.0",
+    "eslint-config-next": "^14.1.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-turbo": "^1.12.2",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-standard": "^5.0.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^3.2.5",
     "turbo": "^1.13.3",
     "typescript": "5.4.5",

diff --git a/plugins/elevenlabs/package.json b/plugins/elevenlabs/package.json
@@ -8,17 +8,13 @@
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint src",
+    "lint": "eslint -f unix \"src/**/*.{ts,js}\"",
     "api:check": "api-extractor run --typescript-compiler-folder ../../node_modules/typescript",
     "api:update": "api-extractor run --local --typescript-compiler-folder ../../node_modules/typescript --verbose"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.35.0",
-    "@types/ws": "^8.5.10",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "typescript-eslint": "^7.4.0"
+    "@types/ws": "^8.5.10"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"

diff --git a/plugins/elevenlabs/src/tts.ts b/plugins/elevenlabs/src/tts.ts
@@ -1,12 +1,11 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-
-import { TTSModels } from './models.js';
 import { log, tts } from '@livekit/agents';
-import { RawData, WebSocket } from 'ws';
-import { URL } from 'url';
 import { AudioFrame } from '@livekit/rtc-node';
+import { URL } from 'url';
+import { type RawData, WebSocket } from 'ws';
+import type { TTSModels } from './models.js';
 
 type Voice = {
   id: string;