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

Include commonly used configurations in Settings #27

Open
dciborow opened this issue May 2, 2022 · 2 comments
Open

Include commonly used configurations in Settings #27

dciborow opened this issue May 2, 2022 · 2 comments
Labels
feature-request Request for new features or functionality needs community feedback

Comments

@dciborow
Copy link

dciborow commented May 2, 2022

The current settings page provides a minimum experience, which requires existing knowledge of Black.

Black has already worked to minimize the potential command line inputs a user could provide. These should be more specifically declared in the Settings page.

At least three settings should be included: config, line-count, and preview.

For example, to point Black to a configuration location, the following must be provided.
image

Having a dedicated "Setting" field, would improve the experience when entering this parameter. (I knew better, and I still put config --pyproject.yaml" into a single configuration...). BONUS: It would be great if there was an "auto-detect" button, which would scan for files like "pyproject.toml" or "black.toml" and provide a suggestion for this when pressed.

Line Count is a setting black particularly brought to the CLI, because they understood this was the most likely setting to be changed. When this setting is set in a configuration file, the value should be loaded and displayed here.

Preview is a flag that can provide a sneak peak of upcoming changes. A simple check box would provide the basic functionality.

Other configurations to consider including are the following two. The rest of the configurations do not make sense to include for an IDE experince, or are complex and should be in a configuration file directly.

  • 'fast' vs 'safe'
  • target-version
@github-actions github-actions bot added the triage-needed Issue is not triaged. label May 2, 2022
@karthiknadig karthiknadig added feature-request Request for new features or functionality needs community feedback and removed triage-needed Issue is not triaged. labels May 4, 2022
@dciborow
Copy link
Author

here is an example of the configuration avaiable when using the pycharm extension.
image

@DetachHead
Copy link

the pycharm extension has lots of issues regarding its settings, see lensvol/intellij-blackconnect#55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality needs community feedback
Projects
None yet
Development

No branches or pull requests

3 participants