From 052b21227b31b300a761bc433e8ce8cab8d141dc Mon Sep 17 00:00:00 2001 From: InSyncWithFoo Date: Sat, 18 Jan 2025 00:13:11 +0000 Subject: [PATCH 1/3] Generate documentation redirects for lowercase rule codes --- scripts/generate_mkdocs.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/scripts/generate_mkdocs.py b/scripts/generate_mkdocs.py index a90d85b7fdaad..cf75aeb93df78 100644 --- a/scripts/generate_mkdocs.py +++ b/scripts/generate_mkdocs.py @@ -8,6 +8,7 @@ import shutil import subprocess from collections.abc import Sequence +from itertools import chain from pathlib import Path from typing import NamedTuple @@ -40,7 +41,8 @@ class Section(NamedTuple): Section("Setup", "editors/setup.md", generated=False), Section("Features", "editors/features.md", generated=False), Section("Settings", "editors/settings.md", generated=False), - Section("Migrating from ruff-lsp", "editors/migration.md", generated=False), + Section("Migrating from ruff-lsp", + "editors/migration.md", generated=False), ], ), Section("Configuring Ruff", "configuration.md", generated=False), @@ -257,10 +259,16 @@ def main() -> None: config["plugins"].append( { "redirects": { - "redirect_maps": { - f"rules/{rule['code']}.md": f"rules/{rule['name']}.md" - for rule in rules - }, + "redirect_maps": dict( + chain.from_iterable( + [ + (f"rules/{rule['code']}.md", + f"rules/{rule['name']}.md"), + (f"rules/{rule['code'].lower()}.md", + f"rules/{rule['name']}.md"), + ] for rule in rules + ) + ), }, }, ) From f0c139ef0452a7ab891d87d3aeb19c9aca7e34c8 Mon Sep 17 00:00:00 2001 From: InSync Date: Sat, 18 Jan 2025 07:58:59 +0700 Subject: [PATCH 2/3] Formatting --- scripts/generate_mkdocs.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/generate_mkdocs.py b/scripts/generate_mkdocs.py index cf75aeb93df78..e5152679e3870 100644 --- a/scripts/generate_mkdocs.py +++ b/scripts/generate_mkdocs.py @@ -41,8 +41,7 @@ class Section(NamedTuple): Section("Setup", "editors/setup.md", generated=False), Section("Features", "editors/features.md", generated=False), Section("Settings", "editors/settings.md", generated=False), - Section("Migrating from ruff-lsp", - "editors/migration.md", generated=False), + Section("Migrating from ruff-lsp", "editors/migration.md", generated=False), ], ), Section("Configuring Ruff", "configuration.md", generated=False), @@ -262,10 +261,11 @@ def main() -> None: "redirect_maps": dict( chain.from_iterable( [ - (f"rules/{rule['code']}.md", - f"rules/{rule['name']}.md"), - (f"rules/{rule['code'].lower()}.md", - f"rules/{rule['name']}.md"), + (f"rules/{rule['code']}.md", f"rules/{rule['name']}.md"), + ( + f"rules/{rule['code'].lower()}.md", + f"rules/{rule['name']}.md" + ), ] for rule in rules ) ), From fc7d291fd8cc37f5b66a6f736f66fbd2095afcea Mon Sep 17 00:00:00 2001 From: InSync Date: Sat, 18 Jan 2025 08:11:23 +0700 Subject: [PATCH 3/3] Formatting --- scripts/generate_mkdocs.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scripts/generate_mkdocs.py b/scripts/generate_mkdocs.py index e5152679e3870..54e224cd66df6 100644 --- a/scripts/generate_mkdocs.py +++ b/scripts/generate_mkdocs.py @@ -264,9 +264,10 @@ def main() -> None: (f"rules/{rule['code']}.md", f"rules/{rule['name']}.md"), ( f"rules/{rule['code'].lower()}.md", - f"rules/{rule['name']}.md" + f"rules/{rule['name']}.md", ), - ] for rule in rules + ] + for rule in rules ) ), },