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.

Sign up for GitHub

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

style(format): lint markdown #1131

Merged
merged 6 commits into from
Aug 3, 2024
Merged

style(format): lint markdown #1131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56d2038
chore: Fix line endings for changelog
joshka May 24, 2024
ee80098
chore: cleanup markdown lints
joshka May 24, 2024
41e1e89
ci: add Markdown linter
joshka May 24, 2024
4ed4225
build: add markdown lint to the makefile
joshka May 24, 2024
4e0311b
fix: move lint comments below notable changes
joshka May 24, 2024
7e2aab5
Merge branch 'main' into jm/markdown-lint
orhun Aug 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,17 @@ jobs:
- uses: Swatinem/rust-cache@v2
- run: cargo make clippy

markdownlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Lint markdown
uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: |
'**/*.md'
'!target'

coverage:
runs-on: ubuntu-latest
steps:
Expand Down
13 changes: 9 additions & 4 deletions Makefile.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ alias = "ci"

[tasks.ci]
description = "Run continuous integration tasks"
dependencies = ["lint-style", "clippy", "check", "test"]
dependencies = ["lint", "clippy", "check", "test"]

[tasks.lint-style]
description = "Lint code style (formatting, typos, docs)"
dependencies = ["lint-format", "lint-typos", "lint-docs"]
[tasks.lint]
description = "Lint code style (formatting, typos, docs, markdown)"
dependencies = ["lint-format", "lint-typos", "lint-docs", "lint-markdown"]

[tasks.lint-format]
description = "Lint code formatting"
Expand Down Expand Up @@ -56,6 +56,11 @@ args = [
"-Dwarnings",
]

[tasks.lint-markdown]
description = "Check markdown files for errors and warnings"
command = "markdownlint-cli2"
args = ["**/*.md", "!target"]

[tasks.check]
description = "Check code for errors and warnings"
command = "cargo"
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ We only support the latest version of this crate.

## Reporting a Vulnerability

To report secuirity vulnerability, please use the form at https://github.com/ratatui-org/ratatui/security/advisories/new
To report secuirity vulnerability, please use the form at <https://github.com/ratatui-org/ratatui/security/advisories/new>
2 changes: 2 additions & 0 deletions cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ header = """
# Changelog

All notable changes to this project will be documented in this file.
<!-- ignore lint rules that are often triggered by content generated from commits / git-cliff -->
<!-- markdownlint-disable line-length no-bare-urls ul-style emphasis-style -->
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
Expand Down