@modernpoacher/deps 2.2.16 → 2.2.18

package/bin/node/wipe.mjs

@@ -8,6 +8,8 @@ import {
   join
 } from 'node:path'
 
+import '#deps/src/common/debug'
+
 import {
   PLATFORM,
   BIN
@@ -17,8 +19,6 @@ import {
   getOptions
 } from '#deps/src/common/options'
 
-import '#deps/src/common/debug'
-
 import {
   getArgs,
   use,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/deps",
-  "version": "2.2.16",
+  "version": "2.2.18",
   "description": "Update NPM package dependencies from the command line",
   "keywords": [
     "deps",
@@ -79,8 +79,8 @@
     "#deps/src": "./src/index.mjs",
     "#deps/src/*": "./src/*.mjs",
     "#deps/src/common": "./src/common/index.mjs",
-    "#deps/src/common/debug": "./src/common/debug.mjs",
     "#deps/src/common/*": "./src/common/*/index.mjs",
+    "#deps/src/common/debug": "./src/common/debug.mjs",
     "#deps/src/install": "./src/install/index.mjs",
     "#where-am-i": "./where-am-i.mjs"
   }

package/src/common/index.mjs

@@ -305,21 +305,48 @@ export const isPreRelease = (v) => /-/.test(v)
  */
 export const isExact = (v) => /^\d/.test(v)
 
-function includeExact ([name, version]) {
+/**
+ *  @param {[name: string, version: string]} entry
+ *  @returns {boolean}
+ */
+function includeVersionIsExact ([name, version]) {
   return isExact(version)
 }
 
-function excludeExact ([name, version]) {
+/**
+ *  @param {[name: string, version: string]} entry
+ *  @returns {boolean}
+ */
+function excludeVersionIsExact ([name, version]) {
   return !isExact(version)
 }
 
-function getMapConfigurationDependencies (configurationDependencies) {
+/**
+ *  @function getMapToDepsExactVersionFromConfiguration
+ *
+ *  Produces an array of objects from the entries of `packageDependencies` which have
+ *  exact versions
+ *
+ *  Entries have already been filtered to exclude non-exact versions
+ *
+ *  Each entry is mapped to the same package name in `configurationDependencies` if it
+ *  appears there. Otherwise, the `packageDependencies` version is used
+ *
+ *  @param {Record<string, string>} configurationDependencies
+ *  @returns {(entry: [name: string, version: string]) => {
+ *    name: string,
+ *    version: string
+ *  }}
+ */
+function getMapToDepsExactVersionFromConfiguration (configurationDependencies) {
   /**
-   *  We are producing an array of objects from the entries of the `packageDependencies`
-   *
-   *  Each object in the array represents an entry (key and value) from `packageDependencies`
+   *  @param {[name: string, version: string]} entry
+   *  @returns {{
+   *    name: string,
+   *    version: string
+   *  }}
    */
-  return function mapConfigurationDependencies (entry) {
+  return function mapToDepsExactVersionFromConfiguration (entry) {
     const [
       name,
       version
@@ -336,7 +363,22 @@ function getMapConfigurationDependencies (configurationDependencies) {
   }
 }
 
-function mapPackageDependencies (entry) {
+/**
+ *  @function mapToDepsVersion
+ *
+ *  Produces an array of objects from the entries of `packageDependencies` which do not have
+ *  exact versions
+ *
+ *  Where the version is a pre-release, that version is used. Otherwise the version is
+ *  set to `latest` to ensure that package is updated
+ *
+ *  @param {[name: string, version: string]} entry
+ *  @returns {{
+ *    name: string,
+ *    version: string
+ *  }}
+ */
+function mapToDepsVersion (entry) {
   const [
     name,
     version
@@ -369,8 +411,8 @@ export function getDepsExact (packageDependencies, configurationDependencies) {
 
   return (
     Object.entries(packageDependencies)
-      .filter(includeExact)
-      .map(getMapConfigurationDependencies(configurationDependencies))
+      .filter(includeVersionIsExact)
+      .map(getMapToDepsExactVersionFromConfiguration(configurationDependencies))
   )
 }
 
@@ -387,8 +429,8 @@ export function getDeps (packageDependencies) {
 
   return (
     Object.entries(packageDependencies)
-      .filter(excludeExact)
-      .map(mapPackageDependencies)
+      .filter(excludeVersionIsExact)
+      .map(mapToDepsVersion)
   )
 }