refactor: move ShortcutManager types to the types/common file

Author: thetutlage

README.md

@@ -50,17 +50,7 @@ const devServer = new DevServer(appRoot, {
       pattern: 'resources/views/**/*.edge',
       reloadServer: false,
     }
-  ],
-
-  /**
-   * The assets bundler process to start
-   */
-  assets: {
-    enabled: true,
-    name: 'vite',
-    cmd: 'vite',
-    args: []
-  }
+  ]
 })
 
 devServer.onError((error) => {
@@ -87,9 +77,6 @@ await devServer.start()
 ## Test runner
 The `TestRunner` is used to execute the `bin/test.ts` file of your AdonisJS application. Like the `DevServer`, the `TestRunner` allows you to watch for file changes and re-run the tests. The following steps are taken to re-run tests in watch mode.
 
-> [!NOTE]  
-> Read [Using a file watcher](#using-a-file-watcher) section to understand which files are watched by the file watcher.
-
 - If the changed file is a test file, only tests for that file will be re-run.
 - Otherwise, all tests will re-run with respect to the initial filters applied when running the `node ace test` command.
 
@@ -176,17 +163,6 @@ const bundler = new Bundler(appRoot, ts, {
       reloadServer: false,
     }
   ],
-
-  /**
-   * The assets bundler to use to bundle the frontend
-   * assets
-   */
-  assets: {
-    enabled: true,
-    name: 'vite',
-    cmd: 'vite',
-    args: ['build']
-  }
 })
 ```
 

src/shortcuts_manager.ts

@@ -7,33 +7,12 @@
  * file that was distributed with this source code.
  */
 
-import type { Logger } from '@poppinss/cliui'
-
-/**
- * Keyboard shortcut definition
- */
-export interface KeyboardShortcut {
-  key: string
-  description: string
-  handler: () => void
-}
-
-/**
- * Callbacks for keyboard shortcuts actions
- */
-export interface KeyboardShortcutsCallbacks {
-  onRestart: () => void
-  onClear: () => void
-  onQuit: () => void
-}
-
-/**
- * Shortcuts manager options
- */
-export interface ShortcutsManagerOptions {
-  logger: Logger
-  callbacks: KeyboardShortcutsCallbacks
-}
+import { type Logger } from '@poppinss/cliui'
+import {
+  type ShortcutsManagerOptions,
+  type KeyboardShortcut,
+  type KeyboardShortcutsCallbacks,
+} from './types/common.ts'
 
 /**
  * Manages keyboard shortcuts for development server
@@ -90,10 +69,11 @@ export class ShortcutsManager {
    * Initialize keyboard shortcuts
    */
   setup() {
-    if (!process.stdin.isTTY) return
+    if (!process.stdin.isTTY) {
+      return
+    }
 
     process.stdin.setRawMode(true)
-
     this.#keyPressHandler = (data: Buffer) => this.#handleKeyPress(data.toString())
     process.stdin.on('data', this.#keyPressHandler)
   }
@@ -103,10 +83,14 @@ export class ShortcutsManager {
    */
   #handleKeyPress(key: string) {
     // Handle Ctrl+C (0x03) and Ctrl+D (0x04)
-    if (key === '\u0003' || key === '\u0004') return this.#callbacks.onQuit()
+    if (key === '\u0003' || key === '\u0004') {
+      return this.#callbacks.onQuit()
+    }
 
     const shortcut = this.#shortcuts.find((s) => s.key === key)
-    if (shortcut) shortcut.handler()
+    if (shortcut) {
+      shortcut.handler()
+    }
   }
 
   /**
@@ -134,7 +118,9 @@ export class ShortcutsManager {
    * Cleanup keyboard shortcuts
    */
   cleanup() {
-    if (!process.stdin.isTTY) return
+    if (!process.stdin.isTTY) {
+      return
+    }
 
     process.stdin.setRawMode(false)
     process.stdin.removeListener('data', this.#keyPressHandler!)

src/types/common.ts

@@ -7,6 +7,8 @@
  * file that was distributed with this source code.
  */
 
+import type { Logger } from '@poppinss/cliui'
+
 import {
   type BundlerHooks,
   type DevServerHooks,
@@ -186,3 +188,29 @@ export type TestRunnerOptions = {
  * Options accepted by the project bundler
  */
 export type BundlerOptions = AssemblerRcFile
+
+/**
+ * Keyboard shortcut definition
+ */
+export interface KeyboardShortcut {
+  key: string
+  description: string
+  handler: () => void
+}
+
+/**
+ * Callbacks for keyboard shortcuts actions
+ */
+export interface KeyboardShortcutsCallbacks {
+  onRestart: () => void
+  onClear: () => void
+  onQuit: () => void
+}
+
+/**
+ * Shortcuts manager options
+ */
+export interface ShortcutsManagerOptions {
+  logger: Logger
+  callbacks: KeyboardShortcutsCallbacks
+}