build: upgrade to esm

baslu93 · web-flow · commit dbc20168d82e · 2024-03-06T09:50:56.000+01:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+*.cjs/
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,4 +1,3 @@
 module.exports = {
   extends: ['eslint-config-salesforce-typescript', 'plugin:sf-plugin/recommended'],
-  root: true,
 };
diff --git a/.github/workflows/onPullRequest.yml b/.github/workflows/onPullRequest.yml
@@ -27,10 +27,16 @@ jobs:
       - name: Install Salesforce CLI
         run: npm install @salesforce/cli --global
 
+      - name: Install packages
+        run: yarn install
+
+      - name: Compile
+        run: yarn run compile
+
       - name: Install plugin
         run: |
           sf plugins link .
           sf plugins
 
-      - name: Unit test
-        run: yarn test:only
+      - name: Unit tests
+        run: yarn run test:only
diff --git a/.mocharc.json b/.mocharc.json
@@ -1,7 +1,8 @@
 {
-  "require": "ts-node/register,source-map-support/register",
+  "require": ["ts-node/register"],
   "watch-extensions": "ts",
   "recursive": true,
   "reporter": "spec",
-  "timeout": 600000
+  "timeout": 5000,
+  "node-option": ["loader=ts-node/esm"]
 }
diff --git a/.nycrc b/.nycrc
@@ -1,7 +1,5 @@
 {
-  "check-coverage": true,
-  "lines": 75,
-  "statements": 75,
-  "functions": 75,
-  "branches": 50
+  "nyc": {
+    "extends": "@salesforce/dev-config/nyc"
+  }
 }
diff --git a/.sfdevrc.json b/.sfdevrc.json
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,5 @@
 FROM salesforce/cli:latest-full
 WORKDIR /plugin
 COPY . .
+RUN npm run compile
 RUN sf plugins link .
diff --git a/README.md b/README.md
@@ -9,6 +9,9 @@ The process is highly manual, and forgetting to track certain fields often cause
 
 The command, which can be executed locally or inserted into a CI/CD pipeline, verifies the required fields from the recipes and marks them in the environment within seconds.
 
+> [!NOTE]
+> Despite the warning message indicating partial support for ESM plugins in OCLIF, rest assured that the plugins will function as expected.
+
 ## Install
 
 Run the following command (if you are still using the old CLI, relace `sf` with `sfdx` or [move to the new CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_move_to_sf_v2.htm)):
diff --git a/bin/dev b/bin/dev
diff --git a/bin/dev.cmd b/bin/dev.cmd
@@ -1,3 +1,3 @@
 @echo off
-set NODE_ENV=development
-node "%~dp0\dev" %*
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
diff --git a/bin/dev.js b/bin/dev.js
@@ -0,0 +1,9 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+// eslint-disable-next-line node/shebang
+async function main() {
+  const { execute } = await import('@oclif/core');
+  await execute({ development: true, dir: import.meta.url });
+}
+
+await main();
diff --git a/bin/run b/bin/run
diff --git a/bin/run.js b/bin/run.js
@@ -0,0 +1,9 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+// eslint-disable-next-line node/shebang
+async function main() {
+  const { execute } = await import('@oclif/core');
+  await execute({ dir: import.meta.url });
+}
+
+await main();
diff --git a/commitlint.config.cjs b/commitlint.config.cjs
diff --git a/package.json b/package.json
@@ -2,32 +2,32 @@
   "name": "plugin-analytics-connected-objects",
   "description": "Additional Salesforce CLI commands to manage CRM Analytics connected-objects",
   "version": "1.1.1",
+  "author": "Luca Bassani",
+  "dependencies": {
+    "@oclif/core": "^3.22.0",
+    "@salesforce/core": "^6.7.0",
+    "@salesforce/sf-plugins-core": "^7.1.14",
+    "@salesforce/source-deploy-retrieve": "^10.5.1"
+  },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^5.1.8",
-    "@salesforce/dev-scripts": "^7.1.1",
-    "eslint-plugin-sf-plugin": "^1.17.3",
-    "mocha": "^10.3.0",
-    "nyc": "^15.1.0",
-    "oclif": "^4.4.7",
+    "@oclif/plugin-command-snapshot": "^5.1.0",
+    "@salesforce/cli-plugins-testkit": "^5.1.10",
+    "@salesforce/dev-scripts": "^8.4.2",
+    "@types/mocha": "^10.0.6",
+    "eslint-plugin-sf-plugin": "^1.17.4",
+    "oclif": "^4.5.0",
     "shx": "^0.3.4",
     "ts-node": "^10.9.2",
-    "wireit": "^0.14.4"
-  },
-  "dependencies": {
-    "@oclif/core": "^3.19.1",
-    "@salesforce/core": "^6.5.3",
-    "@salesforce/kit": "^3.0.15",
-    "@salesforce/sf-plugins-core": "^5.0.13",
-    "@salesforce/source-deploy-retrieve": "^10.3.7",
-    "@salesforce/ts-types": "^2.0.9"
+    "typescript": "^5.3.3"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "files": [
     "/lib",
     "/messages",
-    "/oclif.manifest.json"
+    "/oclif.manifest.json",
+    "/oclif.lock"
   ],
   "keywords": [
     "force",
@@ -39,7 +39,6 @@
     "sf"
   ],
   "license": "MIT",
-  "main": "lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "sf",
@@ -61,18 +60,20 @@
           }
         }
       }
-    }
+    },
+    "flexibleTaxonomy": true
   },
   "scripts": {
     "build": "wireit",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
-    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json oclif.lock",
     "compile": "wireit",
     "docs": "sf-docs",
     "format": "wireit",
     "lint": "wireit",
-    "postpack": "shx rm -f oclif.manifest.json",
+    "postinstall": "yarn husky install",
+    "postpack": "shx rm -f oclif.manifest.json oclif.lock",
     "prepack": "sf-prepack",
     "test": "wireit",
     "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000",
@@ -184,5 +185,6 @@
       "output": []
     }
   },
-  "author": "Luca Bassani"
-}
+  "exports": "./lib/index.js",
+  "type": "module"
+}
diff --git a/src/apiHelper.ts b/src/apiHelper.ts
@@ -1,6 +1,12 @@
 import { Connection } from '@salesforce/core';
