package htmlcheck

Import Path
	golang.org/x/pkgsite/internal/testing/htmlcheck (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package


Involved Source Files

	
		Package htmlcheck provides a set of functions that check for properties
		of a parsed HTML document.


Package-Level Type Names (only one, which is exported)


	/* sort exporteds by:  |  */
	
		A Checker is a function from an HTML node to an error describing a failure.

		
			func Dump() Checker
			func HasAttr(name, wantValRegexp string) Checker
			func HasExactText(want string) Checker
			func HasExactTextCollapsed(want string) Checker
			func HasHref(val string) Checker
			func HasText(wantRegexp string) Checker
			func In(selector string, checkers ...Checker) Checker
			func InAll(selector string, checkers ...Checker) Checker
			func NotIn(selector string) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.CanonicalURLPath(path string) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.LicenseDetails(ltype, bodySubstring, source string) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.SubdirectoriesDetails(firstHref, firstText string) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.UnitDirectories(firstHref, firstText string) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.UnitDoc() Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.UnitHeader(p *pagecheck.Page, versionedURL bool, isPackage bool) Checker
			func golang.org/x/pkgsite/internal/testing/pagecheck.UnitReadme() Checker
			
		
			func In(selector string, checkers ...Checker) Checker
			func InAll(selector string, checkers ...Checker) Checker
			func Run(reader io.Reader, checker Checker) error
			




Package-Level Functions (total 15, in which 10 are exported)


	
		Dump returns a Checker that always returns nil, and as a side-effect writes a
		human-readable description of n's subtree to standard output. It is useful
		for debugging.


	
		HasAttr returns a Checker that checks for an attribute with the given name whose
		value matches the given regular expression.
		HasAttr panics if wantValRegexp does not compile.


	
		HasExactText returns a checker that checks whether the given string matches
		the node's text exactly.


	
		HasExactTextCollapsed returns a checker that checks whether the given string
		matches the node's text with its leading, trailing, and redundant whitespace
		trimmed.


	
		HasHref returns a Checker that checks whether the node has an "href"
		attribute with exactly val.


	
		HasText returns a Checker that checks whether the given regexp matches the node's text.
		The text of a node n is the concatenated contents of all text nodes in n's subtree.
		HasText panics if the argument doesn't compile.


	
		In returns a Checker that applies the given checkers to the first node
		matching the CSS selector. The empty selector denotes the entire subtree of
		the Checker's argument node.

		Calling In(selector), with no checkers, just checks for the presence of
		a node matching the selector. (For the negation, see NotIn.)

		A nil Checker is valid and always succeeds.


	
		InAll runs the checkers against all nodes matching selector.


	
		NotIn returns a checker that succeeds only if no nodes match selector.


	
		Run is a convenience function to run the checker against HTML read from
		reader.