content-style is a tool to help lint your HTML files for content style violations.

• Ruby 2.2.0+ (Runtime)
• Ruby 2.3.0+ (Development)

• This is due to the use of the tilde-heredoc <<~ syntax in some tests.

• If working with erb content, Hotcop
  • Install hotcop in the repo you want to test.
  • Run your integration tests (bundle exec rake spec) to generate HTML files in test/html.
  • (Generating html files with hotcop is required because nokogiri can’t handle parsing complex html.erb files.)

Add the following to your gemfile and run bundle install:

gem 'content-style', git: 'https://github.com/jeremyhansonfinger/content-style'

You may run into problems installing nokogiri because it's the worst. If the install fails, try this resource or google nokogiri won't install because lots of people have the same problem.

The configuration comes from a content-style.yml file located in the config folder of your repo:

---

ContentStyle:
  enabled: true
  filetype: 'html'
  csv: true
  exceptions:
    - 'manual change'
  excluded_html_files:
    - 'test/html/worst-file-ever.html'
  excluded_source_folders:
    - 'app/worst'
  addendum: 'Questions? Keep them to yourself.' 
  rule_set:
    - violation:
        - 'dropdown'
        - 'drop down'
      case_insensitive: true
      suggestion: 'drop-down'

content-style will find any words or phrases that violate the rule set that you provide.

This rule_set is specified as a list of rules, each with a violation set and a corresponding suggestion. Optionally, you can also add a case_insensitive: true value to make content-style ignore case when searching for violations. If your violation is a regex pattern, you can add a pattern_description string to replace the pattern in the error message.

rule_set:
    - violation:
        - 'application'
        - 'program'
      case_insensitive: true
      suggestion: 'app'

    - violation:
        - 'support page'
      suggestion: 'Lintercorp Help Center'

    - violation:
        - 'customer'
      suggestion: 'merchant'
      case_insensitive: true
      context: '`Customer` is reserved for the people that purchase products from merchants'


    - violation: '\d+ ?(—|-) ?\d+'
      suggestion: '— (en dash) in number ranges'
      pattern_description: '- (hyphen) or — (em dash) in number ranges'

You can also specify an addendum to be added to the end of the list of errors using the addendum option.

For simple errors without contexts, the error message format is:

["#{path_to_html_file}", #{violation_line_number_in_html_file, "#{violating text}", "Don't use #{violation}. Do use #{suggestion}", "#{path_to_source_file_if_available}"]

When a context is provided in the rule, the error message format is instead:

["#{path_to_html_file}", #{violation_line_number_in_html_file, "#{violating text}", "Double check that `#{violation}` isn't used in place of `#{suggestion}`. #{context}.", "#{path_to_source_file_if_available}"]

Define contexts for rules that could pop false positives.

Once content-style is installed and configured, running the following command in your shell:

bundle exec content-style relative/or/absolute/path/to/your/html/files

results in lines such as these being written to stdout:

["test/html/test001.html", 62, "The application is great!", "Don't use `application`. Do use `app`", "app/views/dashboard.html.erb"]
["test/html/test002.html", 102, "Click on the drop down menu.", "Don't use `drop down`. Do use `dropdown`", "app/views/help.html.erb"]
Questions? Contact the Professional Standards team.

If you enabled csv, then you'll also see a line that says:

CSV of results is located at test/html/content-style-output.csv

To run tests:

1. run bundle install to install rspec

2. bundle exec rspec spec to run the test suite.

This project is released under the MIT license.