fix: jsdoc errors due to unrecognized format (#557)

Signed-off-by: Jeffrey Tang <[email protected]>

package.json

@@ -27,7 +27,7 @@
  "merge-unit": "nyc merge ./coverage/unit/ .nyc_output/coverage.json",
  "report-coverage": "npm run merge-clean && npm run merge-unit && npm run merge-e2e && nyc report --reporter=json --reporter=html --reporter=lcov",
  "solo": "NODE_OPTIONS=--experimental-vm-modules node --no-deprecation solo.mjs",
- "check": "remark . --quiet --frail && eslint .",
+ "check": "remark . --quiet --frail && eslint .; cd docs; jsdoc -c jsdoc.conf.json; cd ..",
  "format": "remark . --quiet --frail --output && eslint --fix .",
  "test-setup": "./test/e2e/setup-e2e.sh",
  "test-coverage": "npm run test && npm run test-setup && npm run test-e2e-all && npm run report-coverage"
@@ -54,6 +54,7 @@
  "got": "^14.4.2",
  "inquirer": "^10.2.2",
  "ip": "^2.0.1",
+ "jsdoc": "^4.0.3",
  "js-base64": "^3.7.7",
  "js-yaml": "^4.1.0",
  "listr2": "^8.2.4",

src/commands/index.mjs

@@ -27,7 +27,7 @@ import * as flags from './flags.mjs'
 /**
  * Return a list of Yargs command builder to be exposed through CLI
  * @param {Object} opts it is an Options object containing logger
- * @returns {Array<{command: string, desc: string, builder: Function, handler?: Function}[]>}
+ * @returns {Array} an array of Yargs command builder
  */
 function Initialize (opts) {
  const initCmd = new InitCommand(opts)

src/commands/init.mjs

@@ -145,7 +145,7 @@ export class InitCommand extends BaseCommand {
  /**
  * Return Yargs command definition for 'init' command
  * @param {InitCommand} initCmd - an instance of InitCommand
- * @returns {{command: string, desc: string, builder: Function, handler: (argv: Object) => void}}
+ * @returns A object representing the Yargs command definition
  */
  static getCommandDefinition (initCmd) {
  if (!initCmd || !(initCmd instanceof InitCommand)) {