Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[CleanRepo]: Images for image hyperlinks flagged as orphans

Open
  • Is something wrong?
#396 1 comment 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@gewarren is already working on this.

Since Dec 3, 2024.

Assessment

This issue has not been assessed yet.

Description

Clean Repo seems to be flagging images incorrectly as orphaned for image hyperlinks. The image used to display for the image hyperlink is fine but in the case of an image hyperlink, the resulting image the hyperlink retrieves on a click is determined to be orphaned in the report.

Severity:
In the old aspnetdocs repo we had over 3000 image hyperlinks which Clean Repo flagged incorrectly as orphaned. However, I don't think image hyperlinks are used as much like this in other repos,

It used to be years ago, that two images were provided for screenshot image hyperlinks for our docs. One larger and one smaller and the smaller one was used as the link itself. Clicking on the screenshot or whatever the image was of, resulted in a larger version of the image being retrieved and displayed.

Recreating the issue:

  • Run the latest version of Clean Repo available today 8/20/24 in release mode.
  • Run the option for orphaned images:
    CleanRepo.exe --orphaned-images
  • Provide the details for a local cloned copy of the aspnetdocs repo.
  • Specify to not delete the images to get the report of orphaned images that incorrectly includes images referred to by image hyperlinks. (Also choosing to delete images results in incorrectly deleting images that should not be deleted.)

Results:
The list of images returned as orphaned will include the image from the image link used for the full image that is returned when the link is clicked.

Example:
In a link like the following, external-authentication-services/_static/image25.png would be determined incorrectly to be orphaned:
[![Image displaying default Facebook home page](external-authentication-services/_static/image26.png "Click to Expand the Image")](external-authentication-services/_static/image25.png)

This example image link can be found in this .md article example [here].https://raw.githubusercontent.com/dotnet/AspNetDocs/main/aspnet/web-api/overview/security/external-authentication-services.md)

It does not matter if tooltip text exists in the hyperlink or not. Same incorrect results.

Some helpful regex that could be used to find these cases:
In case you were interested here is regex I used to find examples of image hyperlinks with or without tooltip text in them:

Find image hyperlinks with tooltip text not in them:
\[!\[.*?\]\(.*?\)\]\(.*?\)

Find image hyperlinks with tooltip text in them:
\[!\[.*?".*?"\)\]\(.*?\)

Dominant language
C#
Stars
27
Forks
43
Avg merge
14h 7m
Merged PRs (30d)
30

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/docs-tools

All issues in dotnet/docs-tools

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.