rubocop-jekyll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 304012622aba6c768cd0c26b39b181176983cbd2
+  data.tar.gz: 700bf336eaedb0fc2b2acd9b560b7c0af5fc9225
+SHA512:
+  metadata.gz: 1177caa8b482f1f696a631387bbe970ef4569bea8baaf051588c917e3b9219f3eb2a8639bd0f8828480c9f72b5ffe6d962a84586d2f5867af3c712eb120cb5ec
+  data.tar.gz: 98a66b9786c33afdb19b9c4404692e7de2ca24048d0ed48b93771c296cc6fd2f3b7b62a22043600128b4ed5a9aebdda22c1ca715ef762ad0f558ac43275f94fc

data/.rubocop.yml

@@ -0,0 +1,108 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - lib/**/*.rb
+    - test/**/*.rb
+  Exclude:
+    - bin/**/*
+    - exe/**/*
+    - benchmark/**/*
+    - script/**/*
+    - vendor/**/*
+    - tmp/**/*
+
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+Layout/IndentationWidth:
+  Severity: error
+Layout/IndentArray:
+  EnforcedStyle: consistent
+Layout/IndentHash:
+  EnforcedStyle: consistent
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/EmptyComment:
+  Enabled: false
+Layout/EndAlignment:
+  Severity: error
+
+
+Lint/UnreachableCode:
+  Severity: error
+
+
+Metrics/AbcSize:
+  Max: 21
+Metrics/ClassLength:
+  Max: 240
+Metrics/LineLength:
+  Max: 100
+  Severity: warning
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+  Severity: error
+Metrics/ModuleLength:
+  Max: 240
+Metrics/ParameterLists:
+  Max: 4
+Metrics/PerceivedComplexity:
+  Max: 8
+
+
+Naming/FileName:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - _
+
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/AndOr:
+  Severity: error
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  Severity: error
+Style/ModuleFunction:
+  Enabled: false
+Style/MultilineTernaryOperator:
+  Severity: error
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%q": "{}"
+    "%Q": "{}"
+    "%r": "!!"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+Style/RescueModifier:
+  Enabled: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Maroli & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# RuboCop Jekyll
+
+A RuboCop extension to enforce common code style in Jekyll and Jekyll plugins.
+
+
+## Installation
+
+Just install the `rubocop-jekyll` gem
+
+```
+gem install rubocop-jekyll
+```
+
+or if you prefer Bundler, add it to your `Gemfile` or `gemspec`
+
+```ruby
+# Gemfile
+
+gem "rubocop-jekyll", "~> 0.1.0"
+```
+```ruby
+# <plugin>.gemspec
+
+spec.add_development_dependency "rubocop-jekyll", "~> 0.1.0"
+```
+and run `bundle install`
+
+
+## Usage
+
+You need to tell RuboCop to load the extension and *inherit* the custom RuboCop configuration advocated by
+[Jekyll](https://github.com/jekyll).
+
+Place the following at the top of your `.rubocop.yml`.
+
+```yaml
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+```
+
+Running `bundle exec rubocop` will now automatically load the `rubocop-jekyll` cops together with the standard cops.
+
+
+## Customization
+
+You can override any settings inherited from the extension by subsequently redefining the concerned parameters.

data/lib/rubocop-jekyll.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+path_to_cops = File.join(File.expand_path("rubocop", __dir__), "cop", "**", "*.rb")
+Dir[path_to_cops].each { |cop| require cop }

data/lib/rubocop/cop/jekyll/no_p_allowed.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# ------------------------------------------ #
+# Originally authored by Parker Moore
+# https://github.com/jekyll/jekyll/pull/6615
+# ------------------------------------------ #
+
+module RuboCop
+  module Cop
+    module Jekyll
+      class NoPAllowed < Cop
+        MSG = "Avoid using `p` to print things. Use `Jekyll.logger` instead."
+
+        def_node_search :p_called?, "(send _ :p _)"
+
+        def on_send(node)
+          add_offense(node, :location => :selector) if p_called?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/jekyll/no_puts_allowed.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# ------------------------------------------ #
+# Originally authored by Parker Moore
+# https://github.com/jekyll/jekyll/pull/6615
+# ------------------------------------------ #
+
+module RuboCop
+  module Cop
+    module Jekyll
+      class NoPutsAllowed < Cop
+        MSG = "Avoid using `puts` to print things. Use `Jekyll.logger` instead."
+
+        def_node_search :puts_called?, "(send nil? :puts _)"
+
+        def on_send(node)
+          add_offense(node, :location => :selector) if puts_called?(node)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-jekyll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+description: A RuboCop extension to enforce common code style in Jekyll and Jekyll
+  plugins
+email:
+- ashmaroli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- lib/rubocop-jekyll.rb
+- lib/rubocop/cop/jekyll/no_p_allowed.rb
+- lib/rubocop/cop/jekyll/no_puts_allowed.rb
+homepage: https://github.com/ashmaroli/rubocop-jekyll
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Code style check for Jekyll and Jekyll plugins
+test_files: []