Revert "fix: description no longer required for sf"

This reverts commit 1a4774c.

Author: peternhale

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2023, Salesforce.com, Inc.
+Copyright (c) 2022, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package.json

@@ -1,15 +1,15 @@
 {
   "name": "@salesforce/plugin-command-reference",
   "description": "Generate the Salesforce CLI command reference guide",
-  "version": "2.2.9-t.0",
+  "version": "2.2.8",
   "author": "Salesforce",
   "bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
   "dependencies": {
-    "@oclif/core": "^1.23.1",
-    "@salesforce/core": "^3.32.12",
-    "@salesforce/kit": "^1.8.2",
-    "@salesforce/sf-plugins-core": "^1.21.5",
-    "@salesforce/ts-types": "^1.7.1",
+    "@oclif/core": "^1.6.3",
+    "@salesforce/core": "^3.8.0",
+    "@salesforce/kit": "^1.5.17",
+    "@salesforce/sf-plugins-core": "^1.9.0",
+    "@salesforce/ts-types": "^1.5.20",
     "chalk": "^3.0.0",
     "fs-extra": "^10.0.1",
     "handlebars": "^4.7.7",
@@ -19,9 +19,9 @@
   },
   "devDependencies": {
     "@oclif/plugin-help": "^5.1.1",
-    "@salesforce/dev-config": "^3.1.0",
-    "@salesforce/dev-scripts": "^2.0.4",
-    "@salesforce/plugin-login": "^1.1.15",
+    "@salesforce/dev-config": "^3.0.1",
+    "@salesforce/dev-scripts": "^2.0.1",
+    "@salesforce/plugin-login": "^1.0.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/lodash.uniqby": "^4.7.6",
@@ -32,7 +32,7 @@
     "eslint-config-prettier": "^6.11.0",
     "eslint-config-salesforce": "^0.1.6",
     "eslint-config-salesforce-license": "^0.1.6",
-    "eslint-config-salesforce-typescript": "^0.2.8",
+    "eslint-config-salesforce-typescript": "^0.2.7",
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "2.24.2",
     "eslint-plugin-jsdoc": "^35.1.2",

src/ditamap/command.ts

@@ -15,7 +15,7 @@ import {
   ensureString,
   JsonMap,
 } from '@salesforce/ts-types';
-import { CommandClass, punctuate } from '../utils';
+import { CommandClass, events, punctuate } from '../utils';
 import { Ditamap } from './ditamap';
 
 export type CommandHelpInfo = {
@@ -62,6 +62,10 @@ export class Command extends Ditamap {
     // Help are all the lines after the first line in the description. Before oclif, there was a 'help' property so continue to
     // support that.
 
+    if (!description) {
+      events.emit('warning', `Missing description for ${command.id}\n`);
+    }
+
     const help = this.formatParagraphs(description);
 
     let trailblazerCommunityUrl: AnyJson;