Skip to content
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

Linting Updates (Removed Vale, Added Prettier, MarkdownLinter, ESLint) #83

Merged
merged 10 commits into from
May 30, 2024

Conversation

sifex
Copy link
Collaborator

@sifex sifex commented May 30, 2024

Context

This updates Sigma docs with 3x linting & formatting programs to help us reach a more opinionated clean state for Sigma docs.

  • Adds linting as a required step in .github/workflows
  • Adds the following linters / formatters and their reason
    • ESLint – to handle JS / Vue code best-practices
    • MarkdownLinter CLI v2 – to handle correct structure of Markdown documents
    • Prettier – mostly to handle tailwind class ordering and HTML / Markdown formatting
  • Removes Vale as it wasn't really used.

@sifex sifex merged commit e2b5c1d into SigmaHQ:main May 30, 2024
2 checks passed
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 this pull request may close these issues.

1 participant