folx

// Under the hood Analyse uses the cloud.google.com/natural-language/ API for lexical analysis
// The GCP client expects to find a local environment variable that points to a valid GCP key file
// I.E. os.Setenv("GOOGLE_APPLICATION_CREDENTIALS", PathToYourGCPKeyFile)

// Analyse takes a string value for linting
source := "This is the source text to analyse using Folx."

// Analyse requires a style guide containing rules to evaluate during the linting process
// In this example we use the default RegexChecker which accepts a regex pattern
// Other types of rules and functions for loading from a YAML file are available in the style package
book := rule.Book{}
rule, err := book.NewCategorySet().NewRule(`(?i)\b(folx)\b`)
if err != nil {
	log.Fatalf("failed to create new rule %v", rule)
}

// Analyse() produces a report of the linting process with details on failed rules
// AnalyseWebPage() extracts visible text content from a given URL and return a report
// AnalyseWebSite() crawls a domain to extract articles, and returns a report for each page
report, err := Analyse(source, book)
if err != nil {
	log.Fatalf("failed to analyse source text %s", source)
}

fmt.Printf("Failed rule count: %v", report.FailedRules)

Output:

Failed rule count: 1