[cosmetic] is it a good idea to add autoformatting for Espruino source code?

[ponyatov]

I personally use code autoformatting in all projects:

• clang-format for C/C++ code
• prettier for JS/JSON
• autopep8 for Python scripts

Autoformatting makes code a bit cleaner and easier to read, so maybe it will be good idea to integrate it into the Espruino build process?

.clang-format

BasedOnStyle: Google
IndentWidth:  2
TabWidth:     2
UseTab:       Never
ColumnLimit:  80
UseCRLF:      false

SortIncludes: true

AllowShortBlocksOnASingleLine: Always
AllowShortFunctionsOnASingleLine: All

.prettierrc

{
    "tabWidth"    : 2,
    "useTabs"     : false,
    "endOfLine"   : "lf",
    "singleQuote" : true,
    "semi"        : true,
    "printWidth"  : 80
}

`.vscode/settings.json

    // Python
    "autopep8.args": ["--ignore E26,E302,E305,E401,E402,E701,E702"],
    "[python]": {
        "editor.defaultFormatter": "ms-python.autopep8",
        "editor.formatOnSave"    :  false
    },
    "python.analysis.extraPaths": ["./scripts"],

[gfwilliams]

People have asked this before, but I feel like we've done ok in the past 10+ years and we haven't had huge problems with code style being different. The reality is very few people contribute code back, and those that do seem to be fine with copying the way things are now. We also include other code (like ST/Nordic APIs) that has its own style that we'd have to try and manually exclude.

It feels like you're using indent/tab widths of 4 when Espruino uses 2 (see https://github.com/espruino/Espruino/blob/master/CONTRIBUTING.md#coding-style) and maybe some other things. Could it be you're finding the code isn't formatted properly because you're expecting it to be different to what it actually is?

[ponyatov]

I fixed tab size for 2 spaces, other options corresponds to coding style looks like.

Maybe someone can recommend some syntax/format linters can check style using specification on .dotfiles resides in a project root?

In this case these format/spec files can be added, but format-on-save should be disabled in IDE configuration to not break all code automatically 8)

[ponyatov]

Just tested Ruff linter for Python, and looks good:

• highlights problems in code, such as ; at end of lines etc
• works fast

install

https://docs.astral.sh/ruff/installation/

.vscode/extensions.json

        // Python
        "ms-python.python",
        "ms-python.autopep8",
        "charliermarsh.ruff",

.vscode/settings.json

    // Python
    "autopep8.path"                : ["autopep8"],
    "autopep8.args"                : ["--ignore","E26,E302,E305,E401,E402,E701,E702"],
    "python.analysis.extraPaths"   : ["${workspaceFolder}/scripts"],
    "[python]": { "editor.defaultFormatter" : "ms-python.autopep8" },
    // "ruff.configuration": ".ruff.toml",

.ruff.toml

line-length    = 80
indent-width   = 2
target-version = "py310"

ignore = ["E701"]

select = ["E", "F"]

exclude = [
    ".git",
    "ref",
    "__pycache__",
    "*.pyi",       # Stub files
    "migrations",  # Django migrations
]

[format]
quote-style  = "double"
indent-style = "space"