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

feat: turbo info command for debugging #9368

Merged
merged 10 commits into from
Nov 7, 2024
Merged

feat: turbo info command for debugging #9368

merged 10 commits into from
Nov 7, 2024

Conversation

anthonyshew
Copy link
Contributor

@anthonyshew anthonyshew commented Nov 1, 2024

Description

A command to provide debugging information for reproductions or otherwise understand a machine better. Output will look something close to this.

CLI:
   Version: 2.2.4-canary.4
   Location: /Users/anthonyshew/projects/open/turbo/target/debug/turbo
   Daemon status: Running
   Package manager: pnpm

Platform:
   Architecture: aarch64
   Operating system: macos
   Available memory (MB): 13598
   Available CPU cores: 10

Environment:
   CI: None
   Terminal (TERM): xterm-256color
   Terminal program (TERM_PROGRAM): tmux
   Terminal program version (TERM_PROGRAM_VERSION): 3.4
   Shell (SHELL): /bin/zsh
   stdin: false

Turborepo System Environment Variables:
   TURBO_INVOCATION_DIR: /Users/anthonyshew/projects/open/turbo

Testing Instructions

Try it out!

Copy link

vercel bot commented Nov 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 6, 2024 9:03pm
8 Skipped Deployments
Name Status Preview Comments Updated (UTC)
examples-basic-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-gatsby-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2024 9:03pm

@anthonyshew anthonyshew changed the title feat: turbo info command for debugging feat: turbo info command for debugging Nov 1, 2024
@@ -475,9 +475,7 @@ impl Args {
}
}

/// Defines the subcommands for CLI. NOTE: If we change the commands in Go,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated, but saw it mentioning Go so ✂️

Copy link
Contributor

@NicholasLYang NicholasLYang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a couple notes

NoCurrentExe(#[from] io::Error),
}

pub async fn run(base: CommandBase) -> Result<(), Error> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ITG (non blocking follow up): Separate the data from the display logic to make this more unit-test friendly and support additional output formats like JSON.

Something like:

struct TurboInfo {
    package_manager: String,
    daemon_status: String,
    ...
}

And then have turbo_info.print() to actually write the data to stdout

@anthonyshew
Copy link
Contributor Author

Opting to not print the env vars. If we feel like we need it later, we can print them with an optional flag.

@anthonyshew anthonyshew merged commit 52f6f46 into main Nov 7, 2024
40 checks passed
@anthonyshew anthonyshew deleted the shew-43923 branch November 7, 2024 15:54
@anthonyshew anthonyshew mentioned this pull request Nov 8, 2024
anthonyshew added a commit that referenced this pull request Nov 12, 2024
2.3 release

### Description

Adds #9368 to the docs.

### Testing Instructions

👀
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants