<commit_before>= render 'shared/header'

%main.content-doc
  %h2 Hound configuration (optional)

  %p
    By default, Hound uses #{link_to "thoughtbot's style guide", 'https://github.com/thoughtbot/guides/tree/master/style#ruby'}
    with no additional setup.

  %p
    Custom configuration of the style guide is entirely optional and is
    achieved by specifying rules in
    %em.code .hound.yml
    file.
  %p
    Hound uses #{link_to 'RuboCop v0.22.0', 'https://github.com/bbatsov/rubocop/tree/v0.22.0'} gem to
    handle the style checking. Thus, most of the RuboCop configuration, except
    inheritance, is supported in Hound as well.

  %p
    Hound will look for
    %em.code .hound.yml
    file in the root of the repo, and apply the custom configuration on top of the
    default configuration.

  %h3 Adding custom config
  %ol.numbered
    %li
      Add a file named
      %em.code .hound.yml
      to the root of your repo.
    %li
      Add your custom configuration to
      %em.code .hound.yml
      file.
      %p For example:
      %code.code-block
        :preserve
          LineLength:
            Description: 'Limit lines to 130 characters.'
            Max: 130

          StringLiterals:
            EnforcedStyle: single_quotes

          HashSyntax:
            EnforcedStyle: hash_rockets

          RedundantBegin:
            Enabled: false

      See #{link_to 'more config options', 'https://github.com/bbatsov/rubocop/blob/v0.22.0/config/enabled.yml'} in the RuboCop project.
    %li
      Commit the changes to your repo, and the following pull requests will use
      your custom configuration.<commit_msg>Add a configuration example for excluding files<commit_after>= render 'shared/header'

%main.content-doc
  %h2 Hound configuration (optional)

  %p
    By default, Hound uses #{link_to "thoughtbot's style guide", 'https://github.com/thoughtbot/guides/tree/master/style#ruby'}
    with no additional setup.

  %p
    Custom configuration of the style guide is entirely optional and is
    achieved by specifying rules in
    %em.code .hound.yml
    file.
  %p
    Hound uses #{link_to 'RuboCop v0.22.0', 'https://github.com/bbatsov/rubocop/tree/v0.22.0'} gem to
    handle the style checking. Thus, most of the RuboCop configuration, except
    inheritance, is supported in Hound as well.

  %p
    Hound will look for
    %em.code .hound.yml
    file in the root of the repo, and apply the custom configuration on top of the
    default configuration.

  %h3 Adding custom config
  %ol.numbered
    %li
      Add a file named
      %em.code .hound.yml
      to the root of your repo.
    %li
      Add your custom configuration to
      %em.code .hound.yml
      file.
      %p For example:
      %code.code-block
        :preserve
          AllCops:
            Exclude:
              - config/initializers/third_party.rb

          LineLength:
            Description: 'Limit lines to 130 characters.'
            Max: 130

          StringLiterals:
            EnforcedStyle: single_quotes

          HashSyntax:
            EnforcedStyle: hash_rockets

          RedundantBegin:
            Enabled: false

      See #{link_to 'more config options', 'https://github.com/bbatsov/rubocop/blob/v0.22.0/config/enabled.yml'} in the RuboCop project.
    %li
      Commit the changes to your repo, and the following pull requests will use
      your custom configuration.
{'fraction_non_alphanumeric': 0.07917888563049853, 'fraction_numerical': 0.011730205278592375, 'mean_word_length': 2.3052325581395348, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3617009', 'n_tokens_mistral': 1054, 'n_tokens_neox': 991, 'n_words': 350}