-import { ChangedAndMissingFields, GetDataConnectors, GetReplicatedDatasets, PostReplicatedDataset, ReplicatedDataset } from './modules/upsert';
-import { GetReplicatedDatasetFields } from './modules/upsert';
+import {
+  ChangedAndMissingFields,
+  GetDataConnectors,
+  GetReplicatedDatasets,
+  PostReplicatedDataset,
+  ReplicatedDataset,
+} from './modules/upsert.js';
+import { GetReplicatedDatasetFields } from './modules/upsert.js';
 
 export class ApiHelper {
   public static readonly REPLICATED_DATASETS_API = '/wave/replicatedDatasets';
@@ -13,19 +19,15 @@ export class ApiHelper {
 
   public async getConnectors(): Promise<Map<string, string>> {
     const response = new Map<string, string>();
-    const getDataConnectorsResponse = await this.conn.requestGet<GetDataConnectors>(
-      ApiHelper.DATA_CONNECTORS_API
-    );
+    const getDataConnectorsResponse = await this.conn.requestGet<GetDataConnectors>(ApiHelper.DATA_CONNECTORS_API);
     for (const connector of getDataConnectorsResponse.dataConnectors) {
       response.set(connector.name, connector.id);
     }
     return response;
   }
 
   public async getReplicatedDatasets(): Promise<ReplicatedDataset[]> {
-    const replicatedDatasets = await this.conn.requestGet<GetReplicatedDatasets>(
-      ApiHelper.REPLICATED_DATASETS_API
-    );
+    const replicatedDatasets = await this.conn.requestGet<GetReplicatedDatasets>(ApiHelper.REPLICATED_DATASETS_API);
     return replicatedDatasets.replicatedDatasets;
   }
 
@@ -35,7 +37,10 @@ export class ApiHelper {
     return result;
   }
 
-  public async updateReplicatedDatasetFields(datasetId: string, repositoryFieldSet: Set<string>): Promise<ChangedAndMissingFields> {
+  public async updateReplicatedDatasetFields(
+    datasetId: string,
+    repositoryFieldSet: Set<string>
+  ): Promise<ChangedAndMissingFields> {
     const replicatedDatasetFieldsObject = await this.getReplicatedDatasetFields(datasetId);
     const changedFields = new Array<string>();
     const orgFieldSet = new Set<string>();
@@ -50,12 +55,12 @@ export class ApiHelper {
       await this.patchReplicatedDatasetFields(datasetId, replicatedDatasetFieldsObject);
     }
     const missingFields = new Array<string>();
-    for (const field of Array.from(repositoryFieldSet)){
-      if(!orgFieldSet.has(field)){
+    for (const field of Array.from(repositoryFieldSet)) {
+      if (!orgFieldSet.has(field)) {
         missingFields.push(field);
       }
     }
-    return {changedFields, missingFields};
+    return { changedFields, missingFields };
   }
 
   private async getReplicatedDatasetFields(datasetId: string): Promise<GetReplicatedDatasetFields> {
diff --git a/src/commands/analytics/connected-objects/upsert.ts b/src/commands/analytics/connected-objects/upsert.ts
@@ -1,12 +1,12 @@
 /* eslint-disable no-await-in-loop */
 import { SfCommand, Flags, Progress } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
-import { MetadataHelper } from '../../../metadataHelper';
-import { ApiHelper } from '../../../apiHelper';
-import { RecipeDefinition, LoadDefinitionNodeParam, ReplicatedDataset } from '../../../modules/upsert';
-import { PrinterHelper } from '../../../printerHelper';
+import { MetadataHelper } from '../../../metadataHelper.js';
+import { ApiHelper } from '../../../apiHelper.js';
+import { RecipeDefinition, LoadDefinitionNodeParam, ReplicatedDataset } from '../../../modules/upsert.js';
+import { PrinterHelper } from '../../../printerHelper.js';
 
-Messages.importMessagesDirectory(__dirname);
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('plugin-analytics-connected-objects', 'connected-objects.upsert');
 const common = Messages.loadMessages('plugin-analytics-connected-objects', 'common');
 
@@ -113,10 +113,14 @@ export default class ConnectedObjectsUpsert extends SfCommand<ConnectedObjectUps
           resultMap.set(objectName, { objectName, isNew: false, connectorName });
         }
         const fieldSet = objectFields.get(dataset.sourceObjectName) as Set<string>;
-        const {changedFields, missingFields} = await service.updateReplicatedDatasetFields(dataset.id, fieldSet);
-
-        if(missingFields.length > 0){
-          const message = messages.getMessage('fields.not.found', [objectName, connectorName, missingFields.join(', ')]); 
+        const { changedFields, missingFields } = await service.updateReplicatedDatasetFields(dataset.id, fieldSet);
+
+        if (missingFields.length > 0) {
+          const message = messages.getMessage('fields.not.found', [
+            objectName,
+            connectorName,
+            missingFields.join(', '),
+          ]);
           warnMessages.push(message);
         }
         if (changedFields.length > 0) {
@@ -130,11 +134,11 @@ export default class ConnectedObjectsUpsert extends SfCommand<ConnectedObjectUps
     }
     progressBar.stop();
 
-    if(warnMessages.length > 0){
-      if(!flags.json){
-        warnMessages[warnMessages.length -1] += '\n'; // Last warning line break 
+    if (warnMessages.length > 0) {
+      if (!flags.json) {
+        warnMessages[warnMessages.length - 1] += '\n'; // Last warning line break
       }
-      for(const warnMessage of warnMessages){
+      for (const warnMessage of warnMessages) {
         this.warn(warnMessage);
       }
     }
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1 @@
-export = {};
+export default {};
diff --git a/test/.eslintrc.cjs b/test/.eslintrc.cjs
@@ -1,13 +1,13 @@
 module.exports = {
-  extends: '../.eslintrc.js',
+  extends: '../.eslintrc.cjs',
   // Allow describe and it
   env: { mocha: true },
   rules: {
     // Allow assert style expressions. i.e. expect(true).to.be.true
     'no-unused-expressions': 'off',
 
     // It is common for tests to stub out method.
-
+    '@typescript-eslint/ban-ts-comment': 'off',
     // Return types are defined by the source code. Allows for quick overwrites.
     '@typescript-eslint/explicit-function-return-type': 'off',
     // Mocked out the methods that shouldn't do anything in the tests.
diff --git a/test/commands/analytics/connected-objects/mocks/apis.ts b/test/commands/analytics/connected-objects/mocks/apis.ts
@@ -1,6 +1,6 @@
-import { ApiHelper } from '../../../../../src/apiHelper';
-import { GetDataConnectors, GetReplicatedDatasets, ReplicatedDataset } from '../../../../../src/modules/upsert';
-import { GetReplicatedDatasetFields, ReplicatedDatasetField } from '../../../../../src/modules/upsert';
+import { ApiHelper } from '../../../../../src/apiHelper.js';
+import { GetDataConnectors, GetReplicatedDatasets, ReplicatedDataset } from '../../../../../src/modules/upsert.js';
+import { GetReplicatedDatasetFields, ReplicatedDatasetField } from '../../../../../src/modules/upsert.js';
 
 export function getReplicatedDatasets(sourceObjectNames: string[]): GetReplicatedDatasets {
   const replicatedDatasets: ReplicatedDataset[] = new Array<ReplicatedDataset>();
diff --git a/test/commands/analytics/connected-objects/mocks/recipes.ts b/test/commands/analytics/connected-objects/mocks/recipes.ts
@@ -1,4 +1,4 @@
-import { RecipeDefinition } from '../../../../../src/modules/upsert';
+import { RecipeDefinition } from '../../../../../src/modules/upsert.js';
 
 export const recipeFields: string[] = [
   'Id',
diff --git a/test/commands/analytics/connected-objects/upsert.nut.ts b/test/commands/analytics/connected-objects/upsert.nut.ts
@@ -1,10 +1,13 @@
 import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { expect } from 'chai';
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
 import { Messages } from '@salesforce/core';
-import ConnectedObjectUpsertResult from '../../../../src/commands/analytics/connected-objects/upsert';
+import ConnectedObjectUpsertResult from '../../../../src/commands/analytics/connected-objects/upsert.js';
 
-Messages.importMessagesDirectory(__dirname);
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+Messages.importMessagesDirectory(dirname);
 const messages = Messages.loadMessages('plugin-analytics-connected-objects', 'connected-objects.upsert');
 
 describe('analytics connected-objects upsert NUTs', () => {
diff --git a/test/commands/analytics/connected-objects/upsert.test.ts b/test/commands/analytics/connected-objects/upsert.test.ts
diff --git a/test/tsconfig.json b/test/tsconfig.json
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`{`
`2`		`- "require": "ts-node/register,source-map-support/register",`
	`2`	`+ "require": ["ts-node/register"],`
`3`	`3`	`"watch-extensions": "ts",`
`4`	`4`	`"recursive": true,`
`5`	`5`	`"reporter": "spec",`
`6`		`- "timeout": 600000`
	`6`	`+ "timeout": 5000,`
	`7`	`+ "node-option": ["loader=ts-node/esm"]`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,5 @@`
`1`	`1`	`{`
`2`		`- "check-coverage": true,`
`3`		`- "lines": 75,`
`4`		`- "statements": 75,`
`5`		`- "functions": 75,`
`6`		`- "branches": 50`
	`2`	`+ "nyc": {`
	`3`	`+ "extends": "@salesforce/dev-config/nyc"`
	`4`	`+ }`
`7`	`5`	`}`