gl_lint 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70aa764f228d4331b343a9a8f5c6aa59177f17e289250c3a1a01a76f1b2d1002
-  data.tar.gz: 9a60b75e56737988e02278de20e8faf49e802bde9f0e64f70112c864d9f65622
+  metadata.gz: 836ecbd9eb8d9a231c39ae7241b7070c1af7d146ba3c3228949e1cea281c8201
+  data.tar.gz: 373971c3b5a492c56afb983d1e53a44e354cb597ec9183d72dd8a5a15d2e077e
 SHA512:
-  metadata.gz: ba11e437c2a9f9dbf57cc5d4a719907ad96f2f8094de2b6c89b52bccdd0c7c4bbd3e3f3091924ec36a0332cfa0ea1470599c5bc2de22536c89d2f1cff040d6b4
-  data.tar.gz: f297f964e00bb7e8f7ee0613ecff2efad81655c3c61c86cf6ab7ccbb0ca3e0d782fbc04b0fa0ba3e9d1aaf7ee699a03a697195d8eb065bbf0588a76c10d9b95c
+  metadata.gz: a80e065d4e61a72eac3ed35a9045e4ab993f13a8f1851187a7cfa98735b92ceae26255d4e466cd7764e9e05d1f919b39a280bc06d90775876825d0641a068683
+  data.tar.gz: a7520aac3a6a0a9ea9a131d1b42ecd52c08c77fd7ae00b4734eaf535cb5b8277fcbb9bd40633496f0fb04fd4425bbf87b4c2fab7322db4b05f2ba8d089d0c8a9

data/README.md

@@ -1,6 +1,13 @@
-# Give Lively Lint
+# Give Lively Lint runner
+
+`GLLint` is a Ruby gem that handles running linters against specific files (e.g. just the changed files from a branch). It leverages `git`, `rubocop` and `eslint`
+
+This is particularly useful for large projects where you don't want to lint all the files in the project.
+
+At Give Lively, we add a file to `bin/lint` and have it call this gem to lint with autocorrect.
+
+GLLint also adds a way to create a yaml file with all the currently configured rubocop rules (`.rubocop_rules.yml`). This is done via `bin/lint --write-rubocop-rules`. This file is useful to compare what changes when updating Rubocop rules, changing gems or Ruby versions.
 
-Linting tool.
 
 ## Installation
 
@@ -18,11 +25,11 @@ Or install it yourself as:
 
     $ gem install gl_lint
 
-## Usage
+### bin/lint
 
 Create a an executable `bin/lint` file with:
 
-`touch bin/lint && chmod 755 bin/lint`
+`touch bin/lint && chmod +x bin/lint`
 
 Then add this to the file:
 
