chore(cli): change name of --output option to --format #1413

EverlastingBugstopper · 2022-11-14T15:45:43Z

gocamille · 2022-11-28T13:32:20Z

Description

This PR adds a new option, --format, to allow users to define the format type (either plain or json) for stdout messages. Fixes #1212.

Motivation and Context

According to the Command Line Interface Guidelines, use of the --output (--o for short) option in a CLI should be restricted to defining a file output. Rover’s current implementation of --output is for defining the format type for messages to stdout. This PR updates Rover to be in line with the Guidelines by:

Adding a --format option type that can take either plain or json as arguments to handle formatting messages to stdout.
Adding a deprecation warning when a user uses the --output option, with a suggestion to use the new --format option.
Throwing an error if a user attempts to enter both --output and --format in the same command.
Add another type to the --output option of Utf8PathBuf to handle future arguments to this option when it is refactored for defining file outputs.

Other considerations:

The get_stdout() function returns an optional String result because some RoverOutput types do not return anything to stdout. Ideally all output types return some signal to the user. Issues #1436, #1437, and #1438 address this.
We now provide messaging when users decide to output to a file.

EverlastingBugstopper · 2022-11-28T16:39:18Z

There's this issue as well since I don't think rover config whoami prints to stdout: #1380

EverlastingBugstopper

left a note on refactoring, but also at a higher level - specifying --output file.txt doesn't ever write anything to that file! we should check to see what the output destination is before printing - if it's stdout, print it, if it's a file, create and write to the file (using rover_std::Fs). also, there are a few lints that clippy picked up in CI that we'll need to fix up.

This is great work, keep it up!

CHANGELOG.md

src/cli.rs

src/command/dev/command.rs

Co-authored-by: Trevor Blades <[email protected]> Co-authored-by: Sachin D. Shinde <[email protected]> Co-authored-by: Jesse Wang <[email protected]> Co-authored-by: Patrick Arminio <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

feat(cli): check both output_type and format_type for formatting

src/bin/rover.rs

EverlastingBugstopper

sssooo close!! great work on this, so excited to see it land 😸

src/bin/rover.rs

src/options/output.rs

EverlastingBugstopper · 2023-01-09T19:56:33Z

src/options/output.rs

