Skip to content

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

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

Open
NStefan002 opened this issue May 14, 2025 · 1 comment · May be fixed by #473
Open

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

NStefan002 opened this issue May 14, 2025 · 1 comment · May be fixed by #473

Comments

@NStefan002
Copy link

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.

@Ryuno-Ki
Copy link
Contributor

Would be great to have next to luacheck:

uses: nebularg/actions-luacheck@v1.1.0

@NStefan002 NStefan002 linked a pull request May 19, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants