aim42 / htmlsanitycheck Goto Github PK

Standalone (batch- and command-line) and Gradle-plugin html sanity checker - detects missing images, dead links and cross-references, duplicate link targets (anchors) and the like.

License: Apache License 2.0

Groovy 53.83% Java 8.19% CSS 0.46% HTML 34.70% Shell 2.12% PowerShell 0.69%

arc42 gradle gradle-plugin groovy hacktoberfest hacktoberfest2021 html test

htmlsanitycheck's Introduction

Architecture Improvement Method

Software Evolution, Maintenance and Improvement - Done Right!

aim42 is collection of practices and patterns to support software evolution, maintenance, evolution and improvement of software systems.

aim42 divides change activities in three distinct phases:

analyze issues, risks, problems, symptoms and technical debt within software (and their organisations).
evaluate those issues, identify root-causes and remedies, prioritize.
improve by applying appropriate remedies, strategies and tactics.

aim42 has been founded by Gernot Starke, is supported by innoQ Deutschland GmbH and is licenced under the liberal Creative Commons Sharealike 4.0 licence.

Learn more

our project homepage gives an overview
the online method reference provides all (currently available) details (this is our main artifact - currently under intensive development). The method reference is automatically updated with every commit pushed to the central repository by Travis-CI.

Contribute

found mistakes or ommissions: create an issue
have ideas: fork the repository and create a pull request. You need a basic understanding of Git for this.
follow us on twitter

We write the content in AsciiDoc and build with Gradle.

As of September 2017, we removed the AsciiDoc help from the aim42 guide, you can find it here, under the arc42 organization.

Current Status

Repository Organization

Top-Level

(Original drawn with draw.io, source located in /graphics/meta/aim42-repo-structure.xml)

Graphics

Both diagrams created with (desktop-version of) draw.io, source located in /graphics/meta/aim42-repo-structure.xml)

htmlsanitycheck's People

Contributors

Stargazers

Watchers

Forkers

per-starke msgilligan double16 yukixueli semtle soukainafir joschi vogellacompany flheureux wdschei thc202 mrtbkts adaptavist matthiasbischof erdi mernst lormun shalom310 sciencewhiz stefri tikany lvliyu andreas-dispendix mverburg uniqueck luozebin86 feststelltaste oliva123456 codescale rosi2143 sumon-bs loverainye caijianfei rdmueller wolfsrudel ascheman jakobkogler joackimpennerup hofi1 janwesterkamp johthor ursulawoerz

htmlsanitycheck's Issues

aggregate multiple-occurences of broken internal links

in the current version, multiple occurences of broken internal links are reported multiple times, e.g.:

link target "Stakeholder-Interviews" missing
link target "Stakeholder-Interviews" missing
link target "Stakeholder-Interviews" missing

It would be nice to have an aggregated format, like

link target "Stakeholder-Interviews" missing (3 occurences)

"Missing Local Resources Checker" needs reference counter

the same missing resource is reported multiple times, e.g.:

local resource "api/griffon/core/env/Metadata.html" missing
local resource "api/griffon/core/env/Metadata.html" missing
local resource "api/griffon/core/env/Feature.html" missing
local resource "api/griffon/core/env/Feature.html" missing
local resource "api/griffon/core/env/Metadata.html" missing
local resource "api/griffon/core/env/Metadata.html" missing

Should better be:
local resource "api/griffon/core/env/Metadata.html" missing (reference count: 4)
local resource "api/griffon/core/env/Feature.html" missing (reference count: 2)

enhance broken-internal-links checker to include suggestions...

based upon StringSimilaritySearch - find 1-2 best-matches what "could have been meant"

"False Positives" in "local resources checker" (error in checker)

for example, checking the "Griffon Guide" reports the following false-positives

Missing Local Resources Check
157 anchor tag href attribute checked, 157 missing local resources found.

    local resource "api/griffon/core/mvc/MVCGroupManager.html" missing
    local resource "api/griffon/core/injection/Module.html" missing

create the GradlePlugin

although the main functionality is (more or less) working, the integration work to
make it a gradle plugin is still unfinished...

create travis.ylm continous integration configuration

see aim42 guide for an example

handle links to local html files in MissingLocalResourcesChecker

links to local html files, like

 <a href="apidoc/SpecialClass.html">SpecialClass</a>

shall NOT be treated as broken internal links, but the existance of the appropriate file
shall be checked... (by another checker?)

The current (0.2.0-SNAPSHOT) behavior is buggy, as it marks those links as "broken internal link".

Add checker for missing alt-tags in images

especially for external images (referenced via http, https, ftp or such).
For internal images, this might not be that important...

copy css/js resources from jar

references to (local) resources with anchors not recognized

currently is NOT recognized as valid link,
even if the file "localfile.html" is present.

Need to correct URL parsing for local resources...

Checker for unused image files

files present in image directory, but NOT referenced in image tags
(difficult, if several html-files refer to the same image directory)

streamline Spock specs by data-provider

some specs violate DRY - cleanup...

Idea: Use data-provider class, similar to
http://mrhaki.blogspot.de/2014/06/spocklight-write-our-own-data-provider.html

Document how to build the plugin, run tests and compile documentation

Could you please document the shell commands to

build the project
run all tests
compile documentation
?
I know, it should be a no brainer for people with gradle skills...

add filename and document-title to report

add description of build-stuff in arc42 documentation

plus update the readme.adoc

Malformed / Illegal ReferencesChecker

illegal characters in href or src attributes
malformed URL's in hyperlinks etc.

migrate html parser to jsoup 1.8.1

include changelog on website and in distribution

include ISO-25010 Quality Attribute Tree

plus reference/link to arc42 quality requirements examples

process windows file / path names in plugin...

currently plugin handles only forward-slashes...
windows paths are not taken into consideration

treat ssh:, telnet:, gopher: and other link formats

we need to discuss if those shall be checked or not...

0.8.0 dependency issue: jsoup-jar not referenced properly

The required jsoup dependencies are not configured properly...
gradlel dependencies
yields:

:dependencies

Root project

archives - Configuration for archive artifacts.
No dependencies

asciidoctor
--- org.asciidoctor:asciidoctorj:1.5.0
+--- org.slf4j:slf4j-api:1.7.5
+--- org.jruby:jruby-complete:1.7.9
--- com.beust:jcommander:1.32

default - Configuration for default artifacts.
No dependencies

BUILD SUCCESSFUL

upgrade build.gradle to SourceFileNames fileCollection

instead of single file...

Submit to Gradle Plugin portal

(proposed by @aalmiray)

Instructions are laid out at http://plugins.gradle.org/submit

Suggested values for the gradle-plugin attribute parts:

id: org.aim42.htmlsanitycheck
group: org.aim42
artifact: htmlsanitycheck-gradle-plugin

add js-based "scroll-to-top" button

differentiate user/developer and architecture documentation

imageChecker needs "String" as parameter for imageDir

currently it's implemented so that it creates filenames by concatenating img-src attributes
with the imageDir path (string)...

(could be refactored to use File instead... then it would need to convert the File
to an absolutePath... both ways would be perfect...)

test the plugin...

see asciidoctor-gradle plugin for details

differentiate between x-references and links-to-resources

rename "BrokenInternalLinksChecker" to "InternalCrossReferencesChecker"
(checking anchor-tags against id's)
create LocalLinksChecker, checking hrefs agains local files/resources

detect further variants of (remote) URLs

create html result output (file)

currently only console output is supported - pls enhance to generate proper html report (like junit does...)

"greenify" headers of successful test

in html report, color the header of successful tests in green (other checks are already painted in reddish...)

beautify output of multiple-definitions checker

currently it looks ugly:

Results for Duplicate Definition of id Check
378 id checked,
1 duplicate id found.

"Impact-Analysis" has multiple definitions:<h3 id="Impact-Analysis"><a class="anchor" ref="#Impact-    
Analysis"></a>5.10. <span class="pattern">Impact Analysis</span></h3>,<a id="Impact-Analysis"></a>

Maybe we count the occurences and report only the id's...:

"Impact-Analysis" is defined 2 times.

Introduce SinglePageResultsCollector (foundation for multi-page checking)

shall contain:

PageName (either filename)
PageTitle (from <title> attribute)

maybe further stats, like size, nr-of-links, nr-of-images

include gradle-license-plugin

for consistent license text in groovy sources:

https://github.com/hierynomus/license-gradle-plugin

treat mailto links: don't check...

mailto links shall be exempted from checks, as they don't require an internal link target.

include gradle encrypt plugin

to keep bintray upload api key secret...

1.) is every map referenced by at least one image?
2.) is every map-name referenced in an image present in the page?
3.) is every map-name unique?
4.) is at least one area-tag defined for every map?
5.) has every area-tag one non-empty href attribute?
6.) has every href a valid target (broken-links check)

Timeout Pattern for External Link Checker

Futures...

enhance HtmlPage/HtmlParser to getXYZ() specific href-types

e.g.:

getAllCrossReferenceHrefs()
getAllLocalResourceHrefs()
getAllExternalHyperlinkHrefs()