Replace lodash package with lodash-es for better ESM support

Author: Alasdair Mercer

package-lock.json

@@ -43,7 +43,7 @@
     "glob": "^10.3.3",
     "hosted-git-info": "^7.0.0",
     "image-size": "^1.0.2",
-    "lodash": "^4.17.21",
+    "lodash-es": "^4.17.21",
     "mime": "^3.0.0",
     "mkdirp": "^3.0.1",
     "pkg-up": "^4.0.0",

package.json

@@ -22,8 +22,8 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
 import convert from 'color-convert';
+import { chain, trim } from 'lodash-es';
 
 /**
  * Contains color information based on a specific value in a single color format and supports easy conversion to other
@@ -62,16 +62,16 @@ export class Color {
    * @public
    */
   constructor(options) {
-    const format = _.trim(options.format).toLowerCase();
+    const format = trim(options.format).toLowerCase();
     if (!convert[format]) {
       throw new Error(`Unsupported color format: ${format}`);
     }
 
     this.#format = format;
-    this.#name = _.trim(options.name) || null;
-    this.#value = options.value == null ? [] : _.chain(options.value)
+    this.#name = trim(options.name) || null;
+    this.#value = options.value == null ? [] : chain(options.value)
       .castArray()
-      .map((v) => typeof v === 'string' ? _.trim(v) : v)
+      .map((v) => typeof v === 'string' ? trim(v) : v)
       .value();
   }
 

src/color.mjs

@@ -22,7 +22,7 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
+import { castArray, cloneDeep, get, trim } from 'lodash-es';
 import { EOL } from 'node:os';
 import path from 'node:path';
 