@@ -34,11 +41,11 @@ require 'gl_lint'
 GLLint.call_cli(app_root: File.expand_path('..', __dir__))
 ```
 
-Then run `bin/lint` to lint your changes
+Then run `bin/lint` to lint your changes.
 
-Alternatively, if your project doesn't have JavaScript, add `linters: ['rubocop/]`
+Alternatively, if your project doesn't have JavaScript, add `linters: ['rubocop']`
 
 ```ruby
 GLLint.call_cli(app_root: File.expand_path('..', __dir__),
-               linters: ['rubocop'])
+                linters: ['rubocop'])
 ```

data/gl_lint.gemspec

@@ -26,9 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'optparse'
   spec.add_dependency 'rubocop'
-  spec.add_dependency 'rubocop-performance'
-  spec.add_dependency 'rubocop-rake'
-  spec.add_dependency 'rubocop-rspec'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/gl_lint/cli.rb

@@ -2,7 +2,7 @@ require 'optparse'
 
 module GLLint
   class CLI
-    LINTERS = %w[rubocop prettier].freeze
+    LINTERS = %w[rubocop eslint].freeze
     DEFAULT_TARGET = '--changed'.freeze
 
     TARGET_FILE_OPTS = [
@@ -33,11 +33,11 @@ module GLLint
             options[:linters] = ['rubocop']
           end
 
-          parser.on('--prettier', 'Lints only with prettier') do
-            raise "This project doesn't support rubocop" unless LINTERS.include?('prettier')
-            raise "You can't pass both --rubocop and --prettier" if options[:linters] == ['rubocop']
+          parser.on('--eslint', 'Lints only with eslint') do
+            raise "This project doesn't support rubocop" unless LINTERS.include?('eslint')
+            raise "You can't pass both --rubocop and --eslint" if options[:linters] == ['rubocop']
 
-            options[:linters] = ['prettier']
+            options[:linters] = ['eslint']
           end
 
           parser.on('--no-fix', 'Does not auto-fix') do
@@ -77,7 +77,9 @@ module GLLint
           options[:filenames] = ARGV
           puts "passed files: #{options[:filenames]}"
 
-          raise "Passed both 'filenames' and 'target files': #{options[:target_files]}" if options[:target_files]
+          if options[:target_files]
+            raise "Passed both 'filenames' and 'target files': #{options[:target_files]}"
+          end
         end
         options[:target_files] ||= options[:default_target]
         options

data/lib/gl_lint/export_rubocop.rb

@@ -7,10 +7,9 @@ module GLLint
                               StyleGuide SupportedStyles].freeze
 
       def write_rules(app_root)
-        puts 'Updating .rubocop_rules.yml'
+        puts "Updating .rubocop_rules.yml - version: #{rubocop_version}"
 
-        enabled_rules = [['RuboCop-version', rubocop_version]] +
-                        rubocop_rules.map { |arr| stored_rule(app_root, arr) }.compact
+        enabled_rules = rubocop_rules.map { |arr| stored_rule(app_root, arr) }.compact
 
         File.write('.rubocop_rules.yml', YAML.dump(enabled_rules.to_h))
       end
@@ -35,7 +34,7 @@ module GLLint
       end
 
       def rubocop_version
-        `rubocop -V`.strip.split("\n").first.split('[').first.strip
+        `rubocop -V`.strip.split("\n").first.split('[').first.strip.gsub(' running on', '')
       end
     end
   end

data/lib/gl_lint/file_selector.rb

@@ -13,10 +13,10 @@ module GLLint
           # Make certain that schemas are ignored
           rubocop_files.reject! { |f| f.match?(%r{db/.*schema.rb}) }
 
-          prettier_files = selected_files.grep(/\.(js|jsx|css)\z/)
+          eslint_files = selected_files.grep(/\.(js|jsx|css)\z/)
         end
 
-        { rubocop: rubocop_files, prettier: prettier_files }
+        { rubocop: rubocop_files, eslint: eslint_files }
       end
 
       private

data/lib/gl_lint/linter.rb

@@ -8,7 +8,7 @@ module GLLint
 
       lint_ruby_files(linters, target_files, files[:rubocop], lint_strategy)
 
-      lint_prettier_files(linters, target_files, files[:prettier], lint_strategy)
+      lint_eslint_files(linters, target_files, files[:eslint], lint_strategy)
 
       puts '' # Add some space after printing linting out
 
@@ -59,15 +59,15 @@ module GLLint
       )
     end
 
-    def lint_prettier_files(linters, target_files, files, strategy)
-      return unless linters.include?('prettier')
+    def lint_eslint_files(linters, target_files, files, strategy)
+      return unless linters.include?('eslint')
 
-      result = print_files(target_files, files, strategy, 'Prettier')
+      result = print_files(target_files, files, strategy, 'eslint')
       return if result == :skip_lint
 
       # Need to manually call eslint, the package.json script specifies the folders to lint
-      prettier_command = strategy == :no_fix ? 'eslint' : 'eslint --fix'
-      run_linter("yarn run #{prettier_command} #{files&.join(' ')}")
+      eslint_command = strategy == :no_fix ? 'eslint' : 'eslint --fix'
+      run_linter("yarn run #{eslint_command} #{files&.join(' ')}")
     end
   end
 end

data/lib/gl_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GLLint
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/gl_lint.rb

@@ -12,8 +12,8 @@ module GLLint
       call(**options.except(:verbose, :default_target))
     end
 
-    def call(app_root:, write_rubocop_rules: false, no_fix: false, list_only: false, unsafe_fix: false, linters: nil,
-             target_files: nil, filenames: nil)
+    def call(app_root:, write_rubocop_rules: false, no_fix: false, list_only: false,
+             unsafe_fix: false, linters: nil, target_files: nil, filenames: nil)
 
       Dir.chdir(app_root) do
         if write_rubocop_rules

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_lint
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -38,48 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 executables: []