dnrops
/
SwiftLint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add markdown local links to listed rules (#4762)

This commit is contained in:
Vasiliy Kattouf 2023-02-13 05:22:09 +07:00 committed by GitHub
parent b9e5cfb202
commit ad29864d7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -17,6 +17,9 @@
* None.
#### Enhancements
* Add local links to rule descriptions to every rule listed
in `Rule Directory.md`.
[kattouf](https://github.com/kattouf)
* Make forceExclude work with directly specified files.
[jimmya](https://github.com/jimmya)

6
Source/SwiftLintFramework/Documentation/RuleListDocumentation.swift
View File

@ -43,19 +43,19 @@ public struct RuleListDocumentation {
## Default Rules
\(defaultRuleDocumentations
.map { "* `\($0.ruleIdentifier)`: \($0.ruleName)" }
.map { "* [`\($0.ruleIdentifier)`](\($0.ruleIdentifier).md): \($0.ruleName)" }
.joined(separator: "\n"))
## Opt-In Rules
\(optInRuleDocumentations
.map { "* `\($0.ruleIdentifier)`: \($0.ruleName)" }
.map { "* [`\($0.ruleIdentifier)`](\($0.ruleIdentifier).md): \($0.ruleName)" }
.joined(separator: "\n"))
## Analyzer Rules
\(analyzerRuleDocumentations
.map { "* `\($0.ruleIdentifier)`: \($0.ruleName)" }
.map { "* [`\($0.ruleIdentifier)`](\($0.ruleIdentifier).md): \($0.ruleName)" }
.joined(separator: "\n"))
"""