gl_lint 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a9b4c54c29c096edc14e659efc9445bf856717998e0bf93fec6969df71c1c6d5
4
+ data.tar.gz: c37cb07e8c6b9e8a22194c5cbd73da7ce702eba2906140411591d1f0cfe3f3fe
5
+ SHA512:
6
+ metadata.gz: 181796ecbe688bb4990bbea0a66ba5a698dca0087506a8afff90563e1aba92c5dfc22354b15dfd7c9b5a6c62d14c4efc9d5ff98a3558726063d5032c267851d9
7
+ data.tar.gz: c5a05050d93397fb7fdb4f04a10ddcd13e3de3daf75ed195be4dba42b064a619c632b2239cb2397159a91e57a981a07d09510d0e89e77147146fa7953b5af878
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ group :development, :test do
6
+ gem 'guard'
7
+ gem 'guard-rspec'
8
+ gem 'rspec'
9
+ end
10
+
11
+ gemspec
data/Guardfile ADDED
@@ -0,0 +1,25 @@
1
+ directories %w[lib spec]
2
+
3
+ rspec_options = {
4
+ cmd: 'bundle exec rspec',
5
+ all_after_pass: false,
6
+ all_on_start: false,
7
+ failed_mode: :focus
8
+ }
9
+
10
+ guard :rspec, rspec_options do
11
+ require 'guard/rspec/dsl'
12
+ dsl = Guard::RSpec::Dsl.new(self)
13
+
14
+ # Feel free to open issues for suggestions and improvements
15
+
16
+ # RSpec files
17
+ rspec = dsl.rspec
18
+ watch(rspec.spec_helper) { rspec.spec_dir }
19
+ watch(rspec.spec_support) { rspec.spec_dir }
20
+ watch(rspec.spec_files)
21
+
22
+ # Ruby files
23
+ ruby = dsl.ruby
24
+ dsl.watch_spec_files_for(ruby.lib_files)
25
+ end
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,54 @@
1
+ # Give Lively Lint
2
+
3
+ Linting tool.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'gl_lint', require: false
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install gl_lint
20
+
21
+ ## Usage
22
+
23
+ Create a an executable `bin/lint` file with:
24
+
25
+ `touch bin/lint && chmod 755 bin/lint`
26
+
27
+ Then add this to the file:
28
+
29
+ ```ruby
30
+ #!/usr/bin/env ruby
31
+ require 'bundler/setup'
32
+ require 'gl_lint'
33
+
34
+ GlLint.run_cli(app_root: File.expand_path('..', __dir__))
35
+ ```
36
+
37
+ Then run `bin/lint` to lint your changes
38
+
39
+ Alternatively, if your project doesn't have JavaScript, add `linters: ['rubocop]`
40
+
41
+ ```ruby
42
+ GlLint.run_cli(app_root: File.expand_path('..', __dir__),
43
+ linters: ['rubocop'])
44
+ ```
45
+
46
+ ## Publishing gem to rubygems!
47
+
48
+ [Build the gem](http://guides.rubygems.org/make-your-own-gem/)
49
+
50
+ gem build gl_lint.gemspec
51
+
52
+ [Push to rubygems](http://guides.rubygems.org/publishing/)
53
+
54
+ gem push gl_lint-0.2.0.gem
data/bin/lint ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ require 'bundler/setup'
3
+ require 'gl_lint'
4
+
5
+ GlLint.run_cli(app_root: File.expand_path('..', __dir__),
6
+ linters: ['rubocop'])
data/gl_lint.gemspec ADDED
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'English'
4
+ lib = File.expand_path('lib', __dir__)
5
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
6
+ require 'gl_lint/version'
7
+
8
+ Gem::Specification.new do |spec|
9
+ spec.name = 'gl_lint'
10
+ spec.version = GlLint::VERSION
11
+ spec.authors = ['Give Lively']
12
+ spec.summary = 'Give Lively linter tool'
13
+ spec.homepage = 'https://github.com/givelively/gl_lint'
14
+ spec.license = 'Apache'
15
+ spec.platform = Gem::Platform::RUBY
16
+
17
+ spec.required_ruby_version = '>= 3.1'
18
+
19
+ spec.extra_rdoc_files = ['README.md']
20
+
21
+ spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR).grep_v(/^(spec|\.)/)
22
+ spec.require_paths = ['lib']
23
+
24
+ spec.add_dependency 'optparse'
25
+ spec.add_dependency 'rubocop'
26
+ spec.add_dependency 'rubocop-performance'
27
+ spec.add_dependency 'rubocop-rake'
28
+ spec.add_dependency 'rubocop-rspec'
29
+
30
+ spec.metadata['rubygems_mfa_required'] = 'true'
31
+ end
@@ -0,0 +1,100 @@
1
+ require 'optparse'
2
+
3
+ module GlLint
4
+ class CLI
5
+ LINTERS = %w[rubocop prettier].freeze
6
+ DEFAULT_TARGET = '--changed'.freeze
7
+
8
+ TARGET_FILE_OPTS = [
9
+ ['--changed', '-c', 'Lints uncommitted changes (default)'],
10
+ ['--staged', '-s', 'Lints only staged files'],
11
+ ['--branch', '-b', 'Lints any files changed in the branch'],
12
+ ['--all', '-a', 'Lints all files']
13
+ ].freeze
14
+
15
+ class << self
16
+ # Disabling metrics, it doesn't make sense to deconstruct the CLI parser
17
+ # rubocop:disable Metrics
18
+ def parse(app_root:, linters: nil, default_target: nil)
19
+ options = lint_options(linters:, default_target:)
20
+ .merge(app_root:)
21
+
22
+ OptionParser.new do |parser|
23
+ TARGET_FILE_OPTS.each do |args|
24
+ parser.on(*args) do
25
+ raise "You can't pass multiple 'target files' options!" if options[:target_files]
26
+
27
+ options[:target_files] = args.first
28
+ end
29
+ end
30
+
31
+ parser.on('--rubocop', 'Lints only with rubocop') do
32
+ raise "This project doesn't support rubocop" unless LINTERS.include?('rubocop')
33
+
34
+ options[:linters] = ['rubocop']
35
+ end
36
+
37
+ parser.on('--prettier', 'Lints only with prettier') do
38
+ raise "This project doesn't support rubocop" unless LINTERS.include?('prettier')
39
+ raise "You can't pass both --rubocop and --prettier" if options[:linters] == ['rubocop']
40
+
41
+ options[:linters] = ['prettier']
42
+ end
43
+
44
+ parser.on('--no-fix', 'Does not auto-fix') do
45
+ options[:no_fix] = true
46
+ end
47
+
48
+ parser.on('--unsafe-fix',
49
+ 'Rubocop fixes with unsafe option (also can be set with UNSAFE=true)') do
50
+ options[:unsafe_fix] = true
51
+ end
52
+
53
+ parser.on('--list-files', 'Prints out files that would be linted (dry run)') do
54
+ options[:list_only] = true
55
+ end
56
+
57
+ parser.on('--verbose', 'Prints out all options') do
58
+ options[:verbose] = true
59
+ end
60
+
61
+ parser.on('--write-rubocop-rules', 'Updates .rubocop_rules.yml') do
62
+ options[:write_rubocop_rules] = true
63
+ end
64
+
65
+ parser.on_tail('-h', '--help', 'Show this message') do
66
+ puts parser
67
+ puts "\nExamples:"
68
+ puts ' bin/lint -- Lints uncommitted changes (default)'
69
+ puts ' bin/lint --branch -- Lints files changed on current branch'
70
+ puts " bin/lint spec/rails_helper.rb -- Lints 'spec/rails_helper.rb'"
71
+ puts ''
72
+ exit
73
+ end
74
+ end.parse!
75
+
76
+ # Enable passing in filenames to lint
77
+ if ARGV.any?
78
+ options[:filenames] = ARGV
79
+ puts "passed files: #{options[:filenames]}"
80
+
81
+ raise "Passed both 'filenames' and 'target files': #{options[:target_files]}" if options[:target_files]
82
+ end
83
+
84
+ options[:target_files] ||= options[:default_target]
85
+ options
86
+ end
87
+ # rubocop:enable Metrics
88
+
89
+ private
90
+
91
+ def lint_options(linters:, default_target: nil)
92
+ {
93
+ linters: linters || LINTERS,
94
+ unsafe_fix: ENV['UNSAFE_LINT'] == 'true',
95
+ default_target: default_target || DEFAULT_TARGET
96
+ }
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,37 @@
1
+ require 'yaml'
2
+
3
+ module GlLint
4
+ class ExportRubocop
5
+ class << self
6
+ IGNORED_PROPERTIES = %w[Description Enabled Reference Safe SafeAutoCorrect
7
+ StyleGuide SupportedStyles].freeze
8
+
9
+ def write_rules(app_root)
10
+ puts 'Updating .rubocop_rules.yml'
11
+
12
+ enabled_rules = rubocop_rules.map { |arr| stored_rule(app_root, arr) }.compact
13
+
14
+ File.write('.rubocop_rules.yml', YAML.dump(enabled_rules.to_h))
15
+ end
16
+
17
+ private
18
+
19
+ def stored_rule(app_root, arr)
20
+ # Only save enabled rules
21
+ return unless arr[1]['Enabled'] == true
22
+
23
+ # Ignore properties which aren't relevant to tracking rule state
24
+ arr[1] = arr[1].except(*IGNORED_PROPERTIES)
25
+
26
+ arr[1]['Exclude']&.each { |str| str.gsub!(app_root, '') }
27
+
28
+ [arr[0], arr[1]]
29
+ end
30
+
31
+ def rubocop_rules
32
+ YAML.safe_load(`rubocop -c .rubocop.yml --show-cops`,
33
+ permitted_classes: [Regexp, Symbol]).to_a
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,64 @@
1
+ module GlLint
2
+ class FileSelector
3
+ NON_RB_RUBY_FILES = %w[Gemfile Rakefile config.ru
4
+ bin/bundle bin/lint bin/rubocop bin/setup bin/update].freeze
5
+
6
+ class << self
7
+ def files(filenames: nil, target_files: nil)
8
+ selected_files = filenames || filenames_from_target_files(target_files)
9
+
10
+ if selected_files
11
+ rubocop_files = selected_files.grep(/\.(rb|rake|gemspec)\z/)
12
+ rubocop_files += selected_files & NON_RB_RUBY_FILES
13
+
14
+ prettier_files = selected_files.grep(/\.(js|jsx|json|css|md)\z/)
15
+ end
16
+
17
+ { rubocop: rubocop_files, prettier: prettier_files }
18
+ end
19
+
20
+ private
21
+
22
+ def filenames_from_target_files(target_files)
23
+ case target_files
24
+ when '--branch' then files_changed_on_branch
25
+ when '--staged' then files_staged
26
+ when '--all' then return nil
27
+ when '--changed' then files_changed_currently
28
+ else
29
+ raise 'Unknown target files!'
30
+ end.map { |s| parse_git_output(s) }.compact
31
+ end
32
+
33
+ def files_changed_currently
34
+ # Get just the filenames of the changed files
35
+ `git status -s`.split("\n")
36
+ end
37
+
38
+ def files_staged
39
+ # staged files have the change as the first character
40
+ `git status -s`.split("\n").select { |s| s.start_with?(/^\w/) }
41
+ end
42
+
43
+ def files_changed_on_branch
44
+ branch = `git symbolic-ref --short HEAD`.strip
45
+ main_branch = 'origin/main' # We need to use origin/main or the github action fails
46
+ puts "linting changed files between '#{main_branch}' > '#{branch}'\n\n"
47
+ `git diff --merge-base --name-status #{main_branch} #{branch}`.split("\n")
48
+ end
49
+
50
+ def parse_git_output(str)
51
+ # Return nil if the file is deleted
52
+ return nil if str.start_with?(/\s?D\s/)
53
+
54
+ if str.match?(/^R/)
55
+ # If renamed, grab the renamed filename (which is the second filenamename in the list)
56
+ str.split(/(->)|(\t+)/).last
57
+ else
58
+ # Otherwise just grab the filename
59
+ str.gsub(/^\s?\S\S?\s+/, '')
60
+ end.strip
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,73 @@
1
+ module GlLint
2
+ class Linter
3
+ attr_accessor :linter_failures
4
+
5
+ def lint(linters:, target_files:, lint_strategy:, filenames: nil)
6
+ @linter_failures = []
7
+ files = GlLint::FileSelector.files(filenames:, target_files:)
8
+
9
+ lint_ruby_files(linters, target_files, files[:rubocop], lint_strategy)
10
+
11
+ lint_prettier_files(linters, target_files, files[:prettier], lint_strategy)
12
+
13
+ puts '' # Add some space after printing linting out
14
+
15
+ abort(linter_failures.join('\n')) if linter_failures.any?
16
+ end
17
+
18
+ private
19
+
20
+ def run_linter(*args)
21
+ return if system(*args)
22
+
23
+ linter_failures << "\n== Command #{args} failed =="
24
+ end
25
+
26
+ def print_files(target_files, files, strategy, linter)
27
+ puts "\n== #{linter} files to lint =="
28
+
29
+ if target_files == '--all'
30
+ puts '--all', ''
31
+ elsif files&.none?
32
+ puts "* No #{linter} files to lint! *"
33
+ return :no_lint
34
+ else
35
+ puts files, ''
36
+ end
37
+
38
+ return unless strategy == :list_only
39
+
40
+ puts 'Run with --list-files, so printing out target files without linting'
41
+ :no_lint
42
+ end
43
+
44
+ def lint_ruby_files(linters, target_files, files, strategy)
45
+ return unless linters.include?('rubocop')
46
+
47
+ result = print_files(target_files, files, strategy, 'Rubocop')
48
+ return if result == :no_lint
49
+
50
+ rubocop_arg = if strategy == :no_fix
51
+ ''
52
+ else
53
+ strategy == :unsafe_fix ? '-A' : '-a'
54
+ end
55
+ puts '*Rubcop is running in unsafe mode*', '' if rubocop_arg == '-A'
56
+ run_linter(
57
+ 'bundle exec rubocop --format quiet -c .rubocop.yml ' \
58
+ "#{rubocop_arg} #{files&.join(' ')}"
59
+ )
60
+ end
61
+
62
+ def lint_prettier_files(linters, target_files, files, strategy)
63
+ return unless linters.include?('prettier')
64
+
65
+ result = print_files(target_files, files, strategy, 'Prettier')
66
+ return if result == :skip_lint
67
+
68
+ # Need to manually call eslint, the package.json script specifies the folders to lint
69
+ prettier_command = strategy == :no_fix ? 'eslint' : 'eslint --fix'
70
+ run_linter("yarn run #{prettier_command} #{files&.join(' ')}")
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module GlLint
4
+ VERSION = '0.2.0'
5
+ end
data/lib/gl_lint.rb ADDED
@@ -0,0 +1,32 @@
1
+ require 'gl_lint/cli'
2
+ require 'gl_lint/file_selector'
3
+ require 'gl_lint/linter'
4
+ require 'gl_lint/export_rubocop'
5
+
6
+ module GlLint
7
+ class << self
8
+ def lint_strategy_from_options(no_fix: false, list_only: false, unsafe_fix: false)
9
+ return :list_only if list_only
10
+ return :no_fix if no_fix
11
+
12
+ unsafe_fix ? :unsafe_fix : :fix
13
+ end
14
+
15
+ def run_cli(app_root:, linters: nil)
16
+ options = GlLint::CLI.parse(app_root:, linters:)
17
+ puts 'Options: ', options, '' if options[:verbose]
18
+
19
+ Dir.chdir(options[:app_root]) do
20
+ if options[:write_rubocop_rules]
21
+ GlLint::ExportRubocop.write_rules(app_root)
22
+ else
23
+ lint_strategy = lint_strategy_from_options(**options.slice(:no_fix, :list_only,
24
+ :unsafe_fix))
25
+ linter_args = options.slice(:linters, :target_files, :filenames)
26
+ .merge(lint_strategy:)
27
+ GlLint::Linter.new.lint(**linter_args)
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
metadata ADDED
@@ -0,0 +1,126 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: gl_lint
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - Give Lively
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-03-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: optparse
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rubocop
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rubocop-performance
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rubocop-rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop-rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description:
84
+ email:
85
+ executables: []
86
+ extensions: []
87
+ extra_rdoc_files:
88
+ - README.md
89
+ files:
90
+ - Gemfile
91
+ - Guardfile
92
+ - LICENSE
93
+ - README.md
94
+ - bin/lint
95
+ - gl_lint.gemspec
96
+ - lib/gl_lint.rb
97
+ - lib/gl_lint/cli.rb
98
+ - lib/gl_lint/export_rubocop.rb
99
+ - lib/gl_lint/file_selector.rb
100
+ - lib/gl_lint/linter.rb
101
+ - lib/gl_lint/version.rb
102
+ homepage: https://github.com/givelively/gl_lint
103
+ licenses:
104
+ - Apache
105
+ metadata:
106
+ rubygems_mfa_required: 'true'
107
+ post_install_message:
108
+ rdoc_options: []
109
+ require_paths:
110
+ - lib
111
+ required_ruby_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: '3.1'
116
+ required_rubygems_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ requirements: []
122
+ rubygems_version: 3.4.19
123
+ signing_key:
124
+ specification_version: 4
125
+ summary: Give Lively linter tool
126
+ test_files: []