+            }
+            (None, Some(OutputType::LegacyOutputType(_))) => {
+                let warn_prefix = Style::WarningPrefix.paint("WARN:");
+                eprintln!("{} The argument '--output' will soon be deprecated. Please use the '--format' argument to specify the output type.", warn_prefix);


Suggested change

eprintln!("{} The argument '--output' will soon be deprecated. Please use the '--format' argument to specify the output type.", warn_prefix);

eprintln!("{} The argument for specifying the format of Rover's output has been renamed from '--output' to '--format'. Please use the '--format' argument to specify the output format instead of '--output'. Future versions of Rover may be incompatible with this usage.", warn_prefix);

cc @StephenBarlow on this wording

src/options/output.rs

gocamille · 2023-01-10T22:37:51Z

docs/source/configuring.md

@@ -76,15 +76,17 @@ If Rover log messages are unhelpful or unclear, please leave us feedback in an



cc @StephenBarlow -- let us know if this copy needs to be refined!

EverlastingBugstopper · 2023-01-18T16:15:43Z

Unfortunately I ran into a bug with this when used in combination with the --watch flag on rover graph introspect and rover subgraph introspect - the watcher should be writing files out to disk on changes but it is not. This isn't something we discussed and so I'm happy to take on this fix.

@sachindshinde

# [0.11.0] - 2023-01-24 ## 🚀 Features - **Manage contract configuration - @sachindshinde, #1475 fixes #1421** Rover now includes two commands for creating, modifying, and reading contracts: `rover contract publish` and `rover contract describe`. Further documentation can be found [here](https://www.apollographql.com/docs/rover/commands/contracts). - **Easier file output with new `--output` argument - @gocamille, #1413 fixes #1212** The `--output` argument has long been used to configure the format of Rover's output. i.e. `--output json` configures Rover to print its output as a JSON object. This argument has been _renamed_ to `--format` while maintaining backwards compatibility. `--format json` should be used to configure the format of Rover's output, and the `--output` argument allows you to specify a file to print the output to. Adding `--output schema.graphql` to a `rover subgraph fetch` command will output your schema to a file. `--output data.json --format json` will output the command data to `data.json`. `--output json` will still work by itself but will now print a warning, and `--output [json|plain]` does not work with `--format [json|plain]`. Further documentation can be found [here](https://www.apollographql.com/docs/rover/conventions#output-to-a-file). - **Adds `--router-config` to `rover dev` - @EverlastingBugstopper, #1446 fixes #1373, #1345, and #1468** The new `--router-config` argument for `rover dev` allows you to pass a [router configuration file]() on startup that can configure settings such as header propagaion and CORS policies. Further documentation can be found [here](https://www.apollographql.com/docs/rover/commands/dev/#advanced-configuration). - **Auto-update router versions in `rover dev` - @EverlastingBugstopper, #1432** `rover dev` will automatically use the version of the router specified in [this plugin file](https://github.com/apollographql/rover/blob/main/latest_plugin_versions.json) instead of a hard coded version. ## 🛠 Maintenance - **Better error and help text for ELv2 license argument - @DoumanAsh, #1456 fixes #1455** The help text for the `--elv2-license` argument now includes the expected value for the argument, in addition to the error message returned when the argument is needed but not passed. - **Updates the Ariadne template URL - @patrick91, #1439** - **Updates `./examples/supergraph-demo` to `@apollo/server` v4, and removes `./examples/dev` - @EverlastingBugsttopper, #1442 fixes #1440 and #1441** - **Updates dependencies - @EverlastingBugstopper, #1481, #1450** `apollo-parser` 0.3 -> 0.4 `base64` 0.13 -> 0.21 `git2` 0.15 -> 0.16 `graphql_client` 0.11.0 -> 0.12 `serial_test` 0.9 -> 1.0 `os_info` 3.4 -> 3.5 `os_type` 2.4 -> 2.6 `termcolor` 1.1 -> 1.2 `tokio` 1.21 -> 1.24 ## 📚 Documentation - **Fixes a link to schema check example - @MayCXC, #1431**

EverlastingBugstopper assigned EverlastingBugstopper and gocamille Nov 14, 2022

gocamille force-pushed the camille/update-format-option branch from ba8e1ce to 0c0824d Compare November 24, 2022 15:47

gocamille marked this pull request as ready for review November 28, 2022 13:13

gocamille requested a review from lrlna as a code owner November 28, 2022 13:13

gocamille force-pushed the camille/update-format-option branch from b92d9b7 to 2bb75f9 Compare November 28, 2022 14:18

EverlastingBugstopper commented Nov 29, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/cli.rs Outdated Show resolved Hide resolved

src/cli.rs Outdated Show resolved Hide resolved

src/cli.rs Outdated Show resolved Hide resolved

src/command/dev/command.rs Outdated Show resolved Hide resolved

gocamille force-pushed the camille/update-format-option branch from 9a66063 to 1625623 Compare November 30, 2022 14:09

gocamille and others added 16 commits January 9, 2023 01:47

feat(cli): change --output option name to --format

894d81a

feat(cli): Include logic to deprecate output option

f587f38

feat(cli): check both output_type and format_type for formatting

feat(cli): refactor rover_output logic

7b75c1c

feat(cli): add a print function to stdout plain text

e08c20c

feat(cli): add matching and error handling for plaintext stdout

e8eb42c

feat(cli): Add deprecation message for '--output'

0a7dd7c

feat(cli): remove unused imports

0520dab

feat(cli): update '--output' deprecation msg from error to warning

49fd6b9

feat(cli): Update changelog

7ff032b

feat(cli): add indent to changelog

e72f260

feat(cli): refactor from clippy suggestions

c6c90f4

feat(cli): remove unused module

fe9abf2

feat(cli): Add print to file option for output

3c6c21d

feat(cli): update changelog

13d2c24

feat(cli): Add logic to deprecate --output and print to file

ee07e6e

gocamille force-pushed the camille/update-format-option branch from d721923 to ee07e6e Compare January 9, 2023 00:49

gocamille reviewed Jan 9, 2023

View reviewed changes

src/bin/rover.rs Show resolved Hide resolved

EverlastingBugstopper commented Jan 9, 2023

View reviewed changes

src/options/output.rs Outdated Show resolved Hide resolved

gocamille added 5 commits January 10, 2023 12:39

feat(cli): Add emoji to file output message

a0f4dd6

feat(cli): remove unneeded comments and imports

d39d937

feat(cli): rename RoverOutputTrait

d05f808

feat(cli): update output documentation to include --output deprecation

f099b32

feat(cli): re-include SdlType crate

ca45449

gocamille requested a review from StephenBarlow as a code owner January 10, 2023 22:36

gocamille reviewed Jan 10, 2023

View reviewed changes

gocamille and others added 5 commits January 10, 2023 23:45

feat(cli): change doc references from to

1c8611e

Edits to new docs around --format

d66b79a

Edits to new docs around --format (#1469)

b602a41

Merge branch 'main' into camille/update-format-option

2762f1c

chore: lints and version update in docs

b378556

EverlastingBugstopper added the feature 🎉 new commands, flags, functionality, and improved error messages label Jan 18, 2023

EverlastingBugstopper added this to the vNext milestone Jan 18, 2023

EverlastingBugstopper added 5 commits January 18, 2023 10:58

Merge branch 'main' into camille/update-format-option

dea54ba

Merge branch 'main' into camille/update-format-option

28dd777

Merge branch 'main' into camille/update-format-option

d9d2ceb

fix: make --watch work with new --output (#1478)

4482f83

chore: small changes on warning text

ce3f80c

EverlastingBugstopper merged commit c2ad28b into main Jan 19, 2023

EverlastingBugstopper deleted the camille/update-format-option branch January 19, 2023 20:02

This was referenced Jan 19, 2023

hotfix: resolve merge conflicts between main and sachin/new-contracts-commands #1479

Merged

release: v0.11.0 #1486

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cli): change name of --output option to --format #1413

chore(cli): change name of --output option to --format #1413

EverlastingBugstopper commented Nov 14, 2022

gocamille commented Nov 28, 2022 •

edited

Loading

EverlastingBugstopper commented Nov 28, 2022

EverlastingBugstopper left a comment •

edited

Loading

EverlastingBugstopper left a comment

EverlastingBugstopper Jan 9, 2023

EverlastingBugstopper Jan 9, 2023

gocamille Jan 10, 2023

EverlastingBugstopper commented Jan 18, 2023

	eprintln!("{} The argument '--output' will soon be deprecated. Please use the '--format' argument to specify the output type.", warn_prefix);
	eprintln!("{} The argument for specifying the format of Rover's output has been renamed from '--output' to '--format'. Please use the '--format' argument to specify the output format instead of '--output'. Future versions of Rover may be incompatible with this usage.", warn_prefix);

		@@ -76,15 +76,17 @@ If Rover log messages are unhelpful or unclear, please leave us feedback in an

chore(cli): change name of --output option to --format #1413

chore(cli): change name of --output option to --format #1413

Conversation

EverlastingBugstopper commented Nov 14, 2022

gocamille commented Nov 28, 2022 • edited Loading

Description

Motivation and Context

Other considerations:

EverlastingBugstopper commented Nov 28, 2022

EverlastingBugstopper left a comment • edited Loading

Choose a reason for hiding this comment

EverlastingBugstopper left a comment

Choose a reason for hiding this comment

EverlastingBugstopper Jan 9, 2023

Choose a reason for hiding this comment

EverlastingBugstopper Jan 9, 2023

Choose a reason for hiding this comment

gocamille Jan 10, 2023

Choose a reason for hiding this comment

EverlastingBugstopper commented Jan 18, 2023

gocamille commented Nov 28, 2022 •

edited

Loading

EverlastingBugstopper left a comment •

edited

Loading