rubocop-md 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5b04c2e0fbc284635fa82174064344fee7bbd71
-  data.tar.gz: 0abd5499484c03abbdae84b89a82af505a025df8
+  metadata.gz: 79797f2e2130aabc8bac1cc72ecefe5acdb367d2
+  data.tar.gz: 4094bca4c4e9be29fa8b6630415e70c23a562838
 SHA512:
-  metadata.gz: a943e124c09fe2fea37d0199b32568cfe166caa0d4d3745482d7a9992950a19939f70a9a2dee4d117086c9f55d5fc44f7cae30c60af42ec12be9b6f9c46d5ddf
-  data.tar.gz: 65a2893d0e458f66b94271632060e238cc089ef6bfeeb120df6bc6aeea5838068b62c3ff07742227395a9ab2c30f0420be720d318f42259dc93341b25bd28ba6
+  metadata.gz: 60508616bb720460e5f6653aa0fa4ce852ad790858c32a52091e146d182d77cb6ac7d6a3ff0980c0917364aa21c8636e3d4529f0722ab161b821e9cc19320769
+  data.tar.gz: aa8cb2cdfd4416790d977f84a53feb031d551f2111ec701b3759a0fcb4ddc2fe8e1806685be0565b437b9ff08c48e282e2e418088d398087319f807f90d04873

data/.gem_release.yml

@@ -1,2 +1,3 @@
 bump:
   file: lib/rubocop/markdown/version.rb
+  skip_ci: true

data/.travis.yml

@@ -9,9 +9,20 @@ matrix:
       gemfile: gemfiles/rubocopmaster.gemfile
     - rvm: jruby-9.1.0.0
       gemfile: Gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/rubocopmaster.gemfile
+    - rvm: 2.5.0
+      gemfile: Gemfile
     - rvm: 2.4.2
       gemfile: Gemfile
     - rvm: 2.3.1
       gemfile: Gemfile
     - rvm: 2.2.0
       gemfile: Gemfile
+  allow_failures:
+    - rvm: ruby-head
+      gemfile: gemfiles/rubocopmaster.gemfile
+    - rvm: jruby-9.1.0.0
+      gemfile: Gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/rubocopmaster.gemfile

data/README.md

@@ -46,22 +46,65 @@ Autocorrect works too:
 rubocop -r "rubocop-md" -a ./lib
 ```
 
-### Configuration file
+### Configuration
 
-First, add `rubocop-md` to your `.rubocop.yml`:
+Code in the documentation does not make sense to be checked for some style guidelines (eg `Style/FrozenStringLiteralComment`).
+
+We described such rules in the [default config](config/default.yml), but if you use the same settings in your project’s `.rubocop.yml` file, `RoboCop` will override them.
+
+Fortunately, `RuboCop` supports directory-level configuration and we can do the next trick.
+
+At first, add `rubocop-md` to your main `.rubocop.yml`:
 
 ```yml
+# .rubocop.yml
+
 require:
  - "rubocop-md"
 ```
 
-Additional options:
+*Notice: additional options*
 
 ```yml
 # .rubocop.yml
+
 Markdown:
   # Whether to run RuboCop against non-valid snippets
   WarnInvalid: true
+  # Whether to lint codeblocks without code attributes
+  Autodetect: true
+```
+
+Secondly, create empty `.rubocop.yml` in your docs directory.
+
+```bash
+├── docs
+│   ├── .rubocop.yml
+│   ├── doc1.md
+│   ├── doc2.md
+│   └── doc3.md
+├── lib
+├── .rubocop.yml # main
+└── ...
+```
+
+Third, just run
+
+```bash
+$ rubocop
+```
+
+Also you can add special rules in the second `.rubocop.yml`
+
+```ruby
+# rubocop.yml in docs folder
+
+Metrics/LineLength:
+  Max: 100
+
+Lint/Void:
+  Exclude:
+    - '*.md'
 ```
 
 ## How it works?
@@ -73,9 +116,11 @@ Markdown:
 ## Limitations
 
 - RuboCop cache is disabled for Markdown files (because cache knows nothing about preprocessing)
-- Uses naive Regexp-based approach to extract code blocks from Markdown, support only backticks-style code blocks
+- Uses naive Regexp-based approach to extract code blocks from Markdown, support only backticks-style code blocks\*
 - No language detection included; if you do not specify language for your code blocks, you'd better turn `WarnInvalid` off (see above)
 
+\* It should be easy to integrate a _real_ parser (e.g. [Kramdown](https://kramdown.gettalong.org)) and handle all possible syntax. Feel free to open an issue or pull request!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.

data/config/default.yml

@@ -1,5 +1,6 @@
 Markdown:
   WarnInvalid: true
+  Autodetect: true
 
 Layout/CommentIndentation:
   Exclude:

data/lib/rubocop/markdown/preprocess.rb

@@ -10,7 +10,7 @@ module RuboCop
       # Only recognizes backticks-style code blocks.
       #
       # Try it: http://rubular.com/r/iJaKBkSrrT
-      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n)/m
+      MD_REGEXP = /^([ \t]*`{3,4})([\w[[:blank:]]]*\n)([\s\S]+?)(^[ \t]*\1[[:blank:]]*\n?)/m
 
       MARKER = "<--rubocop/md-->".freeze
 
@@ -72,7 +72,7 @@ module RuboCop
 
         parts.each do |part|
           if walker.code_body?
-            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(part)
+            next walker.next! if maybe_ruby?(@syntax) && valid_syntax?(@syntax, part)
           end
 
           if walker.code_attr?
@@ -94,19 +94,31 @@ module RuboCop
       # Check codeblock attribute to prevent from parsing
       # non-Ruby snippets and avoid false positives
       def maybe_ruby?(syntax)
-        syntax.empty? || RUBY_TYPES.include?(syntax)
+        (autodetect? && syntax.empty?) || ruby?(syntax)
       end
 
-      # Try to parse with Ripper.
-      # Invalid Ruby (non-Ruby) code returns `nil`.
-      def valid_syntax?(src)
-        return true if warn_invalid?
+      # Check codeblack attribute if it's defined and of Ruby type
+      def ruby?(syntax)
+        RUBY_TYPES.include?(syntax)
+      end
+
+      # Try to parse with Ripper
+      # Invalid Ruby code (or non-Ruby) returns `nil`.
+      # Return true if it's explicit Ruby and warn_invalid?
+      def valid_syntax?(syntax, src)
+        return true if ruby?(syntax) && warn_invalid?
         !Ripper.sexp(src).nil?
       end
 
-      # Where to show warning when snippet is not a valid Ruby
+      # Whether to show warning when snippet is not a valid Ruby
       def warn_invalid?
-        config["Markdown"] && config["Markdown"].fetch("WarnInvalid", false)
+        config["Markdown"] && config["Markdown"].fetch("WarnInvalid", true)
+      end
+
+      # Whether to try to detect Ruby by parsing codeblock.
+      # If it's set to false we lint only implicitly specified Ruby blocks.
+      def autodetect?
+        config["Markdown"] && config["Markdown"].fetch("Autodetect", true)
       end
 
       def comment_lines!(src)

data/lib/rubocop/markdown/rubocop_ext.rb

@@ -26,7 +26,7 @@ RuboCop::Markdown.inject!
 
 RuboCop::Runner.prepend(Module.new do
   # Set config store for Markdown
-  def initialize(*)
+  def initialize(*args)
     super
     RuboCop::Markdown.config_store = @config_store
   end

data/lib/rubocop/markdown/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Markdown
-    VERSION = "0.1.1".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-md
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop