Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick pass on Rover help texts #96

Merged
merged 3 commits into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::command::{self, RoverStdout};
use crate::stringify::from_display;

#[derive(Debug, Serialize, StructOpt)]
#[structopt(name = "Rover", about = "✨🤖🐶 the new CLI for apollo")]
#[structopt(name = "Rover", about = "✨🤖🐶 the new CLI for Apollo", global_settings = &[structopt::clap::AppSettings::ColoredHelp])]
pub struct Rover {
#[structopt(subcommand)]
pub command: Command,
Expand All @@ -19,13 +19,13 @@ pub struct Rover {

#[derive(Debug, Serialize, StructOpt)]
pub enum Command {
/// ⚙️ Manage configuration
/// ⚙️ Rover configuration
Config(command::Config),

/// 🧱 Work with a non-federated graph
/// ⏺ Non-federated schema/graph commands
Schema(command::Schema),

/// 🗺️ Work with a federated graph and implementing services
/// *️⃣ Federated schema/graph commands
Partial(command::Partial),

#[structopt(setting(structopt::clap::AppSettings::Hidden))]
Expand Down
6 changes: 3 additions & 3 deletions src/command/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ pub struct Config {

#[derive(Debug, Serialize, StructOpt)]
pub enum Command {
/// 🔑 Configure an account or graph API key
/// 🔑 Set an Apollo Studio API key
ApiKey(api_key::ApiKey),
/// 💁 Operations for listing, viewing, and deleting configuration profiles
/// 👤 Manage configuration profiles
Profile(profile::Profile),
/// 🚮 Remove all configuration
/// 🗑 Clear ALL configuration
Clear,
}

Expand Down
6 changes: 3 additions & 3 deletions src/command/config/profile.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ pub struct Profile {

#[derive(Debug, Serialize, StructOpt)]
pub enum Command {
/// 🎅 List all of your configuration profiles
/// 👥 List all configuration profiles
List,

/// 👀 See a specific profile's values
/// 👤 View a configuration profile's details
Show(Show),

/// 🪓 Delete a specific profile
/// 🗑 Delete a configuration profile
Delete(Delete),
}

Expand Down
8 changes: 4 additions & 4 deletions src/command/partial/delete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@ use structopt::StructOpt;

#[derive(Debug, Serialize, StructOpt)]
pub struct Delete {
/// Variant of the graph in Apollo Studio
/// Name of graph variant in Apollo Studio to delete a service from
#[structopt(long, default_value = "current")]
#[serde(skip_serializing)]
variant: String,

/// ID of the graph in Apollo Studio to delete a service from
/// ID of federated graph in Apollo Studio to delete a service from
#[structopt(long)]
#[serde(skip_serializing)]
graph_name: String,

/// Name of the configuration profile (default: "default")
/// Name of configuration profile to use
#[structopt(long = "profile", default_value = "default")]
#[serde(skip_serializing)]
profile_name: String,

/// Name of the implementing service in the graph to delete
/// Name of service in federated graph to delete
#[structopt(long)]
#[serde(skip_serializing)]
service_name: String,
Expand Down
4 changes: 2 additions & 2 deletions src/command/partial/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ pub struct Partial {

#[derive(Debug, Serialize, StructOpt)]
pub enum Command {
/// 📤 Push a schema from a file
/// ⬆️ Push an implementing service schema from a local file
Push(push::Push),
/// 🗑 Delete an implementing service and trigger composition
/// 🗑 Delete an implementing service and trigger composition
Delete(delete::Delete),
}

Expand Down
10 changes: 5 additions & 5 deletions src/command/partial/push.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,27 @@ use crate::command::RoverStdout;

#[derive(Debug, Serialize, StructOpt)]
pub struct Push {
/// Path to a .graphql SDL file
/// Path of .graphql/.gql schema file to push
#[structopt(name = "SCHEMA_PATH", parse(from_os_str))]
#[serde(skip_serializing)]
schema_path: PathBuf,

/// Variant of the graph in Apollo Studio
/// Name of graph variant in Apollo Studio to push to
#[structopt(long, default_value = "current")]
#[serde(skip_serializing)]
variant: String,

/// ID of the graph in Apollo Studio to push to
/// ID of federated graph in Apollo Studio to push to
#[structopt(long)]
#[serde(skip_serializing)]
graph_name: String,

/// Name of the configuration profile (default: "default")
/// Name of configuration profile to use
#[structopt(long = "profile", default_value = "default")]
#[serde(skip_serializing)]
profile_name: String,

/// Name of the implementing service in the graph to update with a new schema
/// Name of implementing service in federated graph to update
#[structopt(long)]
#[serde(skip_serializing)]
service_name: String,
Expand Down
6 changes: 3 additions & 3 deletions src/command/schema/fetch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ use crate::command::RoverStdout;

#[derive(Debug, Serialize, StructOpt)]
pub struct Fetch {
/// ID of the graph to fetch from Apollo Studio
/// ID of graph in Apollo Studio to fetch from
#[structopt(name = "GRAPH_NAME")]
#[serde(skip_serializing)]
graph_name: String,

/// The variant of the graph in Apollo Studio
/// Name of graph variant in Apollo Studio to fetch from
#[structopt(long, default_value = "current")]
#[serde(skip_serializing)]
variant: String,

/// Name of the configuration profile (default: "default")
/// Name of configuration profile to use
#[structopt(long = "profile", default_value = "default")]
#[serde(skip_serializing)]
profile_name: String,
Expand Down
4 changes: 2 additions & 2 deletions src/command/schema/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ pub struct Schema {

#[derive(Debug, Serialize, StructOpt)]
pub enum Command {
/// 🐶 Get a schema given an identifier
/// ⬇️ Fetch a schema from Apollo Studio
Fetch(fetch::Fetch),

/// 📤 Push a schema from a file
/// ⬆️ Push a schema to Apollo Studio from a local file
Push(push::Push),
}

Expand Down
8 changes: 4 additions & 4 deletions src/command/schema/push.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ use crate::command::RoverStdout;

#[derive(Debug, Serialize, StructOpt)]
pub struct Push {
/// Path to a .graphql SDL file
/// Path of .graphql/.gql schema file to push
#[structopt(name = "SCHEMA_PATH", parse(from_os_str))]
#[serde(skip_serializing)]
schema_path: PathBuf,

/// Variant of the graph in Apollo Studio
/// Name of graph variant in Apollo Studio to push to
#[structopt(long, default_value = "current")]
#[serde(skip_serializing)]
variant: String,

/// ID of the graph in Apollo Studio to push to
/// ID of graph in Apollo Studio to push to
#[structopt(long)]
#[serde(skip_serializing)]
graph_name: String,

/// Name of the configuration profile (default: "default")
/// Name of configuration profile to use
#[structopt(long = "profile", default_value = "default")]
#[serde(skip_serializing)]
profile_name: String,
Expand Down