Update issue template to include the --info flag #3797
Conversation
|
Thanks @bondz. Was going to get to this after the holiday. Do we need to keep the old commands? Also envinfo can auto copy to clipboard built in via option as well get browser versions if we want to add this later on. |
|
Also for the npx invocation of the command, it might be faster to use envinfo directly? |
|
@tabrindle The reason I kept the old commands is based on the assumption that CRA does not advertize updating the CRA module itself, so, some users might not have it available. Although, we could recommend that users are on that version like react-native does. For the The clipboard helper is a convenience especially for a user creating an issue and its explicit. Not sure if the default info command should automatically copy to clipboard, but would be nice since it works cross-platform on |
.github/ISSUE_TEMPLATE.md
Outdated
| 2. `npm -v`: | ||
| 3. `yarn --version` (if you use Yarn): | ||
| 4. `npm ls react-scripts` (if you haven’t ejected): | ||
| If you have create-react-app >= 1.5.0 installed, the `--info` flag generates information about your environment. |
There was a problem hiding this comment.
I feel like since we advertise npx now, this is actually not super likely.
.github/ISSUE_TEMPLATE.md
Outdated
| Run the command specific to your operating system in your react app's folder | ||
| Windows: `create-react-app --info | clip` | ||
| OSX: `create-react-app --info | pbcopy` |
|
Could you rebase please? I made some changes to the template that don't merge cleanly. |
|
Done. Looks like its messed up now though. sigh. |
|
Fixed. |
.github/ISSUE_TEMPLATE.md
Outdated
| macOS: `create-react-app --info | pbcopy` | ||
| Linux: `create-react-app --info` | ||
|
|
||
| If you get an error, you can use `npx` or `yarn` by running one of the commands below in terminal. |
There was a problem hiding this comment.
Shouldn’t these instructions come first? Users who follow our README will get an error.
|
I tested on macOS and Windows and it works. It errors on Linux without the I also tested it works on an ejected version of CRA. The #3859 should be available before this, otherwise, a version of Android Studio and XCode would be printed. It took ~20sec to run on my Mac, even longer on Windows. There is no way to make npx use yarn yet see yarnpkg/yarn#3937 |
|
Closing in favour of #4375 |
Document using the
--infoflag exposed by #3408 when reporting issues in CRA.For platforms that have a built in command to pipe from terminal to clipboard (OSX and Windows), the suggested command copies the result to the clipboard automatically. Although, it also never prints the result to terminal for the user to see first, which might be a bummer, suggestions welcome.
For Linux users, there are different ways to pipe the result of a command to terminal, I'll leave it up to the user to use one.