feat!: deprecation notices for non-readme-refactored commands (#1099)

kanadgupta · web-flow · commit 732e32bbccd1 · 2024-12-05T12:48:36.000-06:00
## 🧰 Changes BREAKING CHANGE: deprecates commands that are not supported in ReadMe Refactored. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md ## 🧬 QA & Testing Does the copy in these deprecation warnings make sense to you? Note that the links will be broken for now since we haven't tagged a proper v9 release yet, but that will be fixed once this release is out!
diff --git a/src/commands/categories/create.ts b/src/commands/categories/create.ts
@@ -13,6 +13,15 @@ interface Category {
 }
 
 export default class CategoriesCreateCommand extends BaseCommand<typeof CategoriesCreateCommand> {
+  // needed for deprecation message
+  static id = 'categories create' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static description = 'Create a category with the specified title and guide in your ReadMe project.';
 
   static args = {
diff --git a/src/commands/categories/index.ts b/src/commands/categories/index.ts
@@ -4,6 +4,15 @@ import getCategories from '../../lib/getCategories.js';
 import { getProjectVersion } from '../../lib/versionSelect.js';
 
 export default class CategoriesCommand extends BaseCommand<typeof CategoriesCommand> {
+  // needed for deprecation message
+  static id = 'categories' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static description = 'Get all categories in your ReadMe project.';
 
   static flags = {
diff --git a/src/commands/custompages.ts b/src/commands/custompages.ts
@@ -13,6 +13,12 @@ export default class CustomPagesCommand extends BaseCommand<typeof CustomPagesCo
   // needed for unit tests, even though we also specify this in src/index.ts
   static id = 'custompages' as const;
 
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static summary = 'Sync Markdown/HTML files to your ReadMe project as Custom Pages.';
 
   static description =
diff --git a/src/commands/docs/index.ts b/src/commands/docs/index.ts
@@ -12,6 +12,12 @@ export default class DocsCommand extends BaseCommand<typeof DocsCommand> {
   // needed for unit tests, even though we also specify this in src/index.ts
   static id = 'docs' as const;
 
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static aliases = ['guides'];
 
   static summary = 'Sync Markdown files to your ReadMe project as Guides.';
diff --git a/src/commands/docs/prune.ts b/src/commands/docs/prune.ts
@@ -17,6 +17,15 @@ function getSlug(filename: string): string {
 }
 
 export default class DocsPruneCommand extends BaseCommand<typeof DocsPruneCommand> {
+  // needed for deprecation message
+  static id = 'docs prune' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static aliases = ['guides prune'];
 
   static description = 'Delete any docs from ReadMe if their slugs are not found in the target folder.';
diff --git a/src/commands/open.ts b/src/commands/open.ts
@@ -17,10 +17,13 @@ export default class OpenCommand extends BaseCommand<typeof OpenCommand> {
 
   static hidden = true;
 
+  // needed for deprecation message
+  static id = 'open' as const;
+
   static state = 'deprecated';
 
   static deprecationOptions = {
-    message: '`rdme open` is deprecated and will be removed in a future release.',
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
   };
 
   async run() {
diff --git a/src/commands/versions/create.ts b/src/commands/versions/create.ts
@@ -17,6 +17,12 @@ export default class CreateVersionCommand extends BaseCommand<typeof CreateVersi
   // needed for unit tests, even though we also specify this in src/index.ts
   static id = 'versions create';
 
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static args = {
     version: Args.string({
       description: "The version you'd like to create. Must be valid SemVer (https://semver.org/)",
diff --git a/src/commands/versions/delete.ts b/src/commands/versions/delete.ts
@@ -6,6 +6,15 @@ import { cleanAPIv1Headers, handleAPIv1Res, readmeAPIv1Fetch } from '../../lib/r
 import { getProjectVersion } from '../../lib/versionSelect.js';
 
 export default class DeleteVersionCommand extends BaseCommand<typeof DeleteVersionCommand> {
+  // needed for deprecation message
+  static id = 'versions delete' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static description = 'Delete a version associated with your ReadMe project.';
 
   static args = {
diff --git a/src/commands/versions/index.ts b/src/commands/versions/index.ts
@@ -16,6 +16,15 @@ export interface Version {
 }
 
 export default class VersionsCommand extends BaseCommand<typeof VersionsCommand> {
+  // needed for deprecation message
+  static id = 'versions' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static description = 'List versions available in your project or get a version by SemVer (https://semver.org/).';
 
   static flags = {
diff --git a/src/commands/versions/update.ts b/src/commands/versions/update.ts
@@ -12,6 +12,15 @@ import { cleanAPIv1Headers, handleAPIv1Res, readmeAPIv1Fetch } from '../../lib/r
 import { getProjectVersion } from '../../lib/versionSelect.js';
 
 export default class UpdateVersionCommand extends BaseCommand<typeof UpdateVersionCommand> {
+  // needed for deprecation message
+  static id = 'versions update' as const;
+
+  static state = 'deprecated';
+
+  static deprecationOptions = {
+    message: `\`rdme ${this.id}\` is deprecated and will be removed in v10. For more information, please visit our migration guide: https://github.com/readmeio/rdme/tree/v9/documentation/migration-guide.md`,
+  };
+
   static description = 'Update an existing version for your project.';
 
   static args = {
