Rename 'change-visibility' tool for clarity

Author: PaulAdamDavis

README.md

@@ -44,7 +44,8 @@ Available tools include:
 * [`delete-unused-tags`](#delete-unused-tags)
 * [`find-replace`](#find-replace)
 * [`change-author`](#change-author)
-* [`change-visibility`](#change-visibility)
+* [`change-visibility-posts`](#change-visibility-posts)
+* [`change-visibility-pages`](#change-visibility-pages)
 * [`change-status`](#change-status)
 * [`change-role`](#change-role)
 * [`add-member-newsletter-subscription`](#add-member-newsletter-subscription)
@@ -342,25 +343,47 @@ gctools change-author <apiURL> <adminAPIKey> --author 'richard' --new_author 'mi
 ```
 
 
-### change-visibility
+### change-visibility-posts
 
 Change the visibility of posts
 
 ```sh
 # See all available options
-gctools change-visibility --help
+gctools change-visibility-posts --help
 
 # Change the posts that are currently public to be members-only
-gctools change-visibility <apiURL> <adminAPIKey> --visibility 'public' --new_visibility 'members'
+gctools change-visibility-posts <apiURL> <adminAPIKey> --visibility 'public' --new_visibility 'members'
 
 # Change the posts that are currently members-only to be paid-members only
-gctools change-visibility <apiURL> <adminAPIKey> --visibility 'members' --new_visibility 'paid'
+gctools change-visibility-posts <apiURL> <adminAPIKey> --visibility 'members' --new_visibility 'paid'
 
 # Change the posts tagged with 'news' to be paid-members only
-gctools change-visibility <apiURL> <adminAPIKey> --tag 'news' --new_visibility 'paid'
+gctools change-visibility-posts <apiURL> <adminAPIKey> --tag 'news' --new_visibility 'paid'
 
 # Change the posts tagged with 'news', and written by 'jane' to be paid-members only
-gctools change-visibility <apiURL> <adminAPIKey> --tag 'news' --author 'jane' --new_visibility 'paid'
+gctools change-visibility-posts <apiURL> <adminAPIKey> --tag 'news' --author 'jane' --new_visibility 'paid'
+```
+
+
+### change-visibility-pages
+
+Change the visibility of pages
+
+```sh
+# See all available options
+gctools change-visibility-pages --help
+
+# Change the pages that are currently public to be members-only
+gctools change-visibility-pages <apiURL> <adminAPIKey> --visibility 'public' --new_visibility 'members'
+
+# Change the pages that are currently members-only to be paid-members only
+gctools change-visibility-pages <apiURL> <adminAPIKey> --visibility 'members' --new_visibility 'paid'
+
+# Change the pages tagged with 'news' to be paid-members only
+gctools change-visibility-pages <apiURL> <adminAPIKey> --tag 'news' --new_visibility 'paid'
+
+# Change the pages tagged with 'news', and written by 'jane' to be paid-members only
+gctools change-visibility-pages <apiURL> <adminAPIKey> --tag 'news' --author 'jane' --new_visibility 'paid'
 ```
 
 

bin/cli.js

@@ -9,7 +9,7 @@ import addTagsCommands from '../commands/add-tags.js';
 import changeAuthorCommands from '../commands/change-author.js';
 import changeRoleCommands from '../commands/change-role.js';
 import changeStatusCommands from '../commands/change-status.js';
-import changeVisibilityCommands from '../commands/change-visibility.js';
+import changeVisibilityPostsCommands from '../commands/change-visibility-posts.js';
 import changeVisibilityPagesCommands from '../commands/change-visibility-pages.js';
 import combineTagsCommands from '../commands/combine-tags.js';
 import contentStatsCommands from '../commands/content-stats.js';
@@ -35,7 +35,7 @@ prettyCLI.command(addTagsCommands);
 prettyCLI.command(changeAuthorCommands);
 prettyCLI.command(changeRoleCommands);
 prettyCLI.command(changeStatusCommands);
-prettyCLI.command(changeVisibilityCommands);
+prettyCLI.command(changeVisibilityPostsCommands);
 prettyCLI.command(changeVisibilityPagesCommands);
 prettyCLI.command(combineTagsCommands);
 prettyCLI.command(contentStatsCommands);

commands/change-visibility.js renamed to commands/change-visibility-posts.js

@@ -1,13 +1,13 @@
 import {ui} from '@tryghost/pretty-cli';
-import changeVisibility from '../tasks/change-visibility.js';
+import changeVisibilityPosts from '../tasks/change-visibility-posts.js';
 
 // Internal ID in case we need one.
-const id = 'change-visibility';
+const id = 'change-visibility-posts';
 
 const group = 'Content:';
 
 // The command to run and any params
-const flags = 'change-visibility <apiURL> <adminAPIKey>';
+const flags = 'change-visibility-posts <apiURL> <adminAPIKey>';
 
 // Description for the top level command
 const desc = 'Switch the visibility for posts from one level to another';
@@ -55,7 +55,7 @@ const run = async (argv) => {
 
     try {
         // Fetch the tasks, configured correctly according to the options passed in
-        let runner = changeVisibility.getTaskRunner(argv);
+        let runner = changeVisibilityPosts.getTaskRunner(argv);
 
         // Run the migration
         await runner.run(context);

commands/interactive.js

@@ -77,8 +77,8 @@ const run = async () => {
                 value: tasks.changeAuthor.choice.value
             },
             {
-                name: tasks.changeVisibility.choice.name,
-                value: tasks.changeVisibility.choice.value
+                name: tasks.changeVisibilityPosts.choice.name,
+                value: tasks.changeVisibilityPosts.choice.value
             },
             {
                 name: tasks.changeVisibilityPages.choice.name,

prompts/change-visibility.js renamed to prompts/change-visibility-posts.js

@@ -3,13 +3,13 @@ import inquirerSearchCheckbox from 'inquirer-search-checkbox';
 inquirer.registerPrompt('search-checkbox', inquirerSearchCheckbox);
 import chalk from 'chalk';
 import {ui} from '@tryghost/pretty-cli';
-import changeVisibility from '../tasks/change-visibility.js';
+import changeVisibilityPosts from '../tasks/change-visibility-posts.js';
 import {getAPIAuthorsObj, getAPITagsObj, getAPIVisibilityObj} from '../lib/ghost-api-choices.js';
 import ghostAPICreds from '../lib/ghost-api-creds.js';
 
 const choice = {
-    name: 'Change Visibility',
-    value: 'changeVisibility'
+    name: 'Change Visibility for Posts',
+    value: 'changeVisibilityPosts'
 };
 
 const options = [
@@ -70,7 +70,7 @@ async function run() {
         let context = {errors: []};
 
         try {
-            let runner = changeVisibility.getTaskRunner(answers);
+            let runner = changeVisibilityPosts.getTaskRunner(answers);
             await runner.run(context);
             ui.log.ok(`Successfully changed ${context.changed.length} posts in ${Date.now() - timer}ms.`);
         } catch (error) {

prompts/index.js

@@ -12,7 +12,7 @@ import deleteTags from './delete-tags.js';
 import deleteUnusedTags from './delete-unused-tags.js';
 import findReplace from './find-replace.js';
 import changeAuthor from './change-author.js';
-import changeVisibility from './change-visibility.js';
+import changeVisibilityPosts from './change-visibility-posts.js';
 import changeVisibilityPages from './change-visibility-pages.js';
 import changeStatus from './change-status.js';
 import changeRole from './change-role.js';
@@ -36,7 +36,7 @@ export default {
     deleteUnusedTags,
     findReplace,
     changeAuthor,
-    changeVisibility,
+    changeVisibilityPosts,
     changeVisibilityPages,
     changeStatus,
     changeRole,