Merge pull request #117 from AthennaIO/develop

feat(exec): add Exec.install() method

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "4.34.0",
+  "version": "4.35.0",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -62,7 +62,7 @@
     "collect.js": "^4.36.1",
     "csv-parser": "^3.0.0",
     "execa": "^8.0.1",
-    "fastify": "^4.26.0",
+    "fastify": "^4.26.1",
     "got": "^12.6.1",
     "http-status-codes": "^2.2.0",
     "is-wsl": "^2.2.0",
@@ -82,7 +82,7 @@
     "youch-terminal": "^2.2.2"
   },
   "devDependencies": {
-    "@athenna/test": "^4.18.0",
+    "@athenna/test": "^4.22.0",
     "@athenna/tsconfig": "^4.12.0",
     "@types/bytes": "^3.1.1",
     "@types/callsite": "^1.0.31",

src/helpers/Exec.ts

@@ -7,20 +7,25 @@
  * file that was distributed with this source code.
  */
 
-import { Transform } from 'node:stream'
-import { File } from '#src/helpers/File'
-import { Options } from '#src/helpers/Options'
-import { request as requestHttp } from 'node:http'
-import { request as requestHttps } from 'node:https'
-import { execa, execaNode, execaCommand, type ExecaChildProcess } from 'execa'
 import type {
   CommandInput,
   CommandOutput,
   NodeCommandInput,
   PaginationOptions,
-  PaginatedResponse
+  PaginatedResponse,
+  InstallPackageOptions,
+  LinkPackageOptions
 } from '#src/types'
 
+import { Is } from '#src/helpers/Is'
+import { Transform } from 'node:stream'
+import { File } from '#src/helpers/File'
+import { Path } from '#src/helpers/Path'
+import { Options } from '#src/helpers/Options'
+import { request as requestHttp } from 'node:http'
+import { request as requestHttps } from 'node:https'
+import { execa, execaNode, execaCommand, type ExecaChildProcess } from 'execa'
+
 export class Exec {
   /**
    * Sleep the code in the line that this function
@@ -61,6 +66,82 @@ export class Exec {
     return execa('sh', ['-c', command], options)
   }
 
+  /**
+   * Install libraries into a path using a registry as a child process.
+   */
+  public static async install(
+    libraries: string | string[],
+    options: InstallPackageOptions = {}
+  ): Promise<CommandOutput> {
+    options = Options.create(options, {
+      args: [],
+      dev: false,
+      reject: true,
+      silent: true,
+      cached: false,
+      registry: 'npm',
+      cwd: Path.pwd()
+    })
+
+    if (Is.String(libraries)) {
+      libraries = [libraries]
+    }
+
+    const args = ['install']
+
+    if (options.registry === 'yarn') {
+      args[0] = 'add'
+    }
+
+    if (options.dev) {
+      args.push('-D')
+    }
+
+    if (options.cached) {
+      args.push('--prefer-offline')
+    }
+
+    args.push(...options.args)
+    args.push(...libraries)
+
+    return execa(options.registry, args, {
+      reject: options.reject,
+      stdio: options.silent ? 'ignore' : 'inherit',
+      cwd: options.cwd
+    })
+  }
+
+  /**
+   * Link libraries into a path using a registry as a child process.
+   */
+  public static async link(
+    libraries: string | string[],
+    options: LinkPackageOptions = {}
+  ): Promise<CommandOutput> {
+    options = Options.create(options, {
+      args: [],
+      reject: true,
+      silent: true,
+      registry: 'npm',
+      cwd: Path.pwd()
+    })
+
+    if (Is.String(libraries)) {
+      libraries = [libraries]
+    }
+
+    const args = ['link']
+
+    args.push(...options.args)
+    args.push(...libraries)
+
+    return execa(options.registry, args, {
+      reject: options.reject,
+      stdio: options.silent ? 'ignore' : 'inherit',
+      cwd: options.cwd
+    })
+  }
+
   public static command(
     command: string,
     options?: CommandInput

src/index.ts

@@ -9,7 +9,6 @@
 
 export * from '#src/types'
 
-export * from '#src/globals/Path'
 export * from '#src/globals/Error'
 export * from '#src/globals/Array'
 

src/types/InstallPackageOptions.ts

@@ -0,0 +1,66 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export type InstallPackageOptions = {
+  /**
+   * Define the path where the install command should ran.
+   *
+   * @default Path.pwd()
+   */
+  cwd?: string
+
+  /**
+   * Define if the libraries should be installed as
+   * devDependencies or not.
+   *
+   * @default false
+   */
+  dev?: boolean
+
+  /**
+   * Add additional arguments for the registry CLI you
+   * are using to install the libraries.
+   *
+   * @default []
+   */
+  args?: string[]
+
+  /**
+   * Define if the registry should use cached libraries when
+   * installing it.
+   *
+   * @default false
+   */
+  cached?: boolean
+
+  /**
+   * Define if the libraries installation should display the
+   * logs from the registry or not.
+   *
+   * @default true
+   */
+  silent?: boolean
+
+  /**
+   * Throw errors if something goes wrong when trying to
+   * install the libraries.
+   *
+   * @default true
+   */
+  reject?: boolean
+
+  /**
+   * Define the registry that will be used to install the
+   * dependencies. Tested only with `npm`, but
+   * you can try to use whatever you like.
+   *
+   * @default "npm"
+   */
+  registry?: string
+}