@gasket/utils - npm Package Compare versions

Comparing version 7.0.0-next.68 to 7.0.0-next.69

lib/apply-config-overrides.js

 const defaultsDeep = require('lodash.defaultsdeep');
+// @ts-ignore - diagnostics lib does not have a types declaration file
 const debug = require('diagnostics')('gasket:utils');
@@ -34,2 +35,6 @@
 
+/**
+ * Generator function to yield command overrides
+ * @type {import('./internal').getCommandOverrides}
+ */
 function *getCommandOverrides(commands, commandId) {
@@ -45,5 +50,3 @@ const commandOverrides = commandId && commands[commandId];
  * Generator function to yield sub-environment overrides
- * @param {string} env - Environment
- * @param {object} environments - Environments object
- * @yields {object} - Sub-environment overrides
+ * @type {import('./internal').getSubEnvironmentOverrides}
  */
@@ -67,5 +70,3 @@ function *getSubEnvironmentOverrides(env, environments) {
  * Generator function to yield development overrides
- * @param {boolean} isLocalEnv - Is the environment local
- * @param {object} environments - Environments object
- * @yields {object} - Development overrides
+ * @type {import('./internal').getDevOverrides}
  */
@@ -72,0 +73,0 @@ function *getDevOverrides(isLocalEnv, environments) {

lib/index.d.ts

@@ -161,5 +161,52 @@ import type { MaybeAsync } from '@gasket/core';
 
+declare module '@gasket/utils' {
+  /**
+   * Executes the appropriate npm binary with the verbatim `argv` and
+   * `spawnWith` options provided. Passes appropriate debug flag for
+   * npm based on process.env.
+   */
+  function PackageManager_spawnNpm(
+    /** Precise CLI arguments to pass to `npm`. */
+    argv: string[],
+    /** Options for child_process.spawn. */
+    spawnWith: SpawnOpts
+  ): Promise<{ stdout: string }>;
 
+  /**
+   * Executes the appropriate yarn binary with the verbatim `argv` and
+   * `spawnWith` options provided. Passes appropriate debug flag for
+   * npm based on process.env.
+   */
+  function PackageManager_spawnYarn(
+    /** Precise CLI arguments to pass to `npm`. */
+    argv: string[],
+    /** Options for child_process.spawn. */
+    spawnWith: SpawnOpts
+  ): Promise<{ stdout: string }>;
+
+  function PackageManager_exec(
+    /** The command that needs to be executed. */
+    cmd: string,
+    /** Additional CLI arguments to pass to `npm`. */
+    args: string[]
+  ): Promise<{ stdout: string }>;
+
+  function PackageManager_link(
+    /** Explicit `npm` packages to link locally. */
+    packages: string[]
+  ): Promise<{ stdout: string }>;
+
+  function PackageManager_install(
+    /** Additional CLI arguments to pass to `npm`. */
+    args: string[]
+  ): Promise<{ stdout: string }>;
+
+  function PackageManager_info(
+    /** Additional CLI arguments to pass to `npm`. */
+    args: string[]
+  ): Promise<{ data: any; stdout: string }>;
+}
+
 export function warnIfOutdated(pkgName: string, currentVersion: string): MaybeAsync<void>;
 
 export function getPackageLatestVersion(pkgName: string, options?: object): Promise<string>;

lib/package-manager.js

@@ -18,5 +18,3 @@ /* eslint-disable no-process-env */
    * npm based on process.env.
-   * @param {string[]} argv Precise CLI arguments to pass to `npm`.
-   * @param {object} spawnWith Options for child_process.spawn.
-   * @returns {Promise} promise
+   * @type {import('@gasket/utils').PackageManager_spawnNpm}
    * @public
@@ -62,5 +60,3 @@ */
    * npm based on process.env.
-   * @param {string[]} argv Precise CLI arguments to pass to `npm`.
-   * @param {object} spawnWith Options for child_process.spawn.
-   * @returns {Promise} promise
+   * @type {import('@gasket/utils').PackageManager_spawnYarn}
    * @public
@@ -86,5 +82,3 @@ */
    * This installation can be run multiple times.
-   * @param {string} cmd The command that needs to be executed.
-   * @param {string[]} args Additional CLI arguments to pass to `npm`.
-   * @returns {Promise} promise
+   * @type {import('@gasket/utils').PackageManager_exec}
    * @public
@@ -133,4 +127,3 @@ */
    * Executes npm link in the application directory `this.dest`.
-   * @param {string[]} packages Explicit `npm` packages to link locally.
-   * @returns {Promise} promise
+   * @type {import('@gasket/utils').PackageManager_link}
    * @public
@@ -145,4 +138,3 @@ */
    * This installation can be run multiple times.
-   * @param {string[]} args Additional CLI arguments to pass to `npm`.
-   * @returns {Promise} promise
+   * @type {import('@gasket/utils').PackageManager_install}
    * @public
@@ -163,4 +155,3 @@ */
    * Executes yarn or npm info, and returns parsed JSON data results.
-   * @param {string[]} args Additional CLI arguments to pass to `npm`.
-   * @returns {Promise<object>} stdout and data
+   * @type {import('@gasket/utils').PackageManager_info}
    * @public
@@ -167,0 +158,0 @@ */

lib/run-shell-command.js

@@ -8,3 +8,5 @@ /* eslint-disable max-params */
   const { signal, ...opts } = options;
+  /** @type {string} */
   let stderr;
+  /** @type {string} */
   let stdout;
@@ -11,0 +13,0 @@

package.json

 {
   "name": "@gasket/utils",
-  "version": "7.0.0-next.68",
+  "version": "7.0.0-next.69",
   "description": "Reusable utilities for Gasket internals",
@@ -32,5 +32,2 @@ "main": "lib",
   "author": "GoDaddy Operating Company, LLC",
-  "maintainers": [
-    "Andrew Gerard <[e-mail]>"
-  ],
   "license": "MIT",
@@ -49,4 +46,7 @@ "bugs": {
   "devDependencies": {
-    "@gasket/core": "7.0.0-next.68",
+    "@gasket/core": "7.0.0-next.69",
     "@godaddy/dmd": "^1.0.4",
+    "@types/concat-stream": "^2.0.3",
+    "@types/cross-spawn": "^6.0.6",
+    "@types/lodash.defaultsdeep": "^4.6.9",
     "abort-controller": "^3.0.0",
@@ -74,3 +74,15 @@ "cross-env": "^7.0.3",
       "unicorn/filename-case": "error"
-    }
+    },
+    "overrides": [
+      {
+        "files": [
+          "test/**/*.js"
+        ],
+        "rules": {
+          "jsdoc/require-jsdoc": "off",
+          "jsdoc/require-param-type": "off",
+          "jsdoc/require-returns-description": "off"
+        }
+      }
+    ]
   },
@@ -80,3 +92,3 @@ "eslintIgnore": [
   ],
-  "gitHead": "13b1cf962202f9d7212412d337cbfcd38cd92c2a"
+  "gitHead": "b5645f2b3cc18080304c9dbdfeadf6d0005e3893"
 }

No alert changes

Improved metrics

Total package byte prevSize

23037

increased by10.61%

Number of package files

11

increased by10%

Lines of code

579

increased by11.56%

Worsened metrics

Dev dependency count

14

increased by27.27%

No dependency changes