Skip to content

Commit

Permalink
Update docs (#9)
Browse files Browse the repository at this point in the history
* Update docs

* update

* try without max_ram relative

* try5

* update

* update default values

* revert tryings

* update parameters

* update
  • Loading branch information
stefanvacareanu7 authored Feb 20, 2025
1 parent 29e36b5 commit 53c01e2
Showing 3 changed files with 25 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2.1

orbs:
codacy: codacy/base@12.1.1
codacy: codacy/base@12.1.4
codacy_plugins_test: codacy/plugins-test@2.0.11

workflows:
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# codacy-lizard

This is the docker engine we use at Codacy to have [lizard](https://github.com/terryyin/lizard) support.
You can also create a docker to integrate the tool and language of your choice!
Check the **Docs** section for more information.

## Docs

[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)

[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)

## Test

We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.
You can follow the instructions there to make sure your tool is working as expected.

## What is Codacy

[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
18 changes: 9 additions & 9 deletions docs/patterns.json
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@
"default": 50
}
],
"enabled": true
"enabled": false
},
{
"patternId": "nloc-critical",
@@ -57,7 +57,7 @@
"parameters": [
{
"name": "threshold",
"default": 4
"default": 5
}
],
"enabled": false
@@ -72,10 +72,10 @@
"parameters": [
{
"name": "threshold",
"default": 7
"default": 8
}
],
"enabled": true
"enabled": false
},
{
"patternId": "ccn-critical",
@@ -87,7 +87,7 @@
"parameters": [
{
"name": "threshold",
"default": 10
"default": 12
}
],
"enabled": true
@@ -102,7 +102,7 @@
"parameters": [
{
"name": "threshold",
"default": 3
"default": 4
}
],
"enabled": false
@@ -117,10 +117,10 @@
"parameters": [
{
"name": "threshold",
"default": 5
"default": 8
}
],
"enabled": true
"enabled": false
},
{
"patternId": "parameter-count-critical",
@@ -132,7 +132,7 @@
"parameters": [
{
"name": "threshold",
"default": 9
"default": 12
}
],
"enabled": true

0 comments on commit 53c01e2

Please sign in to comment.