chore: rename command

command-snapshot.json

@@ -1,6 +1,6 @@
 [
   {
-    "command": "env:api",
+    "command": "org:api",
     "plugin": "@cristiand391/sf-plugin-api",
     "flags": ["body", "header", "include", "method", "target-org"],
     "alias": [],

src/commands/env/api.ts → src/commands/org/api.ts

@@ -1,10 +1,3 @@
-/*
- * Copyright (c) 2022, salesforce.com, inc.
- * All rights reserved.
- * 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 { readFile } from 'node:fs/promises';
 import { EOL } from 'node:os';
 import got, { Headers, Method } from 'got';
@@ -17,10 +10,10 @@ import { Args, ux } from '@oclif/core';
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages(
   '@cristiand391/sf-plugin-api',
-  'env.api',
+  'org.api',
 );
 
-export default class EnvApi extends SfCommand<void> {
+export class OrgApi extends SfCommand<void> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
@@ -33,6 +26,7 @@ export default class EnvApi extends SfCommand<void> {
       // TODO: this is already set in the org flag but getting a wrong type if not set here.
       // Fix flag types in oclif.
       required: true,
+      helpValue: 'username'
     }),
     include: Flags.boolean({
       char: 'i',
@@ -56,11 +50,13 @@ export default class EnvApi extends SfCommand<void> {
     })(),
     header: Flags.string({
       summary: messages.getMessage('flags.header.summary'),
+      helpValue: 'key:value',
       char: 'H',
       multiple: true,
     }),
     body: Flags.file({
       summary: messages.getMessage('flags.body.summary'),
+      helpValue: 'file',
     }),
   };
 
@@ -92,7 +88,7 @@ export default class EnvApi extends SfCommand<void> {
   }
 
   public async run(): Promise<void> {
-    const { flags, args } = await this.parse(EnvApi);
+    const { flags, args } = await this.parse(OrgApi);
 
     const org = flags['target-org'];
 
@@ -111,7 +107,7 @@ export default class EnvApi extends SfCommand<void> {
           // eslint-disable-next-line sf-plugin/get-connection-with-version
           org.getConnection().getConnectionOptions().accessToken
         }`,
-        ...(flags.header ? EnvApi.getHeaders(flags.header) : {}),
+        ...(flags.header ? OrgApi.getHeaders(flags.header) : {}),
       },
       body:
         flags.method === 'GET'

src/index.ts

@@ -1,8 +1 @@
-/*
- * Copyright (c) 2021, salesforce.com, inc.
- * All rights reserved.
- * 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
- */
-
 export = {};

test/commands/env/api.test.ts → test/commands/org/api.test.ts

@@ -4,9 +4,9 @@ import { SfError } from '@salesforce/core';
 import { expect } from 'chai';
 import stripAnsi = require('strip-ansi');
 import { stdout } from '@oclif/core';
-import EnvApi from '../../../src/commands/env/api';
+import { OrgApi }from '../../../src/commands/org/api';
 
-describe('env api', () => {
+describe('org api', () => {
   const $$ = new TestContext();
   const testOrg = new MockTestOrgData('1234', {
     username: '[email protected]',
@@ -35,7 +35,7 @@ describe('env api', () => {
       .get('/services/data/v56.0/limits')
       .reply(200, orgLimitsResponse);
 
-    await EnvApi.run([
+    await OrgApi.run([
       'services/data/v56.0/limits',
       '--target-org',
       '[email protected]',
@@ -63,7 +63,7 @@ describe('env api', () => {
       .get('/services/data')
       .reply(200, xmlRes);
 
-    await EnvApi.run([
+    await OrgApi.run([
       'services/data',
       '--header',
       'Accept: application/xml',
@@ -79,7 +79,7 @@ describe('env api', () => {
 
   it('should validate HTTP headers are in a "key:value" format', async () => {
     try {
-      await EnvApi.run([
+      await OrgApi.run([
         'services/data',
         '--header',
         'Accept application/xml',

tsconfig.json

@@ -2,10 +2,8 @@
   "compilerOptions": {
     "strict": true,
     "module": "commonjs",
-    "target": "es2020",
-    "lib": ["es2020"],
-    "sourceMap": true,
-    "declaration": true,
+    "target": "ES2021",
+    "lib": ["ES2021"],
     "moduleResolution": "node",
     "alwaysStrict": true,
     "noUnusedLocals": true,