Giter Club home page Giter Club logo

htmlsanitycheck's Introduction

Html-SC Html Sanity Check

This project provides some basic sanity checking on html files.

It can be helpful in case of html generated from e.g. Asciidoctor, Markdown or other formats - as converters usually don’t check for missing images or broken links.

It can be used as Gradle plugin. Standalone Java and graphical UI are planned for future releases.

https://waffle.io/aim42/htmlsanitycheck License ccsa4 green Build Status

Installation

Use the following snippet inside a Gradle build file:

build.gradle
plugins {
  id 'org.aim42.htmlSanityCheck' version '0.9.7'
}

OR

build.gradle
buildscript {
    repositories {
        maven {
              url "https://plugins.gradle.org/m2/"
            }
    }

    dependencies {
        classpath ('gradle.plugin.org.aim42:htmlSanityCheck:0.9.7')
    }
}

apply plugin: 'org.aim42.htmlSanityCheck'

Usage

The plugin adds a new task named htmlSanityCheck.

This task exposes a few properties as part of its configuration:

sourceDir

(mandatory) directory where the html files are located. Type: File. Default: build/docs.

sourceDocuments

(optional) an override to process several source files, which may be a subset of all files available in ${sourceDir}. Type: Set. Defaults to all files in ${sourceDir}.

checkingResultsDir

(optional) directory where the checking results written to. Defaults to ${buildDir}/report/htmlchecks/

junitResultsDir

(optional) directory where the results written to in JUnit XML format. JUnit XML can be read by many tools including CI environments. Defaults to ${buildDir}/test-results/htmlchecks/

failOnErrors

(optional) if set to "true", the build will fail if any error was found in the checked pages. Defaults to false

checkExternalLinks

(optional, planned) if set to "true", external references are checked too. Defaults to false (currently not implemented)

Examples

build.gradle (small example)
apply plugin: 'org.aim42.htmlSanityCheck'

htmlSanityCheck {
    sourceDir = new File( "$buildDir/docs" )

    // files to check - in Set-notation
    sourceDocuments = [ "one-file.html", "another-file.html", "index.html"]

    // where to put results of sanityChecks...
    checkingResultsDir = new File( "$buildDir/report/htmlchecks" )
    checkExternalLinks = false

    // fail build on errors?
    failOnErrors = true
}
build.gradle (extensive example)
buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
        jcenter()
    }

    dependencies {
        classpath (group: 'gradle.plugin.org.aim42',
                name: 'htmlSanityCheck',
                version: '0.9.7')

        classpath (group: 'org.asciidoctor',
                    name: 'asciidoctor-gradle-plugin',
                    version: '1.5.3')
    }
}

// ==== path definitions =====
// ===========================

// location of AsciiDoc files
def asciidocSrcPath = "$projectDir/src/asciidoc"

// location of images used in AsciiDoc documentation
def srcImagesPath = "$asciidocSrcPath/images"

// results of asciidoc compilation (HTML)
// (input for htmlSanityCheck)
// this is the default path for asciidoc-gradle-convert
def htmlOutputPath = "$buildDir/asciidoc/html5"

// images used by generated html
def targetImagesPath =   htmlOutputPath + "/images"

// where HTMLSanityCheck checking results ares stored
def checkingResultsPath = "$buildDir/report/htmlchecks"



apply plugin: 'org.asciidoctor.convert'

asciidoctor {
    sourceDir = new File( asciidocSrcPath )

    options backends: ['html5'],
            doctype: 'book',
            icons: 'font',
            sectlink: true,
            sectanchors: true

    resources {
        from( srcImagesPath )
        into targetImagesPath
    }


}

apply plugin: 'org.aim42.htmlSanityCheck'


htmlSanityCheck {

    // ensure asciidoctor->html runs first
    // and images are copied to build directory

    dependsOn asciidoctor

    sourceDir = new File( htmlOutputPath )

    // files to check, in Set-notation
    sourceDocuments = [ "many-errors.html", "no-errors.html"]

    // where to put results of sanityChecks...
    checkingResultsDir = new File( checkingResultsPath )

    // false: restrict checks to local resources
    // true:  also check external (e.g. http, https...) links.
    checkExternalLinks = false
}

Typical Output

The overall goal is to create neat and clear reports, showing evantual errors within HTML files - as shown in the adjoining figure.

sample hsc report

Types of Sanity Checks

Finds all '<a href="XYZ">' where XYZ is not defined.

src/broken.html
<a href="#missing>internal anchor</a>
...
<h2 id="missinG">Bookmark-Header</h2>

In this example, the bookmark is misspelled.

Missing Images Files

Images, referenced in '<img src="XYZ"…​' tags, refer to external files. The existence of these files is checked by the plugin.

Multiple Definitions of Bookmarks or ID’s

If any is defined more than once, any anchor linking to it will be confused :-)

Missing Local Resources

All files (e.g. downloads) referenced from html.

Missing Alt-tags in Images

Image-tags should contain an alt-attribute that the browser displays when the original image file cannot be found or cannot be rendered. Having alt-attributes is good and defensive style.

planned

Although external links might suffer from network issues or site maintenance, checks are still possible…​

Technical Documentation

In addition to checking HTML, this project serves as an example for arc42.

Fundamentals

This tiny piece rests on incredible groundwork:

  • Jsoup HTML parser and analysis toolkit - robust and easy-to-use.

  • IntelliJ IDEA - my (Gernot) best (programming) friend.

  • Of course, Groovy, Gradle, JUnit and Spockframework.

Ideas and Origin

  • The plugin heavily relies on code provided by the Gradle project.

  • Inspiration on code organization, implementation and testing of the plugin came from the Asciidoctor-Gradle-Plugin by [@AAlmiray].

  • Code for string similarity calculation by Ralph Rice.

  • Initial implementation, maintenance and documentation by Gernot Starke.

Development

Several sources provided help during development:

Contributing

Please report issues or suggestions.

Want to improve the plugin: Fork our repository and send a pull request.

Licence

Currently code is published under the Apache-2.0 licence, documentation under Creative-Commons-Sharealike-4.0.

Some day I’ll unify that :-)

Big thanx to Structure-101 for helping us analyze and restructure our code…​

structure101 logo

htmlsanitycheck's People

Contributors

double16 avatar gernotstarke avatar joschi avatar mauk81 avatar rdmueller avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.