tools icon indicating copy to clipboard operation
tools copied to clipboard

📎 Create rome environment command

Open jer3m01 opened this issue 2 years ago • 4 comments

Description

When making bug reports the templates asks users for environment information. It suggests OS and OS version, CPU architecture, installation method, etc..

Rome previously had a command rome rage --summary (#852) that would output all relevant info for the user to copy & paste.

This would simplify bug reports and debugging.

Specifically:

  • Rome version (env!("CARGO_PKG_VERSION"))
  • OS & arch (https://doc.rust-lang.org/std/env/consts/index.html)
  • Node version
  • Terminal info
  • Flags (? if we already have any)

jer3m01 avatar Apr 17 '22 18:04 jer3m01

Adding a note here: when running the CLI through the npm package, the node.js wrapper script could inject a few "private" environment variables to let the prebuilt binary know it's running through the wrapper, and what version of the package is being used (it could also inject the value of process.version to let the binary know about the version of node that's in use)

leops avatar Apr 19 '22 15:04 leops

I like this! I was also thinking of having something that'd make it easy to open an issue or even have a panic handler that says "hey, Rome crashed, here's a template to open an issue"

NicholasLYang avatar Apr 22 '22 19:04 NicholasLYang

Maybe we could reference this package https://github.com/tabrindle/envinfo

IWANABETHATGUY avatar Jul 18 '22 15:07 IWANABETHATGUY

Maybe we could reference this package tabrindle/envinfo

I think we can reuse what we had in Rome classic :) which has an output that is more tailored to our needs

Screenshot 2022-07-19 at 14 14 26

Here the code: https://github.com/rome/tools/blob/6b47011c5f3d5ed783855b821cdbc9cf1d687266/internal/cli-environment/index.ts

ematipico avatar Jul 19 '22 13:07 ematipico

👋 @rome/staff please triage this issue by adding one of the following labels: S-Bug: confirmed, S-Planned , S-Wishlist or umbrella

github-actions[bot] avatar Nov 18 '22 12:11 github-actions[bot]

Rome now has a rome rage command that you can use to get that kind of information

MichaReiser avatar Nov 18 '22 12:11 MichaReiser