rubocop-discourse-base 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80ac6ab7fbd6cdf67d3de760135b8501095034277eb4f0ea5d18ab0e7c60d5f9
+  data.tar.gz: f442cf305522aaabc3d89a4702e8848ac265143d5c603b0c89a1616ebe74100e
+SHA512:
+  metadata.gz: a32262270343ba9dc0af2bdcf1bf253ce68d53c1817a723764f1b27622ceb096fbab57a3ad9872dd9724e629c33aaca5cec061affcac8a1941b917f2310e7d7b
+  data.tar.gz: 25b7c5515e48a21d6185314f1df05be80d3c2fe4ce43e0dd8f812121ccfff6ea363cf0cb006e9b9c8eca6c39eef46cbbec0e81b6b74f8b0049ae73da2da9b250

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Civilized Discourse Construction Kit, Inc.
+
+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,49 @@
+# rubocop-discourse-base
+
+Shared RuboCop configuration used across Discourse projects. It ships the common core cops we enable, layout preferences, and an optional rspec profile.
+
+## Installation
+
+Add the gem to your development group:
+
+```ruby
+group :development, :test do
+  gem "rubocop-discourse-base"
+end
+```
+
+## Configuration
+
+Base config (core + layout) for non-Syntax Tree users:
+
+```yml
+inherit_gem:
+  rubocop-discourse-base: default.yml
+```
+
+`default.yml` is kept for backwards compatibility and includes our layout cops. It inherits `stree-compat.yml` (core cops only) plus `rubocop-layout.yml`.
+
+Syntax Tree–friendly config (omits Layout cops so it can be used with the formatter):
+
+```yml
+inherit_gem:
+  rubocop-discourse-base: stree-compat.yml
+```
+
+Minimal core-only config (same cops as `stree-compat.yml`):
+
+```yml
+inherit_gem:
+  rubocop-discourse-base: rubocop-core.yml
+```
+
+RSpec support (requires `gem "rubocop-rspec"`); use with either `default.yml` or `stree-compat.yml`:
+
+```yml
+inherit_gem:
+  rubocop-discourse-base:
+    - default.yml # or stree-compat.yml
+    - rubocop-rspec.yml
+```
+
+Then run `bundle exec rubocop` as usual.

data/default.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - ./stree-compat.yml
+  - ./rubocop-layout.yml

data/lib/rubocop/discourse/base/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Discourse
+    module Base
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/rubocop/discourse/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "base/version"
+
+module RuboCop
+  module Discourse
+    module Base
+    end
+  end
+end

data/rubocop-core.yml

@@ -0,0 +1,143 @@
+Security:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
+Security/CompoundHash:
+  Enabled: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: either
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/SingleLineMethods:
+  Enabled: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/GlobalVars:
+  Enabled: true
+  Severity: warning
+  Exclude:
+    - "lib/tasks/**/*"
+    - "script/**/*"
+    - "**/spec/**/*"
+
+Style/InvertibleUnlessCondition:
+  Enabled: true
+
+Style/NegatedUnless:
+  Enabled: true
+
+Style/UnlessElse:
+  Enabled: true
+
+Style/UnlessLogicalOperators:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/RedundantWithIndex:
+  Enabled: true
+
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/BooleanSymbol:
+  Enabled: true
+  AutoCorrect: false # it breaks the code
+
+Lint/ShadowedArgument:
+  Enabled: true
+
+Lint/RedundantCopDisableDirective:
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Enabled: true
+
+Lint/RedundantWithObject:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DisjunctiveAssignmentInConstructor:
+  Enabled: true
+
+Lint/NonLocalExitFromIterator:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/SafeNavigationChain:
+  Enabled: true
+
+Lint/RedundantSafeNavigation:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/SafeNavigationConsistency:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true

data/rubocop-discourse-base.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/discourse/base/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-discourse-base"
+  spec.version = RuboCop::Discourse::Base::VERSION
+  spec.summary = "Common RuboCop configurations used by Discourse"
+  spec.authors = ["Discourse Team"]
+  spec.license = "MIT"
+  spec.homepage = "https://github.com/discourse/rubocop-discourse-base"
+
+  config_files = %w[
+    default.yml
+    rubocop-core.yml
+    rubocop-layout.yml
+    rubocop-rspec.yml
+    stree-compat.yml
+  ]
+
+  spec.files =
+    %w[LICENSE README.md rubocop-discourse-base.gemspec] + config_files + Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0"
+  spec.add_runtime_dependency "rubocop", ">= 1.80.0"
+
+  spec.add_development_dependency "rake", "~> 13.1.0"
+end

data/rubocop-layout.yml

@@ -0,0 +1,80 @@
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# Use empty lines between definitions.
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/HashAlignment:
+  Enabled: true

data/rubocop-rspec.yml

@@ -0,0 +1,220 @@
+plugins:
+  - rubocop-rspec
+
+RSpec/AnyInstance:
+  Enabled: false # To be decided
+
+RSpec/AroundBlock:
+  Enabled: true
+
+RSpec/BeforeAfterAll:
+  Enabled: true
+
+RSpec/ChangeByZero:
+  Enabled: true
+
+RSpec/ContextMethod:
+  Enabled: true
+
+RSpec/ContextWording:
+  Enabled: true
+  Prefixes:
+    - when
+    - with
+    - without
+    - for
+    - while
+    - if
+    - as
+    - after
+    - in
+
+RSpec/DescribeClass:
+  Enabled: true
+
+RSpec/DescribeMethod:
+  Enabled: true
+
+RSpec/DescribeSymbol:
+  Enabled: false # To be decided
+
+RSpec/DescribedClass:
+  Enabled: false # To be decided
+
+RSpec/DescribedClassModuleWrapping:
+  Enabled: true
+
+RSpec/EmptyExampleGroup:
+  Enabled: true
+
+RSpec/EmptyLineAfterExample:
+  Enabled: false # TODO
+
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: false # TODO
+
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: false # TODO
+
+RSpec/EmptyLineAfterHook:
+  Enabled: false # TODO
+
+RSpec/EmptyLineAfterSubject:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Enabled: false # To be decided
+
+RSpec/ExampleWithoutDescription:
+  Enabled: true
+
+RSpec/ExampleWording:
+  Enabled: false # TODO
+
+RSpec/ExpectActual:
+  Enabled: true
+
+RSpec/ExpectChange:
+  Enabled: false # To be decided
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/ExpectOutput:
+  Enabled: true
+
+RSpec/SpecFilePathFormat:
+  Enabled: false # To be decided
+
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
+RSpec/Focus:
+  Enabled: true
+
+RSpec/HookArgument:
+  Enabled: false # TODO
+
+RSpec/HooksBeforeExamples:
+  Enabled: false # TODO
+
+RSpec/ImplicitBlockExpectation:
+  Enabled: true
+
+RSpec/ImplicitExpect:
+  Enabled: false # To be decided
+
+RSpec/ImplicitSubject:
+  Enabled: false # To be decided
+
+RSpec/InstanceSpy:
+  Enabled: true
+
+RSpec/InstanceVariable:
+  Enabled: false # TODO
+
+RSpec/ItBehavesLike:
+  Enabled: true
+
+RSpec/IteratedExpectation:
+  Enabled: false # To be decided
+
+RSpec/LeadingSubject:
+  Enabled: true
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false # To be decided
+
+RSpec/LetBeforeExamples:
+  Enabled: false # TODO
+
+RSpec/LetSetup:
+  Enabled: false # TODO
+
+RSpec/MessageChain:
+  Enabled: true
+
+RSpec/MessageSpies:
+  Enabled: true
+
+RSpec/MissingExampleGroupArgument:
+  Enabled: true
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false # TODO
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MultipleSubjects:
+  Enabled: true
+
+RSpec/NamedSubject:
+  Enabled: true
+
+RSpec/NestedGroups:
+  Enabled: false # To be decided
+
+RSpec/OverwritingSetup:
+  Enabled: true
+
+RSpec/ReceiveCounts:
+  Enabled: true
+
+RSpec/ReceiveNever:
+  Enabled: true
+
+RSpec/RepeatedDescription:
+  Enabled: false
+
+RSpec/RepeatedExample:
+  Enabled: false # TODO
+
+RSpec/RepeatedExampleGroupBody:
+  Enabled: false # TODO
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: false
+
+RSpec/ReturnFromStub:
+  Enabled: true
+
+RSpec/ScatteredSetup:
+  Enabled: false # TODO
+
+RSpec/SharedContext:
+  Enabled: true
+
+RSpec/SharedExamples:
+  Enabled: true
+
+RSpec/SingleArgumentMessageChain:
+  Enabled: true
+
+RSpec/SubjectStub:
+  Enabled: true
+
+RSpec/UnspecifiedException:
+  Enabled: true
+
+RSpec/VerifiedDoubles:
+  Enabled: true
+
+RSpec/VoidExpect:
+  Enabled: true
+
+RSpec/Yield:
+  Enabled: true
+
+RSpec/Dialect:
+  Enabled: true
+  PreferredMethods:
+    background: :before
+    scenario: :it
+    xscenario: :xit
+    given: :let
+    given!: :let!
+    feature: :describe

data/stree-compat.yml

@@ -0,0 +1,7 @@
+inherit_from:
+  - ./rubocop-core.yml
+
+AllCops:
+  TargetRubyVersion: "3.3"
+  SuggestExtensions: false
+  DisabledByDefault: true

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-discourse-base
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Discourse Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.80.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.80.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- default.yml
+- lib/rubocop/discourse/base.rb
+- lib/rubocop/discourse/base/version.rb
+- rubocop-core.yml
+- rubocop-discourse-base.gemspec
+- rubocop-layout.yml
+- rubocop-rspec.yml
+- stree-compat.yml
+homepage: https://github.com/discourse/rubocop-discourse-base
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Common RuboCop configurations used by Discourse
+test_files: []