lintf 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 475858fee0d3177168e0dd9119c14a26e154d43da9d435970209f5d1efcb4927
-  data.tar.gz: e16ac31059c31675c89410e716a1b441ab1ad4639bce4e359f348f5dce1a0b52
+  metadata.gz: 9f5fc442d091dac3a0febcd6c6c82c0cf61833fbcd77909fb2bd6e4ae0729aed
+  data.tar.gz: 18e1cc8e35c9e7ede67ad15a93a0ab013385a98402059ed48017fd4bc4e68eb2
 SHA512:
-  metadata.gz: 9143f3a312a41e9dc58e98b4e0c5f1fd3f6957a2a88ffef9ce7a0f30b58df99be5a94bb2ff7fdb34ea1f080aa2e1a3d4d8d7639f0d9c95c0e0f0fa3e8acc8763
-  data.tar.gz: a5f55c6925bbadc4e1a2d22a0880401eaa7e96e6977cd3d2a4bc5990ccb1a9c6b409562d9b918547b80510222d161e76479381646f3bc6dba9efb8a351d3605a
+  metadata.gz: f48709f47c47eae4bdf7b9194a097c8a4ecf5cce4d1788f07674e45385e8f511bb1412ea99fcf16ecc10396de8727eae84c16d46b66c9d32610bcb7434980af7
+  data.tar.gz: 646b393f03a816e392a5426d4b7567926b2518dceaf3b01366dca83a2d96a9021173105a713a5fe13177f5d925e09de39dd21ec54627fb5583928cd180799bf2

data/CHANGELOG.md

@@ -1,11 +1,27 @@
 # Changelog
 
+## [0.2.0](https://rubygems.org/gems/lintf/versions/0.2.0) - 2024-12-21
+
+- [`91816f9`](https://codeberg.org/cdfzo/lintf-rb/commit/91816f9901288c30943e038fd8bb3b9ff601ac89)
+  Make CLI customizable via .lintf.yml
+- [`6df7d33`](https://codeberg.org/cdfzo/lintf-rb/commit/6df7d331e2f1426f6994341f8550b7d529795efe)
+  Use only RuboCop as runtime dependency
+- [`a131a6e`](https://codeberg.org/cdfzo/lintf-rb/commit/a131a6eaf9559d2c2090a8470a687f956ee730cf)
+  Disable Style/ClassAndModuleChildren
+
 ## [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
+- [`4f26633`](https://codeberg.org/cdfzo/lintf-rb/commit/4f26633df30ce35657a33538db5ab3372544ffea)
+  Add Lintf CLI
+- [`6276ef0`](https://codeberg.org/cdfzo/lintf-rb/commit/6276ef0bda63a2cf9dbbc9d0b3ace53a6b77bb79)
+  Add RuboCop config
+- [`e945310`](https://codeberg.org/cdfzo/lintf-rb/commit/e94531058649d604418e529f526d1958e771b19d)
+  Add RuboCop Performance config
+- [`ecc2872`](https://codeberg.org/cdfzo/lintf-rb/commit/ecc2872e91abcc3607753083707f944c9b46c277)
+  Add RuboCop Rails config
+- [`50f49c8`](https://codeberg.org/cdfzo/lintf-rb/commit/50f49c878dd5313ed4bb279ab6d862e51cc7910f)
+  Add RuboCop RSpec config
+- [`b2c16c3`](https://codeberg.org/cdfzo/lintf-rb/commit/b2c16c3368d4312b9e280968678b6dcc54af479c)
+  Add RuboCop RSpecRails config
+- [`8353c5e`](https://codeberg.org/cdfzo/lintf-rb/commit/8353c5ef0f0db9d2a3742fcd2f071016ad55d0fe)
+  Add ERB Lint config

data/README.md

@@ -1,26 +1,18 @@
 # Lintf
 
-Linter and formatter collection for Ruby, including configuration for RuboCop
+Linter and formatter runner for Ruby, including configuration for RuboCop
 (Performance, Rails, RSpec, RSpecRails) and ERB Lint.
 
 ## Installation
 
-Run `bundle add lintf`.
+1. Add `gem 'lintf', require: false` to the development group in your Gemfile.
+1. Run `bundle`.
 
 ## 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:
+Edit `.rubocop.yml` and select the cops you want to use:
 
 ```yml
 inherit_gem:
@@ -32,9 +24,12 @@ inherit_gem:
     - config/rubocop-rspec_rails.yml
 ```
 
+Don't forget to add the cop's gem to your Gemfile as well, since Lintf only
+includes the `rubocop` gem.
+
 ### ERB Lint
 
-Edit `.erb_lint.yml`:
+Edit `.erb_lint.yml` and add `erb_lint` to your Gemfile:
 
 ```yml
 inherit_gem:
@@ -43,31 +38,51 @@ inherit_gem:
 
 ## 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:
+### Config File
 
-- `-a`: All files tracked by Git (uses `git ls-files`)
-- `-f`: Automatically fix problems (dangerous, e.g. `rubocop -A`)
+You can create your own tool definitions in a `.lintf.yml` file and add them to
+the `run` key, or override the default. Your config will be deep merged with the
+[default configuration](https://codeberg.org/cdfzo/lintf-rb/src/branch/main/config/lintf.yml).
 
-### Available Linters
+### CLI
 
-The following linters will be executed (in this order) if no arguments are given
-and the linter's configuration file is present:
+By default, Lintf checks all touched files in the current branch using
+`git diff origin/main`. You can change this behavior by passing the following
+options to the CLI:
 
-- `r`/`rubocop`: RuboCop
-- `er`/`erblint`: ERB Lint
+- `-a`: All files tracked by Git (uses `git ls-files`)
+- `-f`: Fix problems automatically (i.e. autocorrect)
+
+Other flags are passed to the tools (e.g. `lintf rubocop --help`).
 
 ### 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`: Run all tools, but only on touched files
+- `bundle exec lintf -f`: **Fix/format** touched files with all tools
 - `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
 
+Here are some examples of how to override the default config with `.lintf.yml`:
+
+```yml
+run: [rubocop, my_custom_linter]
+
+rubocop:
+  fix: -a
+
+my_custom_linter:
+  alias: mcl
+  run: bundle exec my_custom_linter --fail-fast
+  files: [md, yml]
+```
+
+This changes the RuboCop autocorrection from the default `-A` to the safe `-a`
+and defines a new tool that will be run by default (after rubocop) or via
+`bundle exec lintf my_custom_linter` or `bundle exec lintf mcl`
+
 ## License
 
 Lintf is released under the terms of the

data/bin/lintf

@@ -1,63 +1,9 @@
 #!/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
+lib_path = File.expand_path '../lib', __dir__
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include? lib_path
 
-options = {}
-runners = []
+require 'lintf/cli'
 
-# 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
+Lintf::CLI.new.run

data/config/lintf.yml

@@ -0,0 +1,29 @@
+# List of tools to run in this exact order if no arguments are provided in the
+# CLI. Can be either the key/name or alias of the defined tool (see `# Tools`).
+run: [rubocop, erblint]
+
+# Use -a/-f in the CLI to enable them or change it here permanently.
+all: false
+fix: false
+
+# Tools
+rubocop:
+  # Alias to run the tool in the CLI (e.g. `bundle exec lintf r`). The key can
+  # be used as well (e.g. `bundle exec lintf rubocop`).
+  alias: r
+  # Only run the tool if this file exists. Remove this key to always run it.
+  config: .rubocop.yml
+  # Command to run the tool. The files are appended to this command.
+  run: bundle exec rubocop -c .rubocop.yml --force-exclusion db/schema.rb
+  # Flag to enable autocorrection. Appended to `run` when `-f` is enabled.
+  fix: -A
+  # File extensions to include. Remove this key to use all files (i.e. `.`, so
+  # even files not tracked by Git).
+  files: [rb, rake, gemspec]
+
+erblint:
+  alias: er
+  config: .erb_lint.yml
+  run: bundle exec erb_lint
+  fix: -a
+  files: [erb]

data/config/rubocop.yml

@@ -1027,10 +1027,7 @@ Style/CharacterLiteral:
   Enabled: true
 
 Style/ClassAndModuleChildren:
-  Enabled: true
-  EnforcedStyle: compact
-  Exclude:
-    - '**/config/application.rb'
+  Enabled: false
 
 Style/ClassCheck:
   Enabled: true

data/lib/lintf/cli.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Lintf
+  class CLI
+    def run
+      parse_args
+      tools_to_execute.each do |tool|
+        next if tool[:config] && !File.file?(tool[:config])
+
+        execute tool
+      end
+    end
+
+    private
+
+    def merge_config(config)
+      custom_config = Psych.safe_load_file '.lintf.yml', symbolize_names: true
+
+      custom_config.each do |key, value|
+        if config[key].is_a? Hash
+          config[key].merge! value
+        else
+          config[key] = value
+        end
+      end
+    end
+
+    def config
+      @config ||= begin
+        config_file = File.expand_path '../../config/lintf.yml', __dir__
+        config = Psych.safe_load_file config_file, symbolize_names: true
+
+        merge_config config if File.file? '.lintf.yml'
+        config
+      rescue StandardError => e
+        error "invalid lintf config file: #{e.message}"
+      end
+    end
+
+    def parse_args
+      config[:flags] = []
+
+      ARGV.each do |arg|
+        if arg.start_with? '--'
+          config[:flags] << arg
+        elsif arg.start_with? '-'
+          arg[1..].chars.each { |name| find_and_set_flag name }
+        else
+          (config[:tools] ||= []) << find_tool(arg)
+        end
+      end
+    end
+
+    def flags
+      @flags ||= { a: :all, f: :fix }
+    end
+
+    def find_and_set_flag(name)
+      flag = flags[name.to_sym]
+
+      if flag
+        config[flag] = true
+      else
+        (config[:flags] ||= []) << "-#{name}"
+      end
+    end
+
+    def tools
+      @tools ||= config.values.filter { |v| v.is_a? Hash }
+    end
+
+    def find_tool(name)
+      config[name.to_sym] || tools.find { |tool| tool[:alias] == name } ||
+        error("unknown tool '#{name}'")
+    end
+
+    def files
+      @files ||= if config[:all] || `git branch --show-current`.strip == 'main'
+        `git ls-files`
+      else
+        `git diff origin/main --diff-filter=dxb --name-only`
+      end.split "\n"
+    end
+
+    def files_for(tool)
+      return '.' unless tool[:files]
+
+      file_extensions = tool[:files].map { |extension| ".#{extension}" }
+      files.filter { |file| file.end_with?(*file_extensions) }.join ' '
+    end
+
+    def fix_or_check
+      @fix_or_check ||= config[:fix] ? :fix : :check
+    end
+
+    def tools_to_execute
+      config[:tools] || config[:run].map { |name| find_tool name }
+    end
+
+    def execute(tool)
+      command = "#{tool[:run]} #{tool[fix_or_check]} #{config[:flags].join ' '}"
+      files = files_for tool
+
+      puts "\x1b[2m$ #{command}\x1b[0m"
+
+      if files.empty?
+        return puts "(no files #{config[:all] ? 'found' : 'touched'})"
+      end
+
+      exit 1 unless system "#{command} #{files}"
+    end
+
+    def error(message)
+      puts "error: #{message}"
+      exit 1
+    end
+  end
+end

data/lib/lintf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Lintf
+  VERSION = '0.2.0'
+end

data/lib/lintf.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
-module Lintf
-  VERSION = '0.1.0'
-end
+require 'lintf/cli'
+require 'lintf/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lintf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - cdfzo
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2024-12-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: erb_lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -38,64 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.69'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.27'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.27'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.30'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.30'
-description: Linter and formatter collection for Ruby, including configuration for
-  RuboCop (Performance, Rails, RSpec, RSpecRails) and ERB Lint.
+description: Linter and formatter runner for Ruby, including configuration for RuboCop
+  (Performance, Rails, RSpec, RSpecRails) and ERB Lint.
 email: cdfzo@pm.me
 executables:
 - lintf
@@ -108,12 +38,15 @@ files:
 - bin/lintf
 - config/base.yml
 - config/erb_lint.yml
+- config/lintf.yml
 - config/rubocop-performance.yml
 - config/rubocop-rails.yml
 - config/rubocop-rspec.yml
 - config/rubocop-rspec_rails.yml
 - config/rubocop.yml
 - lib/lintf.rb
+- lib/lintf/cli.rb
+- lib/lintf/version.rb
 homepage: https://codeberg.org/cdfzo/lintf-rb
 licenses:
 - MIT
@@ -142,5 +75,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Linter and formatter collection for Ruby.
+summary: Linter and formatter runner for Ruby.
 test_files: []