Skip to content

[suggestion] Introduce consistent code cormatting (stylua, markdownlint, prettier) #472

Open
@NStefan002

Description

@NStefan002

Hi,

First of all, thank you for the great work on this project.

I'd like to propose introducing standard formatting tools. This will make contributing and maintaining easier.

Since all of the functionality of this project is in the Lua files, and all of the documentation is in the Markdown files, we would only need a couple of configuration files:

  • .stylua.toml for Lua formatting
  • .markdownlint.toml for Markdown style consistency
  • .prettierrc for formatting Markdown files

If you're open to it, I’d be happy to open a PR that adds these configuration files, and also a CONTRIBUTING.md file that would give a short note to maintainers/new contributors about how to use these tools. Also, I could add GitHub actions to check formatting on every push and pr.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions