chore: switch to node:fs

salesforcecli · Oct 26, 2023 · 3b84c22 · 3b84c22
1 parent 4b27582
commit 3b84c22
Show file tree

Hide file tree

Showing 15 changed files with 161 additions and 87 deletions.
diff --git a/package.json b/package.json
@@ -29,14 +29,14 @@
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "chai": "^4.3.10",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.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-config-salesforce-typescript": "^2.0.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jsdoc": "^43.0.5",
+    "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-sf-plugin": "^1.16.9",
     "fs-extra": "^10.1.0",
     "husky": "^7.0.4",
@@ -50,7 +50,7 @@
     "sinon": "10.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2",
-    "wireit": "^0.14.0"
+    "wireit": "^0.14.1"
   },
   "config": {},
   "engines": {

diff --git a/src/commands/alias/list.ts b/src/commands/alias/list.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { StateAggregator, Messages } from '@salesforce/core';
 import { loglevel } from '@salesforce/sf-plugins-core';
 import { AliasCommand, AliasResults } from '../../alias.js';

diff --git a/src/commands/alias/set.ts b/src/commands/alias/set.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { loglevel, parseVarArgs } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
 import { AliasCommand, AliasResults } from '../../alias.js';

diff --git a/src/commands/alias/unset.ts b/src/commands/alias/unset.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { Flags, loglevel } from '@salesforce/sf-plugins-core';
 import { StateAggregator, Messages } from '@salesforce/core';
 import { AliasCommand, AliasResults } from '../../alias.js';

diff --git a/src/commands/config/get.ts b/src/commands/config/get.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 { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { Flags, loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { ConfigAggregator, Messages } from '@salesforce/core';
 import {

diff --git a/src/commands/config/list.ts b/src/commands/config/list.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 { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { ConfigAggregator, Messages } from '@salesforce/core';
 import { loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { ConfigResponses, buildSuccessMsg, output } from '../../config.js';

diff --git a/src/commands/config/set.ts b/src/commands/config/set.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { parseVarArgs, Flags, loglevel, Ux, SfCommand } from '@salesforce/sf-plugins-core';
 import { Config, Messages, Org, SfError, OrgConfigProperties } from '@salesforce/core';
 import { HelpSection } from '@oclif/core';

diff --git a/src/commands/config/unset.ts b/src/commands/config/unset.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { Flags, loglevel, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { Config, Messages } from '@salesforce/core';
 import { CONFIG_HELP_SECTION, buildFailureMsg, calculateSuggestion, output } from '../../config.js';

diff --git a/src/hooks/init/load_config_meta.ts b/src/hooks/init/load_config_meta.ts
@@ -25,26 +25,28 @@ async function loadConfigMeta(plugin: Interfaces.Plugin): Promise<ConfigProperty
 
     log.info(x);
 
-    return x.default;
+    return x.default ?? x;
   } catch {
     return;
   }
 }
 
 const hook: Hook<'init'> = async ({ config }): Promise<void> => {
-  const flattenedConfigMetas = (config.getPluginsList() || [])
-    .flatMap(async (plugin) => {
-      const configMeta = await loadConfigMeta(plugin);
-      if (!configMeta) {
-        log.info(`No config meta found for ${plugin.name}`);
-      }
-
-      return configMeta;
-    })
-    .filter<Promise<ConfigPropertyMeta>>(isObject);
+  const flattenedConfigMetas = (
+    await Promise.all(
+      (config.getPluginsList() || []).flatMap(async (plugin) => {
+        const configMeta = await loadConfigMeta(plugin);
+        if (!configMeta) {
+          log.info(`No config meta found for ${plugin.name}`);
+        }
+
+        return configMeta;
+      })
+    )
+  ).filter<ConfigPropertyMeta>(isObject);
 
   if (flattenedConfigMetas.length) {
-    Config.addAllowedProperties(await Promise.all(flattenedConfigMetas));
+    Config.addAllowedProperties(flattenedConfigMetas);
   }
   return Promise.resolve();
 };

diff --git a/test/commands/alias/set.nut.ts b/test/commands/alias/set.nut.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { getNumber, getString } from '@salesforce/ts-types';
 import { expect } from 'chai';

diff --git a/test/commands/alias/unset.nut.ts b/test/commands/alias/unset.nut.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';
 import { Messages } from '@salesforce/core';

diff --git a/test/commands/config/get.test.ts b/test/commands/config/get.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 path from 'path';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { test, expect } from '@oclif/test';
 import { ConfigAggregator, OrgConfigProperties } from '@salesforce/core';

diff --git a/test/commands/config/set.nut.ts b/test/commands/config/set.nut.ts
@@ -6,7 +6,7 @@
  */
 
 import { fileURLToPath } from 'node:url';
-import { dirname } from 'path';
+import { dirname } from 'node:path';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { assert, expect } from 'chai';
 import { Messages } from '@salesforce/core';

diff --git a/test/hooks/load_config_meta.test.ts b/test/hooks/load_config_meta.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 path from 'path';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { readFileSync } from 'node:fs';
 import { test, expect } from '@oclif/test';
@@ -15,8 +15,6 @@ import { stubMethod } from '@salesforce/ts-sinon';
 import sinon from 'sinon';
 import { SinonSandbox, SinonStub } from 'sinon';
 import tsSrcConfigMetaMock from '../config-meta-mocks/typescript-src/src/config-meta.js';
-// @ts-expect-error because it's js
-import jsLibConfigMetaMock from '../config-meta-mocks/javascript-lib/lib/config-meta.js';
 
 process.env.NODE_ENV = 'development';
 
@@ -46,39 +44,14 @@ describe('hooks', () => {
     })
     .hook('init')
     .do(() => {
-      expect(tsSrcConfigMetaMock).to.deep.equal([
+      expect(tsSrcConfigMetaMock.default).to.deep.equal([
         {
           key: 'customKey',
         },
       ]);
       // modified since devPlugins now includes plugin-deploy-retrieve to exercise a config-meta that it includes.
       // see https://github.com/salesforcecli/plugin-deploy-retrieve/blob/main/src/configMeta.ts
-      expect((Config.addAllowedProperties as SinonStub).firstCall.args[0][1]).to.equal(tsSrcConfigMetaMock);
+      expect((Config.addAllowedProperties as SinonStub).firstCall.args[0][1]).to.equal(tsSrcConfigMetaMock.default);
     })
     .it('loads config metas from a ts src directory');
-
-  // test
-  //   .stdout()
-  //   .loadConfig()
-  //   .do(async (ctx) => {
-  //     const mockPluginRoot = path.resolve(
-  //       path.dirname(fileURLToPath(import.meta.url)),
-  //       '../config-meta-mocks/javascript-lib'
-  //     );
-  //     ctx.config.plugins.set('sfdx-cli-ts-plugin', {
-  //       root: mockPluginRoot,
-  //       hooks: {},
-  //       pjson: JSON.parse(readFileSync(path.resolve(mockPluginRoot, 'package.json'), 'utf-8')),
-  //     } as unknown as Plugin);
-  //   })
-  //   .hook('init')
-  //   .do(() => {
-  //     expect(jsLibConfigMetaMock).to.deep.equal([
-  //       {
-  //         key: 'customKey',
-  //       },
-  //     ]);
-  //     expect((Config.addAllowedProperties as SinonStub).firstCall.args[0][1]).to.equal(jsLibConfigMetaMock[0]);
-  //   })
-  //   .it('loads config metas from a js lib directory');
 });