@@ -129,10 +129,10 @@ export class Config {
     this.#pkg = options.pkg || new Package();
     this.#repository = new Repo(repositoryService.getRepository(options.repository));
     this.#baseDir = path.dirname(this.#filePath);
-    this.#email = _.trim(this.#data.email) || null;
-    this.#homepage = _.trim(this.#data.homepage) || _.trim(this.#pkg.get('homepage')) || this.#repository.homepage;
-    this.#name = _.trim(this.#data.name) || _.trim(this.#pkg.get('name')) || this.#repository.name;
-    this.#title = _.trim(this.#data.title) || this.#name;
+    this.#email = trim(this.#data.email) || null;
+    this.#homepage = trim(this.#data.homepage) || trim(this.#pkg.get('homepage')) || this.#repository.homepage;
+    this.#name = trim(this.#data.name) || trim(this.#pkg.get('name')) || this.#repository.name;
+    this.#title = trim(this.#data.title) || this.#name;
     this.#lineSeparator = ((lineSeparator) => {
       switch (lineSeparator) {
       case 'crlf':
@@ -142,7 +142,7 @@ export class Config {
       default:
         return EOL;
       }
-    })(_.trim(this.option('lineSeparator')).toLowerCase());
+    })(trim(this.option('lineSeparator')).toLowerCase());
   }
 
   /**
@@ -172,7 +172,7 @@ export class Config {
    * @public
    */
   assetURL(paths) {
-    paths = _.castArray(paths);
+    paths = castArray(paths);
 
     const assetURL = this.option('assets.url');
     let filePath = paths.map((p) => p.replace(/\\/g, '/')).join('/');
@@ -214,7 +214,7 @@ export class Config {
    * @public
    */
   docURL(paths, fragment) {
-    paths = _.castArray(paths);
+    paths = castArray(paths);
 
     const docURL = this.option('docs.url');
     let filePath = paths.map((p) => p.replace(/\\/g, '/')).join('/');
@@ -264,7 +264,7 @@ export class Config {
    * @public
    */
   option(name, defaultValue) {
-    return _.get(this.#data.options, name, defaultValue);
+    return get(this.#data.options, name, defaultValue);
   }
 
   /**
@@ -342,7 +342,7 @@ export class Config {
       throw new TypeError('"docs" configuration can only be an array');
     }
 
-    return _.cloneDeep(docs);
+    return cloneDeep(docs);
   }
 
   /**
@@ -490,7 +490,7 @@ export class Config {
       throw new TypeError('"tasks" configuration can only be an array');
     }
 
-    return _.cloneDeep(tasks);
+    return cloneDeep(tasks);
   }
 
   /**

src/config/config.mjs

@@ -22,8 +22,8 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
 import Debug from 'debug';
+import { cloneDeep } from 'lodash-es';
 import { EventEmitter } from 'node:events';
 import pollock from 'pollock';
 
@@ -97,7 +97,7 @@ export class ContextParser extends EventEmitter {
       return null;
     }
 
-    const data = _.cloneDeep(this.#dataSet[index]);
+    const data = cloneDeep(this.#dataSet[index]);
     if (!data) {
       debug('No data found at index: %d', index);
 

src/config/context-parser.mjs

@@ -22,7 +22,7 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
+import { template } from 'lodash-es';
 
 /**
  * Compiles a raw expression string so that it can be evaluated, optionally using data passed in directly to it to
@@ -33,7 +33,7 @@ import _ from 'lodash';
 export class Expression {
 
   /**
-   * @type {TemplateExecutor}
+   * @type {Function}
    * @private
    */
   #compiled;
@@ -45,7 +45,7 @@ export class Expression {
    * @public
    */
   constructor(str) {
-    this.#compiled = _.template(str);
+    this.#compiled = template(str);
   }
 
   /**

src/config/expression.mjs

@@ -22,7 +22,7 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
+import { cloneDeep, get } from 'lodash-es';
 
 /**
  * Contains parsed package data that has been loaded from a single package file.
@@ -71,7 +71,7 @@ export class Package {
    * @public
    */
   get(name, defaultValue) {
-    return _.get(this.#data, name, defaultValue);
+    return get(this.#data, name, defaultValue);
   }
 
   /**
@@ -90,7 +90,7 @@ export class Package {
    * @public
    */
   get data() {
-    return this.#data ? _.cloneDeep(this.#data) : null;
+    return this.#data ? cloneDeep(this.#data) : null;
   }
 
   /**

src/config/package/package.mjs

@@ -22,10 +22,10 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
 import chalk from 'chalk';
 import Debug from 'debug';
 import hostedGitInfo from 'hosted-git-info';
+import { chain, isEmpty, trim } from 'lodash-es';
 import { spawn } from 'node:child_process';
 
 import { GitRepository } from './git-repository.mjs';
@@ -88,7 +88,7 @@ export class GitRepositoryProvider extends RepositoryProvider {
     debug('Resolving Git repository URL from directory: %s', chalk.blue(dirPath));
 
     const remotes = await this.#getRemoteNames(dirPath);
-    if (_.isEmpty(remotes)) {
+    if (isEmpty(remotes)) {
       debug('No remotes found in Git repository at directory: %s', chalk.blue(dirPath));
 
       return null;
@@ -157,7 +157,7 @@ export class GitRepositoryProvider extends RepositoryProvider {
   async #getBranchName(dirPath) {
     const output = await this.#execGit(dirPath, 'branch', '--show-current');
 
-    return _.trim(output) || null;
+    return trim(output) || null;
   }
 
   /**
@@ -168,9 +168,9 @@ export class GitRepositoryProvider extends RepositoryProvider {
   async #getRemoteNames(dirPath) {
     const output = await this.#execGit(dirPath, 'remote', 'show');
 
-    return _.chain(output)
+    return chain(output)
       .split(/\n/)
-      .map(_.trim)
+      .map(trim)
       .compact()
       .value();
   }
@@ -184,7 +184,7 @@ export class GitRepositoryProvider extends RepositoryProvider {
   async #getRemoteURL(name, dirPath) {
     const output = await this.#execGit(dirPath, 'remote', 'get-url', name);
 
-    return _.trim(output) || null;
+    return trim(output) || null;
   }
 
 }

src/config/repository/git/git-repository-provider.mjs

@@ -22,9 +22,9 @@
 
 /* istanbul ignore file */
 
-import _ from 'lodash';
 import chalk from 'chalk';
 import Debug from 'debug';
+import { get, trim } from 'lodash-es';
 
 import { GitRepositoryProvider } from './git/git-repository-provider.mjs';
 
@@ -257,10 +257,10 @@ export class RepositoryService {
     let type, url;
 
     if (typeof info === 'string') {
-      url = _.trim(info) || null;
+      url = trim(info) || null;
     } else {
-      type = _.trim(_.get(info, 'type')).toLowerCase() || null;
-      url = _.trim(_.get(info, 'url')) || null;
+      type = trim(get(info, 'type')).toLowerCase() || null;
+      url = trim(get(info, 'url')) || null;
     }
 
     return { type, url };