Profanity Detection Rule

This rule enforces a professional writing environment by detecting and flagging common profanity and vulgar language. The rule is important because maintaining professional and respectful language is crucial in business, technical, and formal documentation. Inappropriate language can damage credibility, offend readers, and create an unprofessional impression.

Examples:

  • Will flag:

    • Common curse words and vulgar terms
    • Both uppercase and lowercase variants (due to ignorecase: true)
    • Profanity used in any context within the text
  • For instance, if a document contains the word "shit", the rule will trigger with the message "Consider replacing 'shit'."

Note: Due to the nature of this rule's content, I've kept the specific examples minimal while maintaining clarity about the rule's function.

Rule Source

This rule comes from: https://github.com/mesosphere/dcos-docs-site

Rule Definition

extends: existence
message: "Consider replacing '%s'."
level: error
ignorecase: true
tokens:
  - shit
  - piss
  - fuck
  - cunt
  - cocksucker
  - motherfucker
  - tits
  - fart
  - turd
  - twat