|
| 1 | +--- |
| 2 | +name: Bug Report |
| 3 | +about: Create an issue for a bug in the Black Formatter tools extension for VS Code. |
| 4 | +title: '' |
| 5 | +labels: 'bug' |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | +<!-- Hello! Thank you for submitting a bug to our repo. Our users and their bug reports are essential to our development process. |
| 10 | +Before you submit an issue: |
| 11 | +1. Please search for the bug in existing issues on the repo. Search using keywords or error messages and check both `open` and `closed` issues. |
| 12 | +2. Try setting your log level to trace and look at the logs in more detail, as there may be more information there. If not, then these trace logs are part |
| 13 | +of the bug report below! (see directions on how to set and access these logs in the `Logs` section below.) |
| 14 | +Thank you!--> |
| 15 | + |
| 16 | +## Diagnostic Data |
| 17 | +- Python version (& distribution if applicable, e.g., Anaconda): <!-- ADD YOUR ANSWER HERE --> |
| 18 | +- Type of virtual environment used (e.g., conda, venv, virtualenv, etc.): <!-- ADD YOUR ANSWER HERE --> |
| 19 | +- Operating system (and version): <!-- ADD YOUR ANSWER HERE --> |
| 20 | +- Version of tool extension you are using: <!-- ADD YOUR ANSWER HERE --> |
| 21 | + |
| 22 | +## Behaviour |
| 23 | +### Expected Behavior |
| 24 | +<!-- What did you expect to happen? --> |
| 25 | + |
| 26 | +### Actual Behavior |
| 27 | +<!-- What actually happened? --> |
| 28 | + |
| 29 | +## Reproduction Steps: |
| 30 | +<!-- How can we reproduce the bug? Please be as detailed as possible so we can help with your bug faster! --> |
| 31 | + |
| 32 | +## Logs: |
| 33 | +<!-- |
| 34 | +Steps to set log level to trace and view: |
| 35 | +1. Open the Command Palette via Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS). |
| 36 | +2. Find the Command to Set Log Level: Type 'Developer: Set Log Level', select `trace`. |
| 37 | +3. Open the Output panel by going to View > Output, or by using the shortcut Ctrl+Shift+U on Windows/Linux or Cmd+Shift+U on macOS. |
| 38 | +4. Select `Black Formatter` from the dropdown. |
| 39 | +5. Your logs should now be shown! Try rerunning the failing command again now that logs are set to `trace` to look at all information. --> |
| 40 | +<details> |
| 41 | + <summary>Click here for detailed logs</summary> |
| 42 | + <!-- Paste your logs here --> |
| 43 | +</details> |
| 44 | + |
| 45 | +## Outcome When Attempting Debugging Steps: |
| 46 | +<!-- Please attempt running the tool from the command line and see the result, as our extension ultimately calls the tool and reports back this information. |
| 47 | +Steps: |
| 48 | +1. Use the steps at the top of this page `Steps to set log level to trace and view` to get to the `Black Formatter` logs. |
| 49 | +2. Search in your logs for keywords like "command", "running", and you will find a line that shows the exact command we run. |
| 50 | +3. Run this command in your command line, and see if it works from there! |
| 51 | +If it works from your command line and not the extension, this is likely an extension bug; if it doesn't work in your command line, debug there. --> |
| 52 | +Did running it from the command line work? <!-- ADD YOUR ANSWER HERE --> |
| 53 | + |
| 54 | +## Extra Details |
| 55 | +<!-- Optional: Anything else which might be useful? |
| 56 | +This may include: |
| 57 | +- What other Python-related extensions are you using? |
| 58 | +- What does your project structure look like? |
| 59 | +- Are you working in a multiroot workspace? |
| 60 | +- Where is the config file for the current tool? |
| 61 | +- Any extra settings from your workspace or user settings.json files? --> |
0 commit comments