refactor: dev-scripts

forcedotcom · Nov 9, 2023 · 9fe6f49 · 9fe6f49 · svc-cli-bot · Nov 9, 2023
1 parent a702f2b
commit 9fe6f49
Show file tree

Hide file tree

Showing 58 changed files with 628 additions and 663 deletions.
diff --git a/package.json b/package.json
@@ -59,41 +59,17 @@
     "ts-retry-promise": "^0.7.1"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^4.1.0",
-    "@salesforce/dev-scripts": "^5.11.0",
-    "@salesforce/prettier-config": "^0.0.3",
+    "@salesforce/dev-scripts": "^6.0.3",
     "@salesforce/ts-sinon": "^1.4.18",
     "@types/benchmark": "^2.1.3",
     "@types/chai-string": "^1.4.4",
     "@types/jsonwebtoken": "9.0.3",
-    "@types/lodash": "^4.14.200",
     "@types/proper-lockfile": "^4.1.2",
-    "@types/shelljs": "0.8.13",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
     "benchmark": "^2.1.4",
-    "chai": "^4.3.10",
     "chai-string": "^1.5.0",
-    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-config-salesforce": "^2.0.2",
-    "eslint-config-salesforce-license": "^0.2.0",
-    "eslint-config-salesforce-typescript": "^1.1.2",
-    "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jsdoc": "^43.2.0",
-    "husky": "^7.0.4",
-    "lodash": "^4.17.21",
-    "mocha": "^9.1.3",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.7",
-    "pretty-quick": "^3.1.3",
-    "shelljs": "0.8.5",
-    "sinon": "^14.0.2",
-    "ts-node": "^10.4.0",
+    "ts-node": "^10.9.1",
     "ttypescript": "^1.5.15",
-    "typescript": "^4.9.5",
-    "wireit": "^0.14.0"
+    "typescript": "^4.9.5"
   },
   "repository": {
     "type": "git",

diff --git a/src/config/config.ts b/src/config/config.ts
@@ -5,8 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { dirname as pathDirname, join as pathJoin } from 'path';
-import * as fs from 'fs';
+import { dirname as pathDirname, join as pathJoin } from 'node:path';
+import * as fs from 'node:fs';
 import { keyBy, parseJsonMap } from '@salesforce/kit';
 import { Dictionary, ensure, isString, Nullable } from '@salesforce/ts-types';
 import { Global } from '../global';
@@ -96,7 +96,7 @@ export const SF_ALLOWED_PROPERTIES = [
     key: SfConfigProperties.DISABLE_TELEMETRY,
     description: messages.getMessage(SfConfigProperties.DISABLE_TELEMETRY),
     input: {
-      validator: (value: ConfigValue): boolean => value == null || ['true', 'false'].includes(value.toString()),
+      validator: (value: ConfigValue): boolean => value == null || isBooleanOrBooleanString(value),
       failedMessage: messages.getMessage('invalidBooleanConfigValue'),
     },
   },
@@ -248,7 +248,7 @@ export const SFDX_ALLOWED_PROPERTIES = [
     deprecated: true,
     description: messages.getMessage(SfdxPropertyKeys.DISABLE_TELEMETRY),
     input: {
-      validator: (value: ConfigValue): boolean => value == null || ['true', 'false'].includes(value.toString()),
+      validator: (value: ConfigValue): boolean => value == null || isBooleanOrBooleanString(value),
       failedMessage: messages.getMessage('invalidBooleanConfigValue'),
     },
   },
@@ -265,7 +265,7 @@ export const SFDX_ALLOWED_PROPERTIES = [
     newKey: 'org-metadata-rest-deploy',
     deprecated: true,
     input: {
-      validator: (value: ConfigValue): boolean => value != null && ['true', 'false'].includes(value.toString()),
+      validator: (value: ConfigValue): boolean => value != null && isBooleanOrBooleanString(value),
       failedMessage: messages.getMessage('invalidBooleanConfigValue'),
     },
   },
@@ -662,3 +662,6 @@ const stateFromSfdxFileSync = (path: string, config: Config): LWWState<ConfigPro
     return {};
   }
 };
+
+const isBooleanOrBooleanString = (value: unknown): boolean =>
+  (typeof value === 'string' && ['true', 'false'].includes(value)) || typeof value === 'boolean';
diff --git a/src/config/configFile.ts b/src/config/configFile.ts
@@ -5,10 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as fs from 'fs';
-import { constants as fsConstants, Stats as fsStats } from 'fs';
-import { homedir as osHomedir } from 'os';
-import { join as pathJoin } from 'path';
+import * as fs from 'node:fs';
+import { constants as fsConstants, Stats as fsStats } from 'node:fs';
+import { homedir as osHomedir } from 'node:os';
+import { join as pathJoin } from 'node:path';
 import { parseJsonMap } from '@salesforce/kit';
 import { Global } from '../global';
 import { Logger } from '../logger/logger';

diff --git a/src/config/configStore.ts b/src/config/configStore.ts
@@ -356,7 +356,7 @@ export abstract class BaseConfigStore<
     if (!this.crypto) throw new SfError('crypto is not initialized', 'CryptoNotInitializedError');
     if (!isString(value))
       throw new SfError(
-        `can only encrypt strings but found: ${typeof value} : ${value.toString()}`,
+        `can only encrypt strings but found: ${typeof value} : ${JSON.stringify(value)}`,
         'InvalidCryptoValueError'
       );
     return this.crypto.isEncrypted(value) ? value : this.crypto.encrypt(value);
@@ -367,7 +367,7 @@ export abstract class BaseConfigStore<
     if (!this.crypto) throw new SfError('crypto is not initialized', 'CryptoNotInitializedError');
     if (!isString(value))
       throw new SfError(
-        `can only encrypt strings but found: ${typeof value} : ${value.toString()}`,
+        `can only encrypt strings but found: ${typeof value} : ${JSON.stringify(value)}`,
         'InvalidCryptoValueError'
       );
     return this.crypto.isEncrypted(value) ? this.crypto.decrypt(value) : value;

diff --git a/src/config/envVars.ts b/src/config/envVars.ts
@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { join as pathJoin } from 'path';
+import { join as pathJoin } from 'node:path';
 import { Dictionary, Nullable } from '@salesforce/ts-types';
 import { camelCase, snakeCase } from 'change-case';
 import { Env } from '@salesforce/kit';

diff --git a/src/config/lwwMap.ts b/src/config/lwwMap.ts
@@ -35,7 +35,7 @@ export const stateFromContents = <P extends ConfigContents>(contents: P, timesta
 
 export class LWWMap<P extends ConfigContents> {
   /** map of key to LWWRegister.  Used for managing conflicts */
-  #data = new Map<string, LWWRegister<unknown | typeof SYMBOL_FOR_DELETED>>();
+  #data = new Map<string, LWWRegister<unknown>>();
 
   public constructor(state?: LWWState<P>) {
     // create a new register for each key in the initial state

diff --git a/src/crypto/crypto.ts b/src/crypto/crypto.ts
@@ -6,9 +6,9 @@
  */
 /* eslint-disable @typescript-eslint/ban-types */
 
-import * as crypto from 'crypto';
-import * as os from 'os';
-import { join as pathJoin } from 'path';
+import * as crypto from 'node:crypto';
+import * as os from 'node:os';
+import { join as pathJoin } from 'node:path';
 import { ensure, Nullable, Optional } from '@salesforce/ts-types';
 import { AsyncOptionalCreatable, env } from '@salesforce/kit';
 import { Logger } from '../logger/logger';

diff --git a/src/crypto/keyChainImpl.ts b/src/crypto/keyChainImpl.ts
@@ -5,12 +5,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as childProcess from 'child_process';
-import * as nodeFs from 'fs';
-import * as fs from 'fs';
-import * as os from 'os';
-import { homedir } from 'os';
-import * as path from 'path';
+import * as childProcess from 'node:child_process';
+import * as nodeFs from 'node:fs';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import { homedir } from 'node:os';
+import * as path from 'node:path';
 import { asString, ensureString, Nullable } from '@salesforce/ts-types';
 import { parseJsonMap } from '@salesforce/kit';
 import { Global } from '../global';
@@ -46,7 +46,7 @@ const isExe = (mode: number, gid: number, uid: number): boolean => {
 
   return Boolean(
     mode & parseInt('0001', 8) ||
-      (mode & parseInt('0010', 8) && process.getgid && gid === process.getgid()) ||
+      Boolean(mode & parseInt('0010', 8) && process.getgid && gid === process.getgid()) ||
       (mode & parseInt('0100', 8) && process.getuid && uid === process.getuid())
   );
 };

diff --git a/src/crypto/secureBuffer.ts b/src/crypto/secureBuffer.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as crypto from 'crypto';
+import * as crypto from 'node:crypto';
 import { ensure, Optional } from '@salesforce/ts-types';
 
 const cipherName = 'aes-256-cbc';

diff --git a/src/global.ts b/src/global.ts
@@ -5,9 +5,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
 import { env } from '@salesforce/kit';
 import { SfError } from './sfError';
 

diff --git a/src/logger/logger.ts b/src/logger/logger.ts
@@ -4,8 +4,8 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import * as os from 'os';
-import * as path from 'path';
+import * as os from 'node:os';
+import * as path from 'node:path';
 
 import { Logger as PinoLogger, pino } from 'pino';
 import { Env } from '@salesforce/kit';
@@ -171,7 +171,7 @@ export class Logger {
         level,
         enabled,
       };
-      if (options.useMemoryLogger || Global.getEnvironmentMode() === Mode.TEST || !enabled) {
+      if (Boolean(options.useMemoryLogger) || Global.getEnvironmentMode() === Mode.TEST || !enabled) {
         this.memoryLogger = new MemoryLogger();
         this.pinoLogger = pino(
           {

diff --git a/src/logger/memoryLogger.ts b/src/logger/memoryLogger.ts
@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { Writable } from 'stream';
+import { Writable } from 'node:stream';
 import { unwrapArray } from '../util/unwrapArray';
 import { filterSecrets } from './filters';
 

diff --git a/src/logger/transformStream.ts b/src/logger/transformStream.ts
@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { pipeline, Transform } from 'stream';
+import { pipeline, Transform } from 'node:stream';
 import { unwrapArray } from '../util/unwrapArray';
 import { filterSecrets } from './filters';
 

diff --git a/src/messages.ts b/src/messages.ts
@@ -5,10 +5,10 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import * as util from 'util';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import * as util from 'node:util';
 import { AnyJson, asString, ensureJsonMap, ensureString, isJsonMap, isObject } from '@salesforce/ts-types';
 import { ensureArray, NamedError, upperFirst } from '@salesforce/kit';
 import { SfError } from './sfError';
@@ -544,7 +544,7 @@ export class Messages<T extends string> {
     //     'myMessage' -> `MyMessageWarning`
     //     'myMessageError' -> `MyMessageError`
     //     'warning.myMessage' -> `MyMessageWarning`
-    const name = `${upperFirst(key.replace(searchValue, ''))}${labelRegExp.exec(key) || preserveName ? '' : label}`;
+    const name = `${upperFirst(key.replace(searchValue, ''))}${labelRegExp.exec(key) ?? preserveName ? '' : label}`;
     const message = this.getMessage(key, tokens);
     let actions;
     try {

diff --git a/src/org/authInfo.ts b/src/org/authInfo.ts
@@ -6,10 +6,10 @@
  */
 /* eslint-disable class-methods-use-this */
 
-import { randomBytes } from 'crypto';
-import { resolve as pathResolve } from 'path';
-import * as os from 'os';
-import * as fs from 'fs';
+import { randomBytes } from 'node:crypto';
+import { resolve as pathResolve } from 'node:path';
+import * as os from 'node:os';
+import * as fs from 'node:fs';
 import { Record as RecordType } from 'jsforce';
 import { AsyncOptionalCreatable, cloneJson, env, isEmpty, parseJson, parseJsonMap } from '@salesforce/kit';
 import {
@@ -394,7 +394,7 @@ export class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     const logger = await Logger.child('Common', { tag: 'identifyPossibleScratchOrgs' });
 
     // return if we already know the hub org, we know it is a devhub or prod-like, or no orgId present
-    if (fields.isDevHub || fields.devHubUsername || !fields.orgId) return;
+    if (Boolean(fields.isDevHub) || Boolean(fields.devHubUsername) || !fields.orgId) return;
 
     logger.debug('getting devHubs and prod orgs to identify scratch orgs and sandboxes');
 
@@ -715,7 +715,7 @@ export class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
    */
   public async handleAliasAndDefaultSettings(sideEffects: AuthSideEffects): Promise<void> {
     if (
-      sideEffects.alias ||
+      Boolean(sideEffects.alias) ||
       sideEffects.setDefault ||
       sideEffects.setDefaultDevHub ||
       typeof sideEffects.setTracksSource === 'boolean'

diff --git a/src/org/connection.ts b/src/org/connection.ts
@@ -7,7 +7,7 @@
 
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 
-import { URL } from 'url';
+import { URL } from 'node:url';
 import { AsyncResult, DeployOptions, DeployResultLocator } from 'jsforce/api/metadata';
 import { Duration, env, maxBy } from '@salesforce/kit';
 import { asString, ensure, isString, JsonMap, Optional } from '@salesforce/ts-types';

diff --git a/src/org/org.ts b/src/org/org.ts
@@ -6,8 +6,8 @@
  */
 /* eslint-disable class-methods-use-this */
 
-import { join as pathJoin } from 'path';
-import * as fs from 'fs';
+import { join as pathJoin } from 'node:path';
+import * as fs from 'node:fs';
 import { AsyncOptionalCreatable, Duration } from '@salesforce/kit';
 import {
   AnyFunction,

diff --git a/src/org/orgConfigProperties.ts b/src/org/orgConfigProperties.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { join as pathJoin } from 'path';
+import { join as pathJoin } from 'node:path';
 import { isString } from '@salesforce/ts-types';
 import { ConfigValue } from '../config/configStackTypes';
 import { Messages } from '../messages';

diff --git a/src/org/permissionSetAssignment.ts b/src/org/permissionSetAssignment.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import { mapKeys, upperFirst } from '@salesforce/kit';
 import type { Optional } from '@salesforce/ts-types';
 import type { QueryResult, Record } from 'jsforce';

diff --git a/src/org/scratchOrgInfoGenerator.ts b/src/org/scratchOrgInfoGenerator.ts
@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { promises as fs } from 'fs';
+import { promises as fs } from 'node:fs';
 import { parseJson } from '@salesforce/kit';
 import { ensureString } from '@salesforce/ts-types';
 import { SfProjectJson } from '../sfProject';

diff --git a/src/org/scratchOrgSettingsGenerator.ts b/src/org/scratchOrgSettingsGenerator.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as path from 'path';
+import * as path from 'node:path';
 import { isEmpty, env, upperFirst, Duration } from '@salesforce/kit';
 import { ensureObject, JsonMap } from '@salesforce/ts-types';
 import * as js2xmlparser from 'js2xmlparser';
@@ -291,7 +291,7 @@ export default class SettingsGenerator {
       fullName: string;
       problem: string;
     };
-    if (status !== RequestStatus.Succeeded) {
+    if (status !== RequestStatus.Succeeded.toString()) {
       const componentFailures = ensureObject<{
         componentFailures: FailureMessage | FailureMessage[];
       }>(result.details).componentFailures;

diff --git a/src/org/user.ts b/src/org/user.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import { AsyncCreatable, lowerFirst, mapKeys, omit, parseJsonMap, upperFirst } from '@salesforce/kit';
 import { asJsonArray, asNumber, ensureJsonMap, ensureString, isJsonMap, Many } from '@salesforce/ts-types';
 import type { HttpRequest, HttpResponse, QueryResult, Schema, SObjectUpdateRecord } from 'jsforce';

diff --git a/src/schema/validator.ts b/src/schema/validator.ts
@@ -5,8 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as path from 'path';
-import * as fs from 'fs';
+import * as path from 'node:path';
+import * as fs from 'node:fs';
 import Ajv, { DefinedError } from 'ajv';
 import { AnyJson, JsonMap } from '@salesforce/ts-types';
 import { getJsonValuesByName, parseJsonMap } from '@salesforce/kit';

diff --git a/src/sfError.ts b/src/sfError.ts
@@ -75,7 +75,7 @@ export class SfError extends NamedError {
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public get code(): string | undefined | any {
+  public get code(): any {
     return this.#code ?? this.name;
   }
Benchmark suite	Current: `9fe6f49`	Previous: `a702f2b`	Ratio
`Child logger creation`	`475482` ops/sec (`±2.64%`)	`301912` ops/sec (`±0.86%`)	`0.63`
`Logging a string on root logger`	`788927` ops/sec (`±10.09%`)	`502958` ops/sec (`±12.36%`)	`0.64`
`Logging an object on root logger`	`510087` ops/sec (`±9.12%`)	`362410` ops/sec (`±11.17%`)	`0.71`
`Logging an object with a message on root logger`	`11581` ops/sec (`±188.95%`)	`263524` ops/sec (`±15.83%`)	`22.75`
`Logging an object with a redacted prop on root logger`	`410237` ops/sec (`±10.00%`)	`258563` ops/sec (`±16.36%`)	`0.63`
`Logging a nested 3-level object on root logger`	`339631` ops/sec (`±8.24%`)	`2557` ops/sec (`±215.13%`)	`0.007528759153316394`
Benchmark suite	Current: `9fe6f49`	Previous: `a702f2b`	Ratio
`Child logger creation`	`336036` ops/sec (`±0.70%`)	`345983` ops/sec (`±0.46%`)	`1.03`
`Logging a string on root logger`	`764947` ops/sec (`±10.57%`)	`806782` ops/sec (`±7.23%`)	`1.05`
`Logging an object on root logger`	`604659` ops/sec (`±6.60%`)	`585281` ops/sec (`±6.49%`)	`0.97`
`Logging an object with a message on root logger`	`7782` ops/sec (`±202.41%`)	`7111` ops/sec (`±204.28%`)	`0.91`
`Logging an object with a redacted prop on root logger`	`465357` ops/sec (`±11.05%`)	`446007` ops/sec (`±9.91%`)	`0.96`
`Logging a nested 3-level object on root logger`	`322938` ops/sec (`±6.40%`)	`310288` ops/sec (`±5.39%`)	`0.96`