@villedemontreal/general-utils 5.17.5 → 5.18.0

package/src/config/constants.ts

@@ -1,5 +1,6 @@
-import { path as appRoot } from 'app-root-path';
+import * as fs from 'fs';
 import * as path from 'path';
+import { path as appRoot } from 'app-root-path';
 
 /**
  * Library constants
@@ -32,6 +33,20 @@ export class Constants {
   get testDataDirPath() {
     return this.libRoot + '/test-data';
   }
+
+  public findModulePath(subPath: string): string {
+    let current = this.libRoot;
+    let counter = 0;
+    while (counter < 10 && current !== '/' && fs.existsSync(current)) {
+      const p = path.join(current, subPath);
+      if (fs.existsSync(p)) {
+        return path.normalize(p);
+      }
+      current = path.normalize(path.join(current, '..'));
+      counter += 1;
+    }
+    throw new Error(`Could not find module "${subPath}"`);
+  }
 }
 
 export const constants: Constants = new Constants();

package/src/dateUtils.test.ts

@@ -1,6 +1,6 @@
 import { assert } from 'chai';
-import _ from 'lodash';
-import moment from 'moment';
+import * as _ from 'lodash';
+import * as moment from 'moment';
 import { getValueDescription, getValueDescriptionWithType, utils } from '.';
 import { getCartesianProduct } from './collectionUtils';
 import {
@@ -177,7 +177,9 @@ describe('Date Utility', () => {
     for (const entry of expectations) {
       const value = entry[0];
       const expectedResult = entry[1];
-      const valueDescription = `[${getValueDescriptionWithType(value[0])}, ${getValueDescriptionWithType(value[1])}]`;
+      const valueDescription = `[${getValueDescriptionWithType(
+        value[0],
+      )}, ${getValueDescriptionWithType(value[1])}]`;
       it(`should support ${valueDescription}`, () => {
         assert.deepEqual(getSafeDateRange(value), expectedResult);
       });

package/src/dateUtils.ts

@@ -1,9 +1,8 @@
-import _ from 'lodash';
 import { DateTime, Zone } from 'luxon';
-import moment from 'moment';
-// tslint:disable-next-line:no-duplicate-imports
+import * as moment from 'moment';
 import { Moment } from 'moment';
 import { getValueDescription, utils } from '.';
+import { isDate, isNil } from 'lodash';
 
 export function isDateEqual(value: DateDefinition, expectedDate: DateDefinition) {
   const _moment: Moment = moment(value);
@@ -231,11 +230,11 @@ export function startOfDay(
   isoDate: Date | string,
   timezone: string | Zone = 'America/Montreal',
 ): Date {
-  if (_.isNil(isoDate)) {
+  if (isNil(isoDate)) {
     return isoDate;
   }
 
-  let luxonDate = DateTime.fromISO(_.isDate(isoDate) ? isoDate.toISOString() : isoDate);
+  let luxonDate = DateTime.fromISO(isDate(isoDate) ? isoDate.toISOString() : isoDate);
   if (!luxonDate.isValid) {
     throw new Error(`Invalid ISO date ${JSON.stringify(isoDate)} : ${luxonDate.invalidReason}`);
   }
@@ -262,11 +261,11 @@ export function endOfDay(
   isoDate: Date | string,
   timezone: string | Zone = 'America/Montreal',
 ): Date {
-  if (_.isNil(isoDate)) {
+  if (isNil(isoDate)) {
     return isoDate;
   }
 
-  let luxonDate = DateTime.fromISO(_.isDate(isoDate) ? isoDate.toISOString() : isoDate);
+  let luxonDate = DateTime.fromISO(isDate(isoDate) ? isoDate.toISOString() : isoDate);
   if (!luxonDate.isValid) {
     throw new Error(`Invalid ISO date ${JSON.stringify(isoDate)} : ${luxonDate.invalidReason}`);
   }

package/src/logLevel.ts

@@ -24,10 +24,20 @@ export enum LogLevel {
  * LogLevel enum value.
  */
 export const logLevelFromString = (levelStr: string): LogLevel => {
-  if (levelStr) {
-    return LogLevel[levelStr.toUpperCase()];
+  switch ((levelStr || '').toUpperCase()) {
+    case 'DEBUG':
+      return LogLevel.DEBUG;
+    case 'TRACE':
+      return LogLevel.TRACE;
+    case 'ERROR':
+      return LogLevel.ERROR;
+    case 'INFO':
+      return LogLevel.INFO;
+    case 'WARNING':
+      return LogLevel.WARNING;
+    default:
+      return LogLevel.DEBUG;
   }
-  return undefined;
 };
 
 /**

package/src/utils.test.ts

@@ -16,6 +16,10 @@ import { ExecError, utils, Utils } from './utils';
 // @see https://github.com/mochajs/mocha/issues/2018
 // tslint:disable-next-line:only-arrow-functions ter-prefer-arrow-callback
 describe("App's utilities functions", function () {
+  this.beforeAll(() => {
+    constants.appRoot = constants.libRoot; // because our lib is within a monorepo
+  });
+
   // ==========================================
   // tsc()
   // ==========================================

package/src/utils.ts

@@ -1,11 +1,11 @@
 import { spawn, StdioOptions } from 'child_process';
 import * as fs from 'fs';
-import getPort from 'get-port';
-import _ from 'lodash';
+import * as getPort from 'get-port';
 import * as pathUtils from 'path';
 import { rimraf } from 'rimraf';
 import * as tsconfig from 'tsconfig-extends';
 import { constants } from './config/constants';
+import { isArray, isDate, isEqual, isFunction, isNil, isObject, isString, trimEnd } from 'lodash';
 
 /**
  * General utilities
@@ -158,7 +158,7 @@ export class Utils {
     pathClean = pathUtils.normalize(pathClean);
 
     pathClean = pathClean.replace(/\\/g, '/');
-    pathClean = _.trimEnd(pathClean, '/ ');
+    pathClean = trimEnd(pathClean, '/ ');
 
     return (pathClean.match(/\//g) || []).length > 1;
   }
@@ -268,11 +268,12 @@ export class Utils {
     if (!this.tscCompilerOptionsParams) {
       this.tscCompilerOptionsParams = [];
       const compilerOptions = tsconfig.load_file_sync(constants.appRoot + '/tsconfig.json');
+
       for (const key of Object.keys(compilerOptions)) {
         // ==========================================
-        // TS6064: Option 'plugins' can only be specified in 'tsconfig.json' file.
+        // TS6064: Options 'plugins', 'composite' can only be specified in 'tsconfig.json' file.
         // ==========================================
-        if (key === 'plugins') {
+        if (['plugins', 'composite'].includes(key)) {
           continue;
         }
 
@@ -306,9 +307,8 @@ export class Utils {
     }
 
     const cmd = 'node';
-    const args = [constants.libRoot + '/node_modules/typescript/lib/tsc.js']
-      .concat(this.tscCompilerOptions)
-      .concat(files);
+    const tscCmd = constants.findModulePath('node_modules/typescript/lib/tsc.js');
+    const args = [tscCmd].concat(this.tscCompilerOptions).concat(files);
 
     await this.execPromisified(cmd, args);
   }
@@ -362,13 +362,13 @@ export class Utils {
   public dateTransformer = (value: any): Date => {
     let date: Date;
 
-    if (_.isNil(value)) {
+    if (isNil(value)) {
       return null;
     }
 
-    if (_.isDate(value)) {
+    if (isDate(value)) {
       date = value;
-    } else if (!_.isString(value) || utils.isBlank(value)) {
+    } else if (!isString(value) || utils.isBlank(value)) {
       // ==========================================
       // Makes sure it's an invalid date!
       // Because by default, true and 123 are accepted,
@@ -406,7 +406,7 @@ export class Utils {
     if (!val) {
       return false;
     }
-    return _.isObject(val) && !_.isArray(val) && !_.isDate(val) && !_.isFunction(val);
+    return isObject(val) && !isArray(val) && !isDate(val) && !isFunction(val);
   };
 
   /**
@@ -415,12 +415,12 @@ export class Utils {
    * strictly equals to the specified "value".
    */
   public arrayContainsObjectWithKeyEqualsTo = (array: any[], key: string, value: any): boolean => {
-    if (!array || !_.isArray(array) || array.length < 1) {
+    if (!array || !isArray(array) || array.length < 1) {
       return false;
     }
 
     for (const obj of array) {
-      if (this.isObjectStrict(obj) && _.isEqual(obj[key], value)) {
+      if (this.isObjectStrict(obj) && isEqual(obj[key], value)) {
         return true;
       }
     }
@@ -499,7 +499,7 @@ export class Utils {
     const optionsClean = options ?? {};
     optionsClean.useShellOption = optionsClean.useShellOption ?? true;
     optionsClean.successExitCodes = optionsClean.successExitCodes
-      ? _.isArray(optionsClean.successExitCodes)
+      ? isArray(optionsClean.successExitCodes)
         ? optionsClean.successExitCodes
         : [optionsClean.successExitCodes]
       : [0];
@@ -575,7 +575,7 @@ export function getValueDescription(value: any): string {
 }
 
 export function getValueDescriptionWithType(value: any): string {
-  const valueType = _.isObject(value) ? value.constructor.name : typeof value;
+  const valueType = isObject(value) ? value.constructor.name : typeof value;
   return getValueDescription(value) + ` (${valueType})`;
 }
 

package/dist/scripts/index.d.ts

@@ -1,2 +0,0 @@
-export { LintScript } from './lint';
-export { LintFixScript } from './lintFix';

package/dist/scripts/index.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LintFixScript = exports.LintScript = void 0;
-// ==========================================
-// All scripts must be included here!
-//
-// The scripting library uses this index to quickly
-// find all the scripts available in the application.
-// ==========================================
-var lint_1 = require("./lint");
-Object.defineProperty(exports, "LintScript", { enumerable: true, get: function () { return lint_1.LintScript; } });
-var lintFix_1 = require("./lintFix");
-Object.defineProperty(exports, "LintFixScript", { enumerable: true, get: function () { return lintFix_1.LintFixScript; } });
-//# sourceMappingURL=index.js.map

package/dist/scripts/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../scripts/index.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAC7C,qCAAqC;AACrC,EAAE;AACF,mDAAmD;AACnD,qDAAqD;AACrD,6CAA6C;AAC7C,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,qCAA0C;AAAjC,wGAAA,aAAa,OAAA"}

package/dist/scripts/lint.d.ts

@@ -1,6 +0,0 @@
-import { ScriptBase } from '@villedemontreal/scripting/dist/src';
-export declare class LintScript extends ScriptBase {
-    get name(): string;
-    get description(): string;
-    protected main(): Promise<void>;
-}

package/dist/scripts/lint.js

@@ -1,31 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LintScript = void 0;
-const src_1 = require("@villedemontreal/scripting/dist/src");
-const path_1 = require("path");
-const configs_1 = require("../config/configs");
-class LintScript extends src_1.ScriptBase {
-    get name() {
-        return 'lint';
-    }
-    get description() {
-        return `Run the ESLint validation (including ESLint and Prettier rules).`;
-    }
-    main() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const projectRoot = (0, path_1.resolve)(`${configs_1.configs.root}/..`);
-            yield this.invokeShellCommand(`${projectRoot}/node_modules/.bin/eslint`, [projectRoot]);
-        });
-    }
-}
-exports.LintScript = LintScript;
-//# sourceMappingURL=lint.js.map

package/dist/scripts/lint.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lint.js","sourceRoot":"","sources":["../../scripts/lint.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAAiE;AACjE,+BAA+B;AAC/B,+CAA4C;AAC5C,MAAa,UAAW,SAAQ,gBAAU;IACxC,IAAI,IAAI;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,kEAAkE,CAAC;IAC5E,CAAC;IAEe,IAAI;;YAClB,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,GAAG,iBAAO,CAAC,IAAI,KAAK,CAAC,CAAC;YAClD,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,WAAW,2BAA2B,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAC1F,CAAC;KAAA;CACF;AAbD,gCAaC"}

package/dist/scripts/lintFix.d.ts

@@ -1,6 +0,0 @@
-import { ScriptBase } from '@villedemontreal/scripting/dist/src';
-export declare class LintFixScript extends ScriptBase {
-    get name(): string;
-    get description(): string;
-    protected main(): Promise<void>;
-}

package/dist/scripts/lintFix.js

@@ -1,40 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LintFixScript = void 0;
-const src_1 = require("@villedemontreal/scripting/dist/src");
-const path_1 = require("path");
-const configs_1 = require("../config/configs");
-class LintFixScript extends src_1.ScriptBase {
-    get name() {
-        return 'lint-fix';
-    }
-    get description() {
-        return `Fix the code using ESLint and Prettier rules).`;
-    }
-    main() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const projectRoot = (0, path_1.resolve)(`${configs_1.configs.root}/..`);
-            this.logger.info(`Fixing using Prettier rules`);
-            yield this.invokeShellCommand(`${projectRoot}/node_modules/.bin/prettier`, [
-                '--write',
-                projectRoot,
-            ]);
-            this.logger.info(`Fixing using ESLint rules`);
-            yield this.invokeShellCommand(`${projectRoot}/node_modules/.bin/eslint`, [
-                '--fix',
-                projectRoot,
-            ]);
-        });
-    }
-}
-exports.LintFixScript = LintFixScript;
-//# sourceMappingURL=lintFix.js.map

package/dist/scripts/lintFix.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lintFix.js","sourceRoot":"","sources":["../../scripts/lintFix.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAAiE;AACjE,+BAA+B;AAC/B,+CAA4C;AAE5C,MAAa,aAAc,SAAQ,gBAAU;IAC3C,IAAI,IAAI;QACN,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,gDAAgD,CAAC;IAC1D,CAAC;IAEe,IAAI;;YAClB,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,GAAG,iBAAO,CAAC,IAAI,KAAK,CAAC,CAAC;YAClD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAChD,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,WAAW,6BAA6B,EAAE;gBACzE,SAAS;gBACT,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YAC9C,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,WAAW,2BAA2B,EAAE;gBACvE,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAvBD,sCAuBC"}