lintf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 475858fee0d3177168e0dd9119c14a26e154d43da9d435970209f5d1efcb4927
+  data.tar.gz: e16ac31059c31675c89410e716a1b441ab1ad4639bce4e359f348f5dce1a0b52
+SHA512:
+  metadata.gz: 9143f3a312a41e9dc58e98b4e0c5f1fd3f6957a2a88ffef9ce7a0f30b58df99be5a94bb2ff7fdb34ea1f080aa2e1a3d4d8d7639f0d9c95c0e0f0fa3e8acc8763
+  data.tar.gz: a5f55c6925bbadc4e1a2d22a0880401eaa7e96e6977cd3d2a4bc5990ccb1a9c6b409562d9b918547b80510222d161e76479381646f3bc6dba9efb8a351d3605a

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.0](https://rubygems.org/gems/lintf/versions/0.1.0) - 2024-12-21
+
+- Add Lintf CLI
+- Add RuboCop config
+- Add RuboCop Performance config
+- Add RuboCop Rails config
+- Add RuboCop RSpec config
+- Add RuboCop RSpecRails config
+- Add ERB Lint config

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present cdfzo
+
+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,74 @@
+# Lintf
+
+Linter and formatter collection for Ruby, including configuration for RuboCop
+(Performance, Rails, RSpec, RSpecRails) and ERB Lint.
+
+## Installation
+
+Run `bundle add lintf`.
+
+## Configuration
+
+### RuboCop
+
+Edit `.rubocop.yml`:
+
+```yml
+inherit_gem:
+  lintf: config/base.yml
+```
+
+This will include all configured cops.
+
+Alternatively, you can select the cops you want:
+
+```yml
+inherit_gem:
+  lintf:
+    - config/rubocop.yml
+    - config/rubocop-performance.yml
+    - config/rubocop-rails.yml
+    - config/rubocop-rspec.yml
+    - config/rubocop-rspec_rails.yml
+```
+
+### ERB Lint
+
+Edit `.erb_lint.yml`:
+
+```yml
+inherit_gem:
+  lintf: config/erb_lint.yml
+```
+
+## Usage
+
+By default, the CLI checks all touched files in the current branch using
+`git diff origin/main`. You can change this behavior by passing the following
+options:
+
+- `-a`: All files tracked by Git (uses `git ls-files`)
+- `-f`: Automatically fix problems (dangerous, e.g. `rubocop -A`)
+
+### Available Linters
+
+The following linters will be executed (in this order) if no arguments are given
+and the linter's configuration file is present:
+
+- `r`/`rubocop`: RuboCop
+- `er`/`erblint`: ERB Lint
+
+### Examples
+
+Here are some examples of how to use the CLI:
+
+- `bundle exec lintf`: Run all linters, but only on touched files
+- `bundle exec lintf -f`: **Fix/format** touched files with all linters
+- `bundle exec lintf er r`: Run **ERB Lint**, then **RuboCop**
+- `bundle exec lintf -a rubocop`: Check **all** files with RuboCop
+- `bundle exec lintf -fa r`: **Format all** files with RuboCop
+
+## License
+
+Lintf is released under the terms of the
+[MIT License](https://codeberg.org/cdfzo/lintf-rb/src/branch/main/LICENSE).

data/bin/lintf

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+CONFIG = {
+  RuboCop: {
+    config: '.rubocop.yml',
+    run: 'bundle exec rubocop -c .rubocop.yml --force-exclusion db/schema.rb',
+    fix: '-A',
+    files: %w[rb rake gemspec],
+  },
+  'ERB Lint': {
+    config: '.erb_lint.yml',
+    run: 'bundle exec erb_lint',
+    fix: '-a',
+    files: %w[erb],
+  },
+}.freeze
+
+options = {}
+runners = []
+
+# Get runners and options
+ARGV.each do |argument|
+  if argument.start_with? '-'
+    argument[1..].chars.each do |option|
+      case option
+      when 'a' then options[:all] = true
+      when 'f' then options[:fix] = true
+      else
+        puts "error: unknown option '#{argument}'"
+        exit 1
+      end
+    end
+  else
+    case argument
+    when 'er', 'erblint' then runners << :'ERB Lint'
+    when 'r', 'rubocop' then runners << :RuboCop
+    else
+      puts "error: unknown linter '#{argument}'"
+      exit 1
+    end
+  end
+end
+
+TRACKED_FILES = if options[:all] || `git branch --show-current`.strip == 'main'
+  `git ls-files`
+else
+  `git diff origin/main --diff-filter=dxb --name-only`
+end.split "\n"
+
+# Execute runners
+(runners.any? ? runners.uniq : CONFIG.keys).each do |name|
+  runner = CONFIG[name]
+  next unless File.file? runner[:config]
+
+  file_extensions = runner[:files].map { |extension| ".#{extension}" }
+  files = TRACKED_FILES.filter { |f| f.end_with?(*file_extensions) }.join ' '
+  next if files.empty?
+
+  puts "---- Executing #{name} ----"
+  option = runner[options[:fix] ? :fix : :check]
+  exit 1 unless system "#{runner[:run]} #{option} #{files}"
+end

data/config/base.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - rubocop.yml
+  - rubocop-performance.yml
+  - rubocop-rails.yml
+  - rubocop-rspec.yml
+  - rubocop-rspec_rails.yml

data/config/erb_lint.yml

@@ -0,0 +1,54 @@
+glob: app/views/**/*.erb
+
+linters:
+  AllowedScriptType:
+    enabled: true
+  ClosingErbTagIndent:
+    enabled: true
+  CommentSyntax:
+    enabled: true
+  ExtraNewline:
+    enabled: true
+  FinalNewline:
+    enabled: true
+  NoJavascriptTagHelper:
+    enabled: true
+    correction_style: plain
+  ParserErrors:
+    enabled: true
+  PartialInstanceVariable:
+    enabled: true
+  RequireInputAutocomplete:
+    enabled: true
+  RightTrim:
+    enabled: true
+  SelfClosingTag:
+    enabled: true
+  SpaceAroundErbTag:
+    enabled: true
+  SpaceIndentation:
+    enabled: true
+  SpaceInHtmlTag:
+    enabled: true
+  TrailingWhitespace:
+    enabled: true
+  DeprecatedClasses:
+    enabled: false
+  ErbSafety:
+    enabled: true
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from: .rubocop.yml
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Lint/UselessAssignment:
+        Enabled: false
+      Style/FrozenStringLiteralComment:
+        Enabled: false
+  RequireScriptNonce:
+    enabled: true
+  HardCodedString:
+    enabled: false

data/config/rubocop-performance.yml

@@ -0,0 +1,154 @@
+require: rubocop-performance
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: false
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/BindCall:
+  Enabled: true
+
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: false
+
+Performance/Caller:
+  Enabled: true
+
+Performance/CaseWhenSplat:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: true
+
+Performance/ChainArrayAllocation:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/CompareWithBlock:
+  Enabled: true
+
+Performance/ConcurrentMonotonicTime:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/Count:
+  Enabled: true
+
+Performance/DeletePrefix:
+  Enabled: true
+
+Performance/DeleteSuffix:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/FixedSize:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/InefficientHashSearch:
+  Enabled: true
+
+Performance/IoReadlines:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true
+
+Performance/MapMethodChain:
+  Enabled: true
+
+Performance/MethodObjectAsBlock:
+  Enabled: true
+
+Performance/OpenStruct:
+  Enabled: false
+
+Performance/RangeInclude:
+  Enabled: true
+
+Performance/RedundantBlockCall:
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+
+Performance/RedundantMatch:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SelectMap:
+  Enabled: true
+
+Performance/Size:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/StringBytesize:
+  Enabled: true
+
+Performance/StringIdentifierArgument:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true
+
+Performance/TimesMap:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true
+
+Performance/UriDefaultParser:
+  Enabled: true