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

Add editorconfig file and cleanup devicon.json bad formatting #1344

Closed
wants to merge 31 commits into from
Closed

Add editorconfig file and cleanup devicon.json bad formatting #1344

wants to merge 31 commits into from

Conversation

BenSouchet
Copy link
Contributor

Intro

This PR is based on this discussion #1337 , the idea was, as a first step, to add EditorConfig to the project, and I also fix bad formatting on the JSON file.

What is EditorConfig ?

EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.

What is done by EditorConfig

When you work on a file, and for example press the tab key , you will automatically insert the correct indent type and length, for Devicon it's space of length 4.
When you save the file, the charset defined will be used, whitespace at end of lines (if enable) will be removed. An empty new line will be created at the end of the file if not already present.

What isn't done

EditorConfig is not a linter, so the file won't be re-ordered, existing tab keys won't be replaced by spaces, or miss-aligned indentation won't be fixed.

EditorConfig is a list of parameters what will be read and used by your current IDE to format the text you are adding, and format the ouput file settings (charset, insert_final_newline).

Conclusion

EditorConfig is one step in the right direction to unified project files formatting

This does not replace a linter, for JSON file spectral could be a good choice.
Github Hook can be added to lint the JSON file:
https://meta.stoplight.io/docs/spectral/ecaa0fd8a950d-workflows#git-hooks

Since the "cleaning" of devicon.json file can lead to merge conflicts It's maybe a good idea to handle the open pull requests first, then when there is few pull requests still open, this PR can be merge to develop.

@Snailedlt Snailedlt requested review from a team, Snailedlt and Panquesito7 and removed request for a team August 12, 2022 15:07
Copy link
Collaborator

@Snailedlt Snailedlt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This is much needed!
Could only dind three lines that had bad indentation still.

Thanks for making this PR 🙇

devicon.json Outdated Show resolved Hide resolved
devicon.json Outdated Show resolved Hide resolved
Snailedlt
Snailedlt previously approved these changes Aug 13, 2022
Copy link
Collaborator

@Snailedlt Snailedlt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!
Thanks for your contribution, and a much needed feature 🚀

* update icon: clion (original, plain) - contributes to #1125

* clion| added original svg

* Update devicon.json

Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>

Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>
@Panquesito7 Panquesito7 added the devops Use this label for devops related enhancements label Aug 15, 2022
trim_trailing_whitespace = true

[**.svg]
trim_trailing_whitespace = false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we're missing an endline in here.

Suggested change
trim_trailing_whitespace = false
trim_trailing_whitespace = false

__
sema-logo  Summary: 🛠️ This code needs a fix  |  Tags: Inefficient

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The irony 😅
Did the exact same thing in another peoject, judt with prettier

kilianpaquier and others added 15 commits August 15, 2022 01:52
…1265)

* new icon: faunadb (original, original-wordmark) - fix #1262, #769

* faunadb| added line fonts
* replace code of conduct content with link to new wiki page

fix #1330

* Update CODE_OF_CONDUCT.md

* Update CODE_OF_CONDUCT.md

Co-authored-by: David Leal <halfpacho@gmail.com>

* Apply suggestions from code review

Co-authored-by: David Leal <halfpacho@gmail.com>
…ark) (#1323)

* Add Matplotlib icons

* edit alpinejs icons for icomoon

* optimize matplotlib plain icons
* update icon: webstorm (original, plain, plain-wordmark) - contributes to #1125

* webstorm | added original-wordmark
* update icon: rubymine (original, plain, plain-wordmark) - contributes to #1125

* rubymine | added original-wordmark
* update icon: pycharm (original, plain, plain-wordmark) - contributes to #1125

* pycharm | added original-wordmark
* update icon: rider (original, plain, plain-wordmark) - contributes to #1125

* rider | added original-wordmark
…rk) (#1227)

* new icon: hibernate (original, original-wordmark)

* hibernate| added plain, plain-wordmark versions

* hibernate| removed plain versions from svg

* hibernate| changed primary color from hibernate logo

* hibernate| optimize plain svg's

* hibernate| moved object in devicon.json

* Update devicon.json

Co-authored-by: David Leal <halfpacho@gmail.com>

Co-authored-by: David Leal <halfpacho@gmail.com>
* Add icons made by BenSouchet

* add to devicon.json (fix #1279)

* Add endline

Co-authored-by: David Leal <halfpacho@gmail.com>

* fix: `nano-original` icon

Co-authored-by: BenSouchet <contact@bensouchet.dev>
Co-authored-by: David Leal <halfpacho@gmail.com>
* bump npm version to v2.15.1

* feat: add neorg icon

* fix: rename neorg to norg

* fix: add proper orginal and plain versions

* fix: add altnames property in devicon.json

* fix: resize and optimize svg's

* fix: optimize original version of the svg

Co-authored-by: David Leal <halfpacho@gmail.com>

* fix: remove unnecessary height option from plain version

* fix: use most prevalent color from the original version for the primary color

Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>

* fix: add height option to plain version


Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>

* fix: make primary color lighter

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>
Co-authored-by: Amacado <clemens.bastian@gmail.com>
Co-authored-by: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: Jørgen Kalsnes Hagen <43886029+Snailedlt@users.noreply.github.com>
…1350)

* bump npm version to v2.15.1

* new icon: Astro

* Fix `plain-wordmark` filename

* Changed viewBox to 0 0 128 128

* Path merged for plain icons

* Removed Unnecessary `<g />`  tag

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>
Co-authored-by: Amacado <clemens.bastian@gmail.com>
Co-authored-by: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
@Snailedlt
Copy link
Collaborator

@BenSouchet I think all the PRs that were made before this one (except for stale ones) have been merges now. So feel free to rebase on develop, make the necessary changes and tag me and panquesito when you're done, so we can give a final review before mergin into develop :)

@BenSouchet BenSouchet closed this by deleting the head repository Aug 29, 2022
@BenSouchet
Copy link
Contributor Author

@Snailedlt Hi, due to too much conflicts and issues I decided to create a new branch and so a new PR, check #1364

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops Use this label for devops related enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants