From e0545a5fcbe068aecf2ced0242dca5522301f2df Mon Sep 17 00:00:00 2001 From: mshanemc Date: Fri, 27 Oct 2023 09:32:25 -0500 Subject: [PATCH 1/2] feat: finish sf-ification --- command-snapshot.json | 20 +++++++++---------- messages/display.md | 4 ---- messages/recordcounts.md | 6 +----- package.json | 16 ++++++++------- ...-api-display.json => org-list-limits.json} | 0 ...n => org-list-sobject-record__counts.json} | 0 .../api/display.ts => org/list/limits.ts} | 2 +- .../list/sobject/record-counts.ts} | 4 ++-- test/commands/display.test.ts | 2 +- test/commands/recordcounts.nut.ts | 2 +- yarn.lock | 10 +++++----- 11 files changed, 30 insertions(+), 36 deletions(-) rename schemas/{limits-api-display.json => org-list-limits.json} (100%) rename schemas/{limits-recordcounts-display.json => org-list-sobject-record__counts.json} (100%) rename src/commands/{limits/api/display.ts => org/list/limits.ts} (98%) rename src/commands/{limits/recordcounts/display.ts => org/list/sobject/record-counts.ts} (95%) diff --git a/command-snapshot.json b/command-snapshot.json index b6f9b344..09008168 100644 --- a/command-snapshot.json +++ b/command-snapshot.json @@ -1,18 +1,18 @@ [ { - "command": "limits:api:display", - "plugin": "@salesforce/plugin-limits", - "flags": ["api-version", "json", "loglevel", "target-org"], - "alias": ["force:limits:api:display", "org:list:limits"], + "alias": ["force:limits:api:display", "limits:api:display"], + "command": "org:list:limits", + "flagAliases": ["apiversion", "targetusername", "u"], "flagChars": ["o"], - "flagAliases": ["apiversion", "targetusername", "u"] + "flags": ["api-version", "json", "loglevel", "target-org"], + "plugin": "@salesforce/plugin-limits" }, { - "command": "limits:recordcounts:display", - "plugin": "@salesforce/plugin-limits", - "flags": ["api-version", "json", "loglevel", "sobject", "target-org"], - "alias": ["force:limits:recordcounts:display", "org:list:sobject:record-counts"], + "alias": ["force:limits:recordcounts:display", "limits:recordcounts:display"], + "command": "org:list:sobject:record-counts", + "flagAliases": ["apiversion", "sobjecttype", "targetusername", "u"], "flagChars": ["o", "s"], - "flagAliases": ["apiversion", "sobjecttype", "targetusername", "u"] + "flags": ["api-version", "json", "loglevel", "sobject", "target-org"], + "plugin": "@salesforce/plugin-limits" } ] diff --git a/messages/display.md b/messages/display.md index 7daf2aa2..a7daf0eb 100644 --- a/messages/display.md +++ b/messages/display.md @@ -15,7 +15,3 @@ For each limit, this command returns the maximum allocation and the remaining al - Display limits in the org with alias "my-scratch-org": <%= config.bin %> <%= command.id %> --target-org my-scratch-org - -# targetOrg - -Login username or alias for the target org. diff --git a/messages/recordcounts.md b/messages/recordcounts.md index 33beb41c..07d240d1 100644 --- a/messages/recordcounts.md +++ b/messages/recordcounts.md @@ -20,10 +20,6 @@ Use this command to get an approximate count of the records in standard or custo <%= config.bin %> <%= command.id %> --sobject Account --sobject Lead --target-org my-scratch-org -# sobjectFlagDescription +# flags.sobject.summary API name of the standard or custom object for which to display record counts. - -# targetOrg - -Login username or alias for the target org. diff --git a/package.json b/package.json index 82f23a4d..243890ea 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "eslint-plugin-header": "^3.1.1", "eslint-plugin-import": "2.28.1", "eslint-plugin-jsdoc": "^46.8.2", - "eslint-plugin-sf-plugin": "^1.16.9", + "eslint-plugin-sf-plugin": "^1.16.12", "husky": "^7.0.4", "mocha": "^9.1.3", "nyc": "^15.1.0", @@ -78,14 +78,16 @@ "@salesforce/plugin-command-reference" ], "topics": { - "limits": { - "description": "Display an org’s limits.", + "org": { + "external": true, "subtopics": { - "api": { - "description": "Display an org’s API limits." + "list": { + "external": true }, - "recordcounts": { - "description": "Display record counts for an org." + "subtopics": { + "sobject": { + "external": true + } } } } diff --git a/schemas/limits-api-display.json b/schemas/org-list-limits.json similarity index 100% rename from schemas/limits-api-display.json rename to schemas/org-list-limits.json diff --git a/schemas/limits-recordcounts-display.json b/schemas/org-list-sobject-record__counts.json similarity index 100% rename from schemas/limits-recordcounts-display.json rename to schemas/org-list-sobject-record__counts.json diff --git a/src/commands/limits/api/display.ts b/src/commands/org/list/limits.ts similarity index 98% rename from src/commands/limits/api/display.ts rename to src/commands/org/list/limits.ts index 973b1070..7b2d1671 100644 --- a/src/commands/limits/api/display.ts +++ b/src/commands/org/list/limits.ts @@ -33,7 +33,7 @@ interface Result { export type ApiLimits = ApiLimit[]; export class LimitsApiDisplayCommand extends SfCommand { - public static readonly aliases = ['force:limits:api:display', 'org:list:limits']; + public static readonly aliases = ['force:limits:api:display', 'limits:api:display']; public static readonly summary = messages.getMessage('summary'); public static readonly description = messages.getMessage('description'); public static readonly examples = messages.getMessages('examples'); diff --git a/src/commands/limits/recordcounts/display.ts b/src/commands/org/list/sobject/record-counts.ts similarity index 95% rename from src/commands/limits/recordcounts/display.ts rename to src/commands/org/list/sobject/record-counts.ts index 15d419ce..f2d171fe 100644 --- a/src/commands/limits/recordcounts/display.ts +++ b/src/commands/org/list/sobject/record-counts.ts @@ -30,7 +30,7 @@ interface Result { } export class LimitsRecordCountsDisplayCommand extends SfCommand { - public static readonly aliases = ['force:limits:recordcounts:display', 'org:list:sobject:record-counts']; + public static readonly aliases = ['force:limits:recordcounts:display', 'limits:recordcounts:display']; public static readonly summary = messages.getMessage('summary'); public static readonly description = messages.getMessage('description'); public static readonly examples = messages.getMessages('examples'); @@ -38,7 +38,7 @@ export class LimitsRecordCountsDisplayCommand extends SfCommand { public static readonly flags = { sobject: arrayWithDeprecation({ char: 's', - summary: messages.getMessage('sobjectFlagDescription'), + summary: messages.getMessage('flags.sobject.summary'), aliases: ['sobjecttype'], default: [], }), diff --git a/test/commands/display.test.ts b/test/commands/display.test.ts index 4db36f7f..8c66d3f2 100644 --- a/test/commands/display.test.ts +++ b/test/commands/display.test.ts @@ -10,7 +10,7 @@ import { test } from '@oclif/test'; import { expect } from 'chai'; import { parseJson } from '@salesforce/kit'; -import { ApiLimits } from '../../src/commands/limits/api/display.js'; +import { ApiLimits } from '../../src/commands/org/list/limits.js'; describe('force:limits:api:display', () => { const $$ = new TestContext(); diff --git a/test/commands/recordcounts.nut.ts b/test/commands/recordcounts.nut.ts index a299dac8..a734ba81 100644 --- a/test/commands/recordcounts.nut.ts +++ b/test/commands/recordcounts.nut.ts @@ -8,7 +8,7 @@ import { expect } from 'chai'; import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit'; import { Env } from '@salesforce/kit'; import { ensureString, getString } from '@salesforce/ts-types'; -import { RecordCount } from '../../src/commands/limits/recordcounts/display.js'; +import { RecordCount } from '../../src/commands/org/list/sobject/record-counts.js'; describe('recordcounts:display', () => { const env = new Env(); diff --git a/yarn.lock b/yarn.lock index c9af34f9..675501b9 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3120,12 +3120,12 @@ eslint-plugin-prefer-arrow@^1.2.1: resolved "https://registry.yarnpkg.com/eslint-plugin-prefer-arrow/-/eslint-plugin-prefer-arrow-1.2.3.tgz#e7fbb3fa4cd84ff1015b9c51ad86550e55041041" integrity sha512-J9I5PKCOJretVuiZRGvPQxCbllxGAV/viI20JO3LYblAodofBxyMnZAJ+WGeClHgANnSJberTNoFWWjrWKBuXQ== -eslint-plugin-sf-plugin@^1.16.9: - version "1.16.9" - resolved "https://registry.yarnpkg.com/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.16.9.tgz#0c8bfa7b51b52c716bf8cecbb271237931bffa3b" - integrity sha512-VOAA1OEieGCzimavNvI1OP2AnlR5SZfxi4Q+WDahxJcedh5/SP0DEynW8ww+begy4Nt0APdLzwXN1JJTZQCemA== +eslint-plugin-sf-plugin@^1.16.12: + version "1.16.12" + resolved "https://registry.yarnpkg.com/eslint-plugin-sf-plugin/-/eslint-plugin-sf-plugin-1.16.12.tgz#053e27f75df4e5b2d350c43aca2ddcfee4239109" + integrity sha512-iW7kFN7qEx9iqhRUcWNUqO2jkdRDX8m/wOfLXFkoq9b+6QuOnhmV4sD5G6GUvPrKP9Sv7A/Ke2hQdXT8wxfm8Q== dependencies: - "@salesforce/core" "^5.3.5" + "@salesforce/core" "^5.3.10" "@typescript-eslint/utils" "^5.59.11" eslint-plugin-unicorn@^48.0.1: From 19718834204152cf3d8a5a40812575984ff70367 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Fri, 27 Oct 2023 09:32:47 -0500 Subject: [PATCH 2/2] chore: github cleanup --- .git2gus/config.json | 2 +- .github/ISSUE_TEMPLATE/Bug_report.md | 39 ----------------------- .github/ISSUE_TEMPLATE/Feature_request.md | 16 ---------- .github/no-response.yml | 9 ------ 4 files changed, 1 insertion(+), 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md delete mode 100644 .github/no-response.yml diff --git a/.git2gus/config.json b/.git2gus/config.json index 4a52dbbe..4615757f 100644 --- a/.git2gus/config.json +++ b/.git2gus/config.json @@ -1,6 +1,6 @@ { "productTag": "a1aB00000004Bx8IAE", - "defaultBuild": "offcore.tooling.56", + "defaultBuild": "offcore.tooling.59", "issueTypeLabels": { "feature": "USER STORY", "regression": "BUG P1", diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index a02e0549..00000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - - - - - -### Summary - -_Short summary of what is going on or to provide context_. - -### Steps To Reproduce: - -1. This is step 1. -1. This is step 2. All steps should start with '1.' - -### Expected result - -_Describe what should have happened_. - -### Actual result - -_Describe what actually happened instead_. - -### Additional information - -_Feel free to attach a screenshot_. - -**VS Code Version**: - -**SFDX CLI Version**: - -**OS and version**: diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index a09db44f..00000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/no-response.yml b/.github/no-response.yml deleted file mode 100644 index 86780587..00000000 --- a/.github/no-response.yml +++ /dev/null @@ -1,9 +0,0 @@ -# Configuration for probot-no-response - https://github.com/probot/no-response - -daysUntilClose: 7 -responseRequiredLabel: 'more information required' -closeComment: > - This issue has been automatically closed because there has been no response - to our request for more information from the original author. Currently, there - is not enough information provided for us to take action. Please reply and - reopen this issue if you need additional assistance.