Add JSON Report #119
Add JSON Report #119
Conversation
Improve bin/console experience
JuanVqz
force-pushed
the
feature/add-generators
branch
from
058daf5 to
83bcda3
Compare
JuanVqz
force-pushed
the
feature/add-generators
branch
from
83bcda3 to
0ee9975
Compare
| @@ -9,7 +9,7 @@ jobs: | |||
| strategy: | |||
| matrix: | |||
| os: [ubuntu] | |||
| ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"] | |||
| ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"] | |||
There was a problem hiding this comment.
Might be out of the scope adding support to Ruby 3.3 but that is the Ruby I had in my machine and the code ran, meaning it seems safe.
| @@ -6,11 +6,11 @@ jobs: | |||
| runs-on: ubuntu-latest | |||
|
|
|||
| steps: | |||
| - uses: actions/checkout@v2 | |||
| - uses: actions/checkout@v4 | |||
There was a problem hiding this comment.
Bumping GitHub checkout versions
| @@ -11,3 +11,4 @@ | |||
| .byebug_history | |||
|
|
|||
| .ruby-version | |||
| .tool-versions | |||
| @@ -1,16 +1,14 @@ | |||
| # frozen_string_literal: true | |||
There was a problem hiding this comment.
I removed this line because was erroring when using the bin/console command.
| IRB.start(__FILE__) | ||
| # Run skunk CLI application with the provided arguments | ||
| require "skunk/cli/application" | ||
| Skunk::Cli::Application.new(ARGV).execute |
There was a problem hiding this comment.
making the bin/console useful, now when it runs you can stop with the debugger everywhere and will run the CLI command with any given arg to improve debugging and timing to develop
| cost: file.cost.round(2), | ||
| coverage: file.coverage.round(2) | ||
| } | ||
| end |
There was a problem hiding this comment.
All the private methods are the same in the lib/skunk/commands/status_reporter.rb file, but that file is currently tied to generate the console report, and to not break anything for now, we are duplicating them
| @@ -8,7 +8,7 @@ | |||
| SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[ | |||
| SimpleCov::Formatter::HTMLFormatter, | |||
| SimpleCov::Formatter::Console, | |||
| SimpleCov::Formatter::Codecov, | |||
| SimpleCov::Formatter::Codecov | |||
JuanVqz
force-pushed
the
feature/add-generators
branch
from
c62a831 to
29d2ab6
Compare
| @@ -10,6 +10,7 @@ module Command | |||
| # reporter object. | |||
| class Base < RubyCritic::Command::Base | |||
| def initialize(options) | |||
| super | |||
|
Hey @etagwerker! I got finally time to finish this feature. In my previous PR I was thinking on adding the json report separated to the current This is seemless approach because you will still generating the console report but also generating the json report in background (as the RubyCritic gem does), we can expose the json generator until we consider it stable or add more generators (json/html/console). How would you like to release this change? It seems safe to just use a regular release, but I was wondering if you want to release a beta or any other way. |
| @@ -27,7 +26,7 @@ def initialize(options) | |||
| # | |||
| # @return [Skunk::Command::StatusReporter] | |||
| def execute | |||
| RubyCritic::Config.formats = [] | |||
| RubyCritic::Config.formats = [:json] | |||
There was a problem hiding this comment.
This is a temporal change, since we currently only support the :json generator; it's defaulted to it. but this will be removed eventually.
| @@ -39,6 +38,8 @@ def execute | |||
| # | |||
| # @param [RubyCritic::AnalysedModulesCollection] A collection of analysed modules | |||
| def report(analysed_modules) | |||
| Reporter.generate_report(analysed_modules) | |||
There was a problem hiding this comment.
This was the magic line that allowed us generate the json file in runtime (this is also how RubyCritic works).
In the future, I see Skunk following RubyCritic conventions and extracting the logic out lib/skunk/commands/status_reporter.rb to somewhere else and reusing it in the different generators.
CHANGELOG.mdthat links to this PR under the "main (unreleased)" heading.Description:
I've been wanting to add the JSON report to the skunk gem since forever, and I hope today is the day.
As you can see in the screenshot, it is still reporting the console Skunk report as it used to be.
Why? because I didn't want to break the current behavior until we first test the
jsongenerator and consider it stable (which it should I'm not concerned about it) and two, we support more generators as RubyCritic does, likehtmlfor example.The
report.jsonfile is created under the directory specified in yourRubyCritic::Config.rootconfiguration.I will abide by the code of conduct.