-
Notifications
You must be signed in to change notification settings - Fork 3
[dmt] add docs linter #262
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Michail Sinelnikov <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
ldmonster
approved these changes
Sep 19, 2025
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Signed-off-by: Sinelnikov Michail <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New documentation linter (pkg/linters/docs):
The readme rule checks for the presence of README.md in the module.
The bilingual rule requires documentation in two languages:
README.md
andREADME_RU.md
(empty files are also caught as an error).Cyrillic-in-English rule - searches for Cyrillic characters in English .md files (without the _RU suffix).
Configuration:
Added documentation sections to
global.Linters
andLintersSettings
with support for impact, exclude-rules (lists of modules/files/directories), andbilingual.disable
. Merge impacts have been implemented. The rules and a YAML example are described inpkg/linters/docs/README.md
.Metrics and minor fixes:
metrics.SetLinterWarningsMetrics
now accepts*global.Global
.Test data:
Example modules have been added:
bad-cyrillic, bad-readme, good-module
, as well as cases intestdata/docs-test
andtest-config.yaml
to test the new rules.Now dmt can automatically check that the module has a README, that the documentation is bilingual, and that there is no Cyrillic in English files. All of this is configured via
linters-settings.documentation
and included in the metrics.Tests:
Add Minimocs
##Manual tests
good-module: OK
bad-readme:
bad-cyrillic:
all modules: