Sha256: 37f99cadd813c1857933f26fe6c06a16b584ceba0f6ecaf324aa0385b0e115a7

Contents?: true

Size: 818 Bytes

Versions: 10

Compression:

Stored size: 818 Bytes

Contents

module Appium
  class Lint
    ###
    # h1 must use the `#` syntax and not the `===` underline syntax.
    # check for three = to reduce false positives
    class H1Invalid < Base
      def call
        # === is always a h1 regardless of previous line
        input.lines.each_with_index do |line, index|
          h1_invalid = !!line.match(/^===+\s*$/)
          warn index if h1_invalid
        end

        warnings
      end

      FAIL = 'h1 must not use === underline syntax. Use # instead'

      def fail
        FAIL
      end
    end
  end
end

=begin
md = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
> md.render("hi\n=")
=> "<h1>hi</h1>\n"
> md.render("hi\n =")
=> "<p>hi\n =</p>\n"
> md.render("hi\n= ")
=> "<h1>hi</h1>\n"
> md.render("\n\n======")
=> "<h1></h1>\n"
=end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
appium_doc_lint-0.0.10 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.9 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.8 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.7 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.6 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.5 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.4 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.3 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.2 lib/appium_doc_lint/lint/h1_invalid.rb
appium_doc_lint-0.0.1 lib/appium_doc_lint/lint/h1_invalid.rb