Skip to content

Add an .editorconfig file to all SymbiFlow repositories #50

New issue
New issue
Open
Open
Add an .editorconfig file to all SymbiFlow repositories#50
@mithro

Description

@mithro
mithro
opened on Apr 30, 2020 · edited by mithro
Contributor

.editorconfig is a file which tells many editors how to set up their auto formatting configurations. See this example in the Yosys repository -> https://github.com/YosysHQ/yosys/blob/master/.editorconfig

We should create an .editorconfig for SymbiFlow projects and then add it to all our repositories.

We probably need a configurations for;

  • Python files
    C++ files
    TCL scripts
    Bash scripts
    Makefiles
    cmake files
    Verilog files
    Exclude third_party directory

For Python files, it should match what .yapf settings we are using.
For C++ files it should match the Google C++ Style Guide.
For Verilog files it should match the LowRISC Verilog Style Guide.

What else have I missed?

Activity

mithro

mithro commented on Apr 30, 2020

@mithro
mithro
on Apr 30, 2020
ContributorAuthor
; EditorConfig is awesome: http://EditorConfig.org
; At this time of writing, EditorConfig plugins are currently available for:
;
;     Code::Blocks
;     Emacs
;     Geany
;     Gedit
;     jEdit
;     Notepad++
;     Sublime Text 2
;     TextMate
;     Vim
;     Visual Studio
mithro
mentioned this on Apr 30, 2020
FFY00

FFY00 commented on Apr 30, 2020

@FFY00
FFY00
on Apr 30, 2020

editorconfig is very limited when it comes to language support, it mostly just allows you to configure the identation and some minor styling preferences.

I think it should be used unless there are better language specific alternatives. Python has flake8, C/C++ has clang-format, I am not sure about the other languages.

mithro

mithro commented on Apr 30, 2020

@mithro
mithro
on Apr 30, 2020
ContributorAuthor

@FFY00 - This is more about providing the editor with hints on things like indenting that are consistent with what the formatting tools do. We don't want a person's editor and the code formatting tools fighting.

FFY00

FFY00 commented on Apr 30, 2020

@FFY00
FFY00
on Apr 30, 2020 · edited by FFY00

Well, flake8 is not really the same thing, but clang-format can be used as a C/C++ specific editorconfig, but yes, it can also be used as a formatter. Anyway, as long as .editorconfig and the language specific tools are in sync there is no issue in providing it, it is still a good addition :)

xanjohns
mentioned this on Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @mithro@FFY00

        Issue actions
          Add an .editorconfig file to all SymbiFlow repositories · Issue #50 · f4pga/ideas