style: fix jsdoc formatings

Author: YasharF

src/finder.ts

@@ -124,8 +124,8 @@ function win32() {
     }))
 
     /**
-   * fallback using edge-path
-   */
+     * fallback using edge-path
+     */
     if (installations.length === 0) {
         const edgePath = getEdgePath()
         if (hasAccessSync(edgePath)) {
@@ -165,8 +165,8 @@ function findEdgeExecutables(folder: string) {
 
 export default () => {
     /**
-   * Check for the EDGE_BINARY_PATH env variable
-   */
+     * Check for the EDGE_BINARY_PATH env variable
+     */
     const binaryPathEnv = process.env.EDGE_BINARY_PATH
     if (typeof binaryPathEnv === 'string' && binaryPathEnv) {
         return process.env.EDGE_BINARY_PATH

src/install.ts

@@ -24,7 +24,7 @@ interface ProductAPIResponse {
 
 // Extend RequestInit to include the agent property that Node.js built-in fetch supports
 interface NodeRequestInit extends RequestInit {
-  agent?: HttpsProxyAgent<string> | HttpProxyAgent<string>
+    agent?: HttpsProxyAgent<string> | HttpProxyAgent<string>
 }
 
 const fetchOpts: NodeRequestInit = {}
@@ -147,8 +147,8 @@ async function getEdgeVersionUnix (edgePath: string) {
         return resolve(stdout)
     }))
     /**
-   * example output: "Microsoft Edge 124.0.2478.105 unknown"
-   */
+     * example output: "Microsoft Edge 124.0.2478.105 unknown"
+     */
     return versionOutput
     /**
      * trim the output
@@ -173,15 +173,15 @@ export async function fetchVersion (edgeVersion: string) {
     const platform = p === 'win32' ? 'win' : p === 'darwin' ? 'mac' : 'linux'
 
     /**
-   * if version has 4 digits it is a valid version, e.g. 109.0.1467.0
-   */
+     * if version has 4 digits it is a valid version, e.g. 109.0.1467.0
+     */
     if (edgeVersion.split('.').length === 4) {
         return edgeVersion
     }
 
     /**
-   * if browser version is a tagged version, e.g. stable, beta, dev, canary
-   */
+     * if browser version is a tagged version, e.g. stable, beta, dev, canary
+     */
     if (TAGGED_VERSIONS.includes(edgeVersion.toLowerCase())) {
         const apiResponse = await fetch(EDGE_PRODUCTS_API, fetchOpts).catch((err) => {
             log.error(`Couldn't fetch version from ${EDGE_PRODUCTS_API}: ${err.stack}`)
@@ -191,8 +191,8 @@ export async function fetchVersion (edgeVersion: string) {
         const product = products.find((p) => p.Product.toLowerCase() === edgeVersion.toLowerCase())
         const productVersion = product?.Releases.find((r) => (
             /**
-       * On Mac we all product versions are universal to its architecture
-       */
+             * On Mac we all product versions are universal to its architecture
+             */
             (platform === 'mac' && r.Platform === 'MacOS') ||
       /**
        * On Windows we need to check for the architecture
@@ -213,8 +213,8 @@ export async function fetchVersion (edgeVersion: string) {
     }
 
     /**
-   * check for a number in the version and check for that
-   */
+     * check for a number in the version and check for that
+     */
     const MATCH_VERSION = /\d+/g
     if (edgeVersion.match(MATCH_VERSION)) {
         const [major] = edgeVersion.match(MATCH_VERSION)

src/types.ts

@@ -2,73 +2,73 @@ export type LogLevel = 'ALL' | 'DEBUG' | 'INFO' | 'WARNING' | 'SEVERE' | 'OFF'
 
 export interface EdgedriverParameters {
     /**
-   * Version of Edgedriver to start. See https://msedgedriver.azureedge.net/ for all available versions, platforms and architecture.
-   */
+     * Version of Edgedriver to start. See https://msedgedriver.azureedge.net/ for all available versions, platforms and architecture.
+     */
     edgeDriverVersion?: string
     /**
-   * Don't download Edgedriver, instead use a custom path to it, e.g. a cached binary.
-   * @default process.env.EDGEDRIVER_PATH
-   */
+     * Don't download Edgedriver, instead use a custom path to it, e.g. a cached binary.
+     * @default process.env.EDGEDRIVER_PATH
+     */
     customEdgeDriverPath?: string
     /**
-   * port to listen on
-   */
+     * port to listen on
+     */
     port?: number
     /**
-   * adb server port
-   */
+     * adb server port
+     */
     adbPort?: number
     /**
-   * write server log to file instead of stderr, increases log level to INFO
-   */
+     * write server log to file instead of stderr, increases log level to INFO
+     */
     logPath?: string
     /**
-   * set log level
-   */
+     * set log level
+     */
     logLevel?: LogLevel
     /**
-   * log verbosely (equivalent to --log-level=ALL)
-   */
+     * log verbosely (equivalent to --log-level=ALL)
+     */
     verbose?: boolean
     /**
-   * log nothing (equivalent to --log-level=OFF)
-   */
+     * log nothing (equivalent to --log-level=OFF)
+     */
     silent?: boolean
     /**
-   * append log file instead of rewriting
-   */
+     * append log file instead of rewriting
+     */
     appendLog?: boolean
     /**
-   * (experimental) log verbosely and don't truncate long strings so that the log can be replayed.
-   */
+     * (experimental) log verbosely and don't truncate long strings so that the log can be replayed.
+     */
     replayable?: boolean
     /**
-   * base URL path prefix for commands, e.g. wd/url
-   */
+     * base URL path prefix for commands, e.g. wd/url
+     */
     baseUrl?: string
     /**
-   * add readable timestamps to log
-   */
+     * add readable timestamps to log
+     */
     readableTimestamp?: boolean
     /**
-   * show logs from the browser (overrides other logging options)
-   */
+     * show logs from the browser (overrides other logging options)
+     */
     enableChromeLogs?: boolean
     /**
-   * custom bidi mapper path
-   */
+     * custom bidi mapper path
+     */
     bidiMapperPath?: string
     /**
-   * comma-separated allowlist of remote IP addresses which are allowed to connect to msedgedriver
-   */
+     * comma-separated allowlist of remote IP addresses which are allowed to connect to msedgedriver
+     */
     allowedIps?: string[]
     /**
-   * comma-separated allowlist of request origins which are allowed to connect to msedgedriver. Using `*` to allow any host origin is dangerous!
-   */
+     * comma-separated allowlist of request origins which are allowed to connect to msedgedriver. Using `*` to allow any host origin is dangerous!
+     */
     allowedOrigins?: string[]
     /**
-   * The path to the root of the cache directory.
-   * @default process.env.GECKODRIVER_CACHE_DIR || os.tmpdir()
-   */
+     * The path to the root of the cache directory.
+     * @default process.env.GECKODRIVER_CACHE_DIR || os.tmpdir()
+     */
     cacheDir?: string
 }

vitest.config.ts

@@ -5,8 +5,8 @@ export default defineConfig({
     test: {
         include: ['tests/**/*.test.ts'],
         /**
-     * not to ESM ported packages
-     */
+         * not to ESM ported packages
+         */
         exclude: [
             'dist', '.idea', '.git', '.cache',
             '**/node_modules/**',