New Rule to find orphan files #706
Open
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
trunneml
force-pushed
the
rule51-unused-assets
branch
from
438b0db to
722d5aa
Compare
damrath
force-pushed
the
rule51-unused-assets
branch
from
722d5aa to
d06f4a7
Compare
trunneml
force-pushed
the
rule51-unused-assets
branch
from
437a322 to
f426f69
Compare
trunneml
force-pushed
the
rule51-unused-assets
branch
from
f426f69 to
8fde409
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This Pull Request introduces a new rule that identifies orphan files within a specified folder. These orphan files are assets that are no longer referenced in any scanned Markdown file, contributing to clutter in the documentation directory.
Changes Made
To achieve this, a new method has been added to the plugin_manager that is triggered after all files are scanned. This method triggers the plugin that then identifies assets within the specified folder that are not referenced, allowing for their removal.
Reasoning
By implementing this rule and introducing the new method in the plugin_manager, we can proactively clean up the documentation directory by identifying and removing orphan files. This contributes to improved organization and maintainability of the project. The rule helps ensure that only relevant and referenced assets are present, reducing confusion and clutter for developers and contributors.