refactor: devScripts update (#789)

* chore: updates from devScripts * chore: type safety on error code --------- Co-authored-by: mshanemc <[email protected]>
salesforcecli · Oct 31, 2023 · d8b043b · d8b043b
1 parent be9c147
commit d8b043b
Show file tree

Hide file tree

Showing 71 changed files with 465 additions and 319 deletions.
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "@oclif/plugin-command-snapshot": "^4.0.12",
     "@salesforce/cli-plugins-testkit": "^4.4.7",
     "@salesforce/dev-config": "^4.0.1",
-    "@salesforce/dev-scripts": "^5.11.0",
+    "@salesforce/dev-scripts": "^5.12.2",
     "@salesforce/plugin-command-reference": "^3.0.40",
     "@salesforce/plugin-settings": "^1.4.27",
     "@salesforce/plugin-source": "^2.10.30",
@@ -34,16 +34,16 @@
     "@types/shelljs": "^0.8.13",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "chai": "^4.3.8",
+    "chai": "^4.3.10",
     "cross-env": "^7.0.3",
     "eslint": "^8.52.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-config-salesforce": "^2.0.1",
     "eslint-config-salesforce-license": "^0.2.0",
-    "eslint-config-salesforce-typescript": "^1.1.1",
+    "eslint-config-salesforce-typescript": "^2.0.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-jsdoc": "^43.0.5",
+    "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-sf-plugin": "^1.16.7",
     "husky": "^7.0.4",
     "jsforce": "^2.0.0-beta.28",
@@ -55,8 +55,8 @@
     "shx": "0.3.4",
     "sinon": "11.1.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5",
-    "wireit": "^0.14.0"
+    "typescript": "^5.2.2",
+    "wireit": "^0.14.1"
   },
   "config": {},
   "engines": {

diff --git a/src/commands/deploy.ts b/src/commands/deploy.ts
@@ -6,7 +6,7 @@
  */
 /* eslint-disable class-methods-use-this */
 
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import { writeFile, readFile } from 'node:fs/promises';
 import { existsSync } from 'node:fs';
 import { Hook } from '@oclif/core';

diff --git a/src/commands/project/convert/mdapi.ts b/src/commands/project/convert/mdapi.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, resolve } from 'path';
-import * as fs from 'fs';
+import { dirname, resolve } from 'node:path';
+import * as fs from 'node:fs';
 import { Messages, SfError } from '@salesforce/core';
 import {
   ComponentSet,

diff --git a/src/commands/project/convert/source.ts b/src/commands/project/convert/source.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 { resolve } from 'path';
-import * as fs from 'fs';
+import { resolve } from 'node:path';
+import * as fs from 'node:fs';
 
 import { Messages } from '@salesforce/core';
 import {

diff --git a/src/commands/project/delete/source.ts b/src/commands/project/delete/source.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 path from 'path';
-import * as os from 'os';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as os from 'node:os';
 import { Interfaces } from '@oclif/core';
 import { Lifecycle, Messages, Org, SfError } from '@salesforce/core';
 import {

diff --git a/src/commands/project/deploy/cancel.ts b/src/commands/project/deploy/cancel.ts
@@ -97,7 +97,12 @@ export default class DeployMetadataCancel extends SfCommand<DeployResultJson> {
   protected catch(error: SfCommand.Error): Promise<SfCommand.Error> {
     if (error.name.includes('INVALID_ID_FIELD')) {
       const err = messages.createError('error.CannotCancelDeploy');
-      return super.catch({ ...error, name: err.name, message: err.message, code: err.code });
+      return super.catch({
+        ...error,
+        name: err.name,
+        message: err.message,
+        ...(typeof err.code === 'string' || typeof err.code === 'number' ? { code: err.code } : {}),
+      });
     }
     return super.catch(error);
   }

diff --git a/src/commands/project/deploy/quick.ts b/src/commands/project/deploy/quick.ts
@@ -131,7 +131,12 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
   protected catch(error: SfCommand.Error): Promise<SfCommand.Error> {
     if (error.name.includes('INVALID_ID_FIELD')) {
       const err = messages.createError('error.CannotQuickDeploy');
-      return super.catch({ ...error, name: err.name, message: err.message, code: err.code });
+      return super.catch({
+        ...error,
+        name: err.name,
+        message: err.message,
+        ...(typeof err.code === 'string' || typeof err.code === 'number' ? { code: err.code } : {}),
+      });
     }
     return super.catch(error);
   }

diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -274,7 +274,12 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     }
     if (error.message.includes('client has timed out')) {
       const err = messages.createError('error.ClientTimeout', [this.config.bin]);
-      return super.catch({ ...error, name: err.name, message: err.message, code: err.code });
+      return super.catch({
+        ...error,
+        name: err.name,
+        message: err.message,
+        ...(typeof err.code === 'string' || typeof err.code === 'number' ? { code: err.code } : {}),
+      });
     }
     return super.catch(error);
   }

diff --git a/src/commands/project/deploy/validate.ts b/src/commands/project/deploy/validate.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 * as os from 'os';
+import * as os from 'node:os';
 import { bold } from 'chalk';
 import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError } from '@salesforce/core';
 import { CodeCoverageWarnings, DeployVersionData, RequestStatus } from '@salesforce/source-deploy-retrieve';

diff --git a/src/commands/project/generate/manifest.ts b/src/commands/project/generate/manifest.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 { join } from 'path';
-import * as fs from 'fs';
+import { join } from 'node:path';
+import * as fs from 'node:fs';
 import { Messages, Org } from '@salesforce/core';
 import { ComponentSetBuilder } from '@salesforce/source-deploy-retrieve';
 import {

diff --git a/src/commands/project/list/ignored.ts b/src/commands/project/list/ignored.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 path from 'path';
-import * as fs from 'fs';
+import * as path from 'node:path';
+import * as fs from 'node:fs';
 import { Messages, SfError } from '@salesforce/core';
 import { ForceIgnore } from '@salesforce/source-deploy-retrieve';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';

diff --git a/src/commands/project/retrieve/start.ts b/src/commands/project/retrieve/start.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 { rm } from 'fs/promises';
-import { dirname, join, resolve } from 'path';
+import { rm } from 'node:fs/promises';
+import { dirname, join, resolve } from 'node:path';
 
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError, SfProject } from '@salesforce/core';
 import {
   RetrieveResult,

diff --git a/src/formatters/deployResultFormatter.ts b/src/formatters/deployResultFormatter.ts
@@ -4,9 +4,9 @@
  * 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 path from 'path';
+import * as path from 'node:path';
 import { EOL } from 'node:os';
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 import { ux } from '@oclif/core';
 import { DeployResult, FileResponse, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { Org, SfError, Lifecycle } from '@salesforce/core';

diff --git a/src/formatters/metadataConvertResultFormatter.ts b/src/formatters/metadataConvertResultFormatter.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 * as path from 'path';
+import * as path from 'node:path';
 import { ux } from '@oclif/core';
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
 import { Formatter, ConvertMdapiJson } from '../utils/types';

diff --git a/src/formatters/metadataRetrieveResultFormatter.ts b/src/formatters/metadataRetrieveResultFormatter.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 * as path from 'path';
+import * as path from 'node:path';
 import { ux } from '@oclif/core';
 import { FileResponse, RetrieveResult } from '@salesforce/source-deploy-retrieve';
 import { Messages } from '@salesforce/core';

diff --git a/src/formatters/retrieveResultFormatter.ts b/src/formatters/retrieveResultFormatter.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 * as path from 'path';
+import * as path from 'node:path';
 import { Ux } from '@salesforce/sf-plugins-core';
 import { FileResponse, RetrieveMessage, RetrieveResult } from '@salesforce/source-deploy-retrieve';
 import { NamedPackageDir, SfProject } from '@salesforce/core';

diff --git a/src/formatters/sourceConvertResultFormatter.ts b/src/formatters/sourceConvertResultFormatter.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 { resolve } from 'path';
+import { resolve } from 'node:path';
 import { ux } from '@oclif/core';
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
 import { SfError, Messages } from '@salesforce/core';

diff --git a/src/formatters/testResultsFormatter.ts b/src/formatters/testResultsFormatter.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 * as os from 'os';
+import * as os from 'node:os';
 import { ux } from '@oclif/core';
 import { dim, underline } from 'chalk';
 import {

diff --git a/src/utils/coverage.ts b/src/utils/coverage.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 * as path from 'path';
+import * as path from 'node:path';
 
 import {
   ApexTestResultData,

diff --git a/src/utils/flags.ts b/src/utils/flags.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 fs from 'fs';
-import { resolve, extname } from 'path';
+import * as fs from 'node:fs';
+import { resolve, extname } from 'node:path';
 import { Flags } from '@oclif/core';
 import { Messages, Lifecycle } from '@salesforce/core';
 import { PathInfo, TestLevel, reportsFormatters } from './types';

diff --git a/src/utils/manifestCache.ts b/src/utils/manifestCache.ts
@@ -4,9 +4,9 @@
  * 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 path from 'path';
-import { homedir } from 'os';
-import * as fs from 'fs';
+import * as path from 'node:path';
+import { homedir } from 'node:os';
+import * as fs from 'node:fs';
 import { ComponentSet } from '@salesforce/source-deploy-retrieve';
 import { Global } from '@salesforce/core';
 

diff --git a/src/utils/metadataDeployer.ts b/src/utils/metadataDeployer.ts
@@ -6,7 +6,7 @@
  */
 /* eslint-disable class-methods-use-this */
 
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import { cyan, red } from 'chalk';
 import { Duration } from '@salesforce/kit';
 import {

diff --git a/src/utils/output.ts b/src/utils/output.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 { blue, bold } from 'chalk';
 import { StandardColors } from '@salesforce/sf-plugins-core';
 import { FileResponse, FileResponseFailure, FileResponseSuccess } from '@salesforce/source-deploy-retrieve';

diff --git a/src/utils/previewOutput.ts b/src/utils/previewOutput.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 * as path from 'path';
+import * as path from 'node:path';
 import { ux } from '@oclif/core';
 import { StandardColors } from '@salesforce/sf-plugins-core';
 import { bold, dim } from 'chalk';

diff --git a/test/commands/convert/source.test.ts b/test/commands/convert/source.test.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, resolve, sep } from 'path';
+import { join, resolve, sep } from 'node:path';
 import { ComponentSetBuilder, ComponentSetOptions, MetadataConverter } from '@salesforce/source-deploy-retrieve';
 import * as sinon from 'sinon';
 import { expect } from 'chai';

diff --git a/test/commands/delete/source.test.ts b/test/commands/delete/source.test.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 fs from 'fs';
+import * as fs from 'node:fs';
 import * as sinon from 'sinon';
 import { expect } from 'chai';
 import {

diff --git a/test/commands/deploy.nut.ts b/test/commands/deploy.nut.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 { SourceTestkit } from '@salesforce/source-testkit';
 import { writeJson } from '../../src/commands/deploy';
 import { TestLevel } from '../../src/utils/types';

diff --git a/test/commands/deploy/metadata/cancel.nut.ts b/test/commands/deploy/metadata/cancel.nut.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 fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import { strict as assert } from 'node:assert';
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';

diff --git a/test/commands/deploy/metadata/resume.nut.ts b/test/commands/deploy/metadata/resume.nut.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 fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import { strict as assert } from 'node:assert';
 import { SourceTestkit } from '@salesforce/source-testkit';
 import { expect } from 'chai';

diff --git a/test/commands/deploy/metadata/validate.nut.ts b/test/commands/deploy/metadata/validate.nut.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 { SourceTestkit } from '@salesforce/source-testkit';
 import { isObject } from '@salesforce/ts-types';
 import { assert, expect } from 'chai';

diff --git a/test/commands/retrieve/start.test.ts b/test/commands/retrieve/start.test.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 * as sinon from 'sinon';
 import { expect } from 'chai';
 import {

diff --git a/test/nuts/convert/mdapi.nut.ts b/test/nuts/convert/mdapi.nut.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 fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import { expect, assert } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { ComponentSet, SourceComponent } from '@salesforce/source-deploy-retrieve';

diff --git a/test/nuts/convert/source.nut.ts b/test/nuts/convert/source.nut.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 fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import { expect } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { ConvertResultJson } from '../../../src/utils/types';

diff --git a/test/nuts/delete/source.nut.ts b/test/nuts/delete/source.nut.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 fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import { expect } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { SourceTestkit } from '@salesforce/source-testkit';

diff --git a/test/nuts/deploy/formatter.nut.ts b/test/nuts/deploy/formatter.nut.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 { EOL } from 'node:os';
 import { expect } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';