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

Use the default config of auto-formatting tools #238

Open
1 of 4 tasks
msm-code opened this issue Nov 30, 2021 · 3 comments
Open
1 of 4 tasks

Use the default config of auto-formatting tools #238

msm-code opened this issue Nov 30, 2021 · 3 comments
Assignees
Labels
zone:other Other task type
Milestone

Comments

@msm-code
Copy link
Contributor

Feature Category

  • Correctness
  • User Interface / User Experience
  • Performance
  • Other (please explain) - maintenance

Describe the problem

All of the projects in the family (mquery frontend, mquery backend, ursadb) make a heavy use of autoformatters (prettier, black, clang-format). This issue is about the first two.

  • We use prettier with an unstandard --tab-width=4 option.
  • We use black with unstandard line-length=79 configuration.

I'll take a hit on this one - if I remember correctly they were both my personal preference at the time (still is). But now I also see any bit of additional unstandard configuration as a liability and a hoop for new contributors to jump over.

Describe the solution you'd like

I propose to revert this configuration and use the defaults from now on.
We should also:

  • reformat the repo with new configuration
  • fix the documentation

Describe alternatives you've considered

The downside of reformatting everything is that we will lose some of the git blame magic. Alternative approach is to transparently rewrite git history - but I'm strongly against it, because this will completely devastate all the forks (for example, people that run mquery with one or two custom modifications).

We can also leave the formatter settings unchanged. This issue was created to discuss this problem and it's not decided if we're going to do this.

@msm-code
Copy link
Contributor Author

msm-code commented Nov 30, 2021

@nazywam @psrok1 @KWMORALE @ITAYC0HEN what do you think?

@ITAYC0HEN
Copy link
Collaborator

I think reverting to default settings is a good idea. Indeed, it will ruin git history but not many people worked on mquery so far so it's not hard to find who to blame :)

I am against rewriting history as well

@nazywam
Copy link
Member

nazywam commented Dec 6, 2021

👍

@msm-cert msm-cert added this to the v1.5.0 milestone Sep 29, 2024
@msm-cert msm-cert self-assigned this Sep 29, 2024
@msm-cert msm-cert added the zone:other Other task type label Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
zone:other Other task type
Projects
None yet
Development

No branches or pull requests

4 participants