codemonitor 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b693d8b21e5c6041765bf54d568d21b7e8e54abeb1695d7937166a6bf9b2b7
-  data.tar.gz: 3af8eb6ab76db485ddc34a793c04793238b0d92c4523440028dd2809d58c1f50
+  metadata.gz: 9e6c5534fbc28c7134e0d88898112fd0eff5db4c92bb0ac86833bb4daff955d6
+  data.tar.gz: c9d7dc28df1e2d07e6b5377b320df7e947bcb72e13b6fa1dfe3981325d1fc9a0
 SHA512:
-  metadata.gz: 2c0a23989bded3388a21ac6c40c87ed4ed6d18a3f62d9ff804a13e595fb2152eb17dd8955224812ebfac2a71d37a569b1cadf1bf9f46195d87f7576351a6b39d
-  data.tar.gz: 8ae23e524620fd956835b5bf85699153a579796701c6e605ab7ad1f670f30622b50ee3d1528b2a79f7ef7b3d698e0aae5d8b463a59b96c69b663ba4e77896d22
+  metadata.gz: ea0fe2d521164f1386c4d616a2d8a539265c575af18789184672578711207289b506f67b4ed13fa52768389f8df496561206ea7ca73cdb43793f2f31a66dcd6e
+  data.tar.gz: 22fcaa2bf3f0c58f565cf055c214ac993cc59b8ea45ff0523d5895060a7adf6cb475bb3db0ec90dbfd22dc8772241c0ee02f5338afb01b7626125f4811ab80c1

data/README.md

@@ -1,9 +1,120 @@
-# CodeMonitor
+# 🖥️ CodeMonitor
 
 A engine to collect multiple metrics from your repository and push them to a
 time series provider.
 
 
-# Inspiration
+# Engines
 
-https://github.com/scribd/github-action-datadog-reporting
+## Git
+
+Collect multiple metrics from the a Git repository.
+
+**Requirements / Setup**:
+
+You need a `.git` folder present in the current folder: 
+
+**Options**:
+
+`CODEMONITOR_GIT_FILES_THRESHOLD`: Don't emit metrics about number of files, from those that are above of this threshold. (Default: `0`)
+
+## Eslint
+
+Collect multiple metrics from the a project with [Eslint](https://eslint.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `.eslintrc.js` and a `eslint.output.json` file present in the current folder.
+
+You can generate the `eslint.output.json` file with this example command:
+
+```
+eslint -f json -o eslint.output.json
+```
+**Options**:
+
+`CODEMONITOR_ESLINT_THRESHOLD`: Don't emit metrics about eslint rules that are above of this threshold. (Default: `10`)
+
+
+## Npm
+
+Collect multiple metrics from the a NodeJS.
+
+**Requirements / Setup**:
+
+You need a `package.json` file present in the current folder.
+
+## Packwerk
+
+Collect multiple metrics from the a Ruby project with [Packwerk](https://github.com/Shopify/packwerk) configured.
+
+**Requirements / Setup**:
+
+You need a `deprecated_references.yml` files present in the current project.
+
+## Rubocop
+
+Collect multiple metrics from the a Ruby project with [Rubocop](https://github.com/rubocop/rubocop) configured.
+
+**Requirements / Setup**:
+
+You need a `.rubocop.yml` and a `rubocop.output.json` file present in the current folder.
+
+You can generate the `rubocop.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_RUBOCOP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+
+## Semgrep
+
+Collect multiple metrics from the a with [Semgrep](https://semgrep.dev/) configured.
+
+**Requirements / Setup**:
+
+You need a `.semgrep.yml` and a `semgrep.output.json` file present in the current folder.
+
+You can generate the `semgrep.output.json` file with this example command:
+
+```
+semgrep --json -o semgrep.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_SEMGREP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+## Sorbet
+
+Collect multiple metrics from the a with [Sorbet](https://sorbet.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `sorbet.output.json` file present in the current folder.
+
+You can generate the `sorbet.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+# Providers
+
+## Console
+
+TODO
+
+## Datadog
+
+TODO
+
+# Contribute
+
+This project started as a side project, so I'm sure that is full
+of mistakes and areas to be improve. If you think you can tweak the code to
+make it better, I'll really appreciate a pull request. ;)

data/engines/custom/extractor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Engines
+  module Custom
+    class Extractor
+      def call(provider)
+        return unless requirements?
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        custom_files.length.positive?
+      end
+
+      def custom_files
+        Dir.glob('./.codemonitor/*.rb')
+      end
+
+      def metrics
+        custom_files.map do |file|
+          values = begin
+            eval File.read(file)
+          rescue SyntaxError => e
+            raise "Unable to execute the custom codemonitor script `#{file}` file"
+          end
+
+          raise "Malformed return value from `#{file}` file. It must be a hash of metrics" unless values.is_a?(Hash)
+
+          values
+        end.reduce({}, :merge)
+      end
+    end
+  end
+end

data/exe/codemonitor

@@ -12,6 +12,7 @@ require_relative '../engines/packwerk/extractor'
 require_relative '../engines/rubocop/extractor'
 require_relative '../engines/semgrep/extractor'
 require_relative '../engines/sorbet/extractor'
+require_relative '../engines/custom/extractor'
 
 PROVIDERS = {
   console: Providers::Console,
@@ -26,7 +27,8 @@ EXTRACTORS = {
   packwerk: Engines::Packwerk::Extractor,
   rubocop: Engines::Rubocop::Extractor,
   semgrep: Engines::Semgrep::Extractor,
-  sorbet: Engines::Sorbet::Extractor
+  sorbet: Engines::Sorbet::Extractor,
+  custom: Engines::Custom::Extractor
 }.freeze
 
 config_provider = ENV['CODEMONITOR_PROVIDER'] || 'console'

data/lib/codemonitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeMonitor
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -115,6 +115,7 @@ files:
 - bin/console
 - bin/setup
 - codemonitor.gemspec
+- engines/custom/extractor.rb
 - engines/debug/extractor.rb
 - engines/eslint/extractor.rb
 - engines/git/extractor.rb