[pgAdmin4][Patch]: Using editorconfig to maintain consistent codingstyles between different IDE's - Mailing list pgadmin-hackers

From Surinder Kumar
Subject [pgAdmin4][Patch]: Using editorconfig to maintain consistent codingstyles between different IDE's
Date
Msg-id CAM5-9D-aRQ5iSavQjeHm2_TmV_-eyQQwcEGm2RuvtaYj1m5ZHg@mail.gmail.com
Whole thread Raw
Responses Re: [pgAdmin4][Patch]: Using editorconfig to maintain consistentcoding styles between different IDE's
List pgadmin-hackers
Hi All,

In pgAdmin4 codebase, the coding styles at many places is inconsistent, in some files standard coding conventions are followed and in some not.

It is difficult to take care of 'tabs', 'spaces', 'trailing white-spaces', 'max_line_length' while development. 

So adding .editorconfig to pgAdmin4 will make development easier and will help in faster patch review.

Added a `.editorconfig` file where all coding styles followed in pgAdmin4 are added, and most of editors/IDE reads this file and follows the rules while development.

For PyCharm editor, there is no additional configuration or settings required. it reads .editorconfig.
For Vim editor - developer has to install plugin available.

List of editors supporting `.editorconfig`

Also, there is a NPM plugin eclint available which fixes files automatically and do other tasks as well, for example:

Running following command on terminal fixes issues related to tabs, trailing whitespaces in existing files:

./node_modules/eclint/bin/eclint.js fix pgadmin/static/css/bootstrap.overrides.css

If i missed any rule, please let me know
​ i will add.​


Please find attached patch and review.

Thanks,
Surinder







Attachment

pgadmin-hackers by date:

Previous
From: Surinder Kumar
Date:
Subject: Re: [pgAdmin4][Patch]: Stop Flask from initialising service twice inDebug mode
Next
From: Murtuza Zabuawala
Date:
Subject: Re: [pgAdmin4][Patch]: Allow user to Comment/Uncomment code in query editor