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

Document meaning of Version, SpacesAftertabs, and PassedFiles keys in config file #325

Open
krzysztof-sikorski opened this issue Feb 1, 2024 · 2 comments
Labels
docs issues regarding documentation good first issue help wanted

Comments

@krzysztof-sikorski
Copy link

krzysztof-sikorski commented Feb 1, 2024

Command ec -init generates a sample configuration file, and most of its content is described somewhere in documentation, but three of the keys are not documented: Version, SpacesAftertabs, and PassedFiles.

I had to search source code to (partially) guess what these options do, and I am still not sure if I understood Go code correctly:

  • the Version field seems to be used for some kind of version compatibility check (to not allow using old config file after installing a different version of the tool?)
  • the SpacesAftertabs flag seems to be used to allow using mixed tabs-and-spaces indentation
  • ... and I have completely no idea what PassedFiles option means

It would be nice if documentation was updated (both in README and on editorconfig-checker.github.io page) to mention these options and describe what they do.

@mstruebing
Copy link
Member

Hey you are very right.
It would be amazing if you could send a PR to document these values.

@mstruebing mstruebing added good first issue docs issues regarding documentation labels Feb 2, 2024
@krzysztof-sikorski
Copy link
Author

@mstruebing the problem is understanding what these options mean.

I never learnt Go and I can only guess what the source code does based on my general knowledge of other programming languages, and I am not sure if I guessed correctly.

If one of the devs (or other people that understand the code better than me) could confirm or summarise what these options do, then yes, I would gladly do the chore of making a patch or PR that updates the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs issues regarding documentation good first issue help wanted
Projects
None yet
Development

No branches or pull requests

2 participants