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

Validator rule for .editorconfig file #258

Open
tarlepp opened this issue Feb 20, 2020 · 5 comments
Open

Validator rule for .editorconfig file #258

tarlepp opened this issue Feb 20, 2020 · 5 comments
Labels
question Further information is requested

Comments

@tarlepp
Copy link
Member

tarlepp commented Feb 20, 2020

It's quite common that repository that doesn't have this .editorconfig file, people who contribute that repository will use different settings for eg. following;

  • Line endings
  • Indentation rules
  • etc

And to make some common ground for all .editorconfig is the rescue - https://editorconfig.org/

@Hekku2
Copy link
Contributor

Hekku2 commented Feb 21, 2020

To define this further:

  1. Are there some cases when .editorconfig is not needed? ie. some project type / ide which doesn't support this? It would be good if we can automatically take these into account
  2. I think could also have automatic fix, or at least we can offer a base for editor config, similar to readme.md base? Are there some defaults we could offer here?

@Hekku2
Copy link
Contributor

Hekku2 commented Mar 10, 2020

@tarlepp Do you have some kind of statistics where .editorconfig is usually located?

@Hekku2 Hekku2 added the question Further information is requested label Mar 10, 2020
@tarlepp
Copy link
Member Author

tarlepp commented May 28, 2020

@tarlepp Do you have some kind of statistics where .editorconfig is usually located?

In the root of the repository, there might be some other subdirectories too - but the main one should be in the repository root - and sorry for late answer. - https://editorconfig.org/#file-location

@tarlepp
Copy link
Member Author

tarlepp commented May 28, 2020

2. I think could also have automatic fix, or at least we can offer a base for editor config, similar to readme.md base? Are there some defaults we could offer here?

For this I wouldn't make PR to fix that, issue itself could just point to EditorConfig - and why that?

  • Different projects/teams are using different style of eg. indentation rules
  • I don't think that we really can make one base to rule those all - that's why the link to official site should be enough - https://editorconfig.org/#example-file

@tarlepp
Copy link
Member Author

tarlepp commented May 28, 2020

  1. Are there some cases when .editorconfig is not needed? ie. some project type / ide which doesn't support this? It would be good if we can automatically take these into account

If it's not needed that repository could add that check to ignore list - right?

IDE support of .editorconfig is quite massive - https://editorconfig.org/#download

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants