fix(cli): Deprecate doctor and lab commands (#4945)

ionic-team · Jan 10, 2023 · 6fcf882 · 6fcf882
1 parent f586a18
commit 6fcf882
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/packages/@ionic/cli/src/commands/capacitor/build.ts b/packages/@ionic/cli/src/commands/capacitor/build.ts
@@ -36,17 +36,17 @@ export class BuildCommand extends CapacitorCommand implements CommandPreRun {
     const footnotes: Footnote[] = [
       {
         id: 'capacitor-native-config-docs',
-        url: 'https://capacitor.ionicframework.com/docs/basics/configuring-your-app',
+        url: 'https://capacitorjs.com/docs/basics/configuring-your-app',
         shortUrl: 'https://ion.link/capacitor-native-config-docs',
       },
       {
         id: 'capacitor-ios-config-docs',
-        url: 'https://capacitor.ionicframework.com/docs/ios/configuration',
+        url: 'https://capacitorjs.com/docs/ios/configuration',
         shortUrl: 'https://ion.link/capacitor-ios-config-docs',
       },
       {
         id: 'capacitor-android-config-docs',
-        url: 'https://capacitor.ionicframework.com/docs/android/configuration',
+        url: 'https://capacitorjs.com/docs/android/configuration',
         shortUrl: 'https://ion.link/capacitor-android-config-docs',
       },
     ];

diff --git a/packages/@ionic/cli/src/commands/doctor/check.ts b/packages/@ionic/cli/src/commands/doctor/check.ts
@@ -1,4 +1,4 @@
-import { contains, validate } from '@ionic/cli-framework';
+import { contains, MetadataGroup, validate } from '@ionic/cli-framework';
 
 import { CommandLineInputs, CommandLineOptions, CommandMetadata, IAilment } from '../../definitions';
 import { isTreatableAilment } from '../../guards';
@@ -13,6 +13,7 @@ export class DoctorCheckCommand extends DoctorCommand {
       name: 'check',
       type: 'project',
       summary: 'Check the health of your Ionic project',
+      groups: [MetadataGroup.DEPRECATED],
       description: `
 This command detects and prints common issues and suggested steps to fix them.
 

diff --git a/packages/@ionic/cli/src/commands/doctor/list.ts b/packages/@ionic/cli/src/commands/doctor/list.ts
@@ -1,3 +1,4 @@
+import { MetadataGroup } from '@ionic/cli-framework';
 import { strcmp } from '@ionic/cli-framework/utils/string';
 import { columnar } from '@ionic/utils-terminal';
 
@@ -14,6 +15,7 @@ export class DoctorListCommand extends DoctorCommand {
       name: 'list',
       type: 'project',
       summary: 'List all issues and their identifiers',
+      groups: [MetadataGroup.DEPRECATED],
       description: `
 Issues can have various tags:
 - ${strong('treatable')}: ${input('ionic doctor treat')} can attempt to fix the issue

diff --git a/packages/@ionic/cli/src/commands/doctor/treat.ts b/packages/@ionic/cli/src/commands/doctor/treat.ts
@@ -1,4 +1,4 @@
-import { contains, validate } from '@ionic/cli-framework';
+import { contains, MetadataGroup, validate } from '@ionic/cli-framework';
 
 import { CommandLineInputs, CommandLineOptions, CommandMetadata, TreatableAilment } from '../../definitions';
 import { isExitCodeException, isTreatableAilment } from '../../guards';
@@ -16,6 +16,7 @@ export class DoctorTreatCommand extends DoctorCommand {
       name: 'treat',
       type: 'project',
       summary: 'Attempt to fix issues in your Ionic project',
+      groups: [MetadataGroup.DEPRECATED],
       description: `
 This command detects and attempts to fix common issues. Before a fix is attempted, the steps are printed and a confirmation prompt is displayed.
 

diff --git a/packages/@ionic/cli/src/commands/serve.ts b/packages/@ionic/cli/src/commands/serve.ts
@@ -19,15 +19,15 @@ export class ServeCommand extends Command implements CommandPreRun {
         name: 'lab-host',
         summary: 'Use specific host for Ionic Lab server',
         default: 'localhost',
-        groups: [MetadataGroup.ADVANCED],
+        groups: [MetadataGroup.HIDDEN, MetadataGroup.ADVANCED],
         spec: { value: 'host' },
         hint: weak('(--lab)'),
       },
       {
         name: 'lab-port',
         summary: 'Use specific port for Ionic Lab server',
         default: DEFAULT_LAB_PORT.toString(),
-        groups: [MetadataGroup.ADVANCED],
+        groups: [MetadataGroup.HIDDEN, MetadataGroup.ADVANCED],
         spec: { value: 'port' },
         hint: weak('(--lab)'),
       },
@@ -56,10 +56,11 @@ export class ServeCommand extends Command implements CommandPreRun {
         summary: 'Test your apps on multiple platform types in the browser',
         type: Boolean,
         aliases: ['l'],
+        groups: [MetadataGroup.HIDDEN],
       },
     ];
 
-    const exampleCommands = ['', '--external', '--lab'];
+    const exampleCommands = ['', '--external'];
     const footnotes: Footnote[] = [];
 
     let description = `