https://github.com/codacy/codacy-faux-pas
https://github.com/codacy/codacy-faux-pas
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codacy/codacy-faux-pas
- Owner: codacy
- Created: 2020-11-17T16:21:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T15:52:46.000Z (almost 3 years ago)
- Last Synced: 2025-02-16T11:28:00.457Z (11 months ago)
- Language: Scala
- Size: 113 KB
- Stars: 0
- Watchers: 12
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# codacy-faux-pas
A standalone tool that converts [Faux Pas](http://fauxpasapp.com/)
diagnostics to Codacy's format.
It allows running Faux Pas either locally or as part of your CI process and then integrating the results into your Codacy workflow. This way, Codacy will present the results coming from Faux Pas alongside all the other code quality information in the dashboards.
## Usage
### Requirements
To get your Faux Pas results into Codacy you'll need to:
- [Enable Faux Pas](https://docs.codacy.com/repositories-configure/configuring-code-patterns/) and configure the corresponding code patterns on your repository **Code patterns** page
- Enable the setting **Run analysis through build server** on your repository **Settings**, tab **General**, **Repository analysis**
- Obtain a [project API token](https://docs.codacy.com/codacy-api/api-tokens/#project-api-tokens)
- Download [coday-faux-pas](https://github.com/codacy/codacy-faux-pas/releases)
### Sending the results to Codacy
Sending the results of running Faux Pas to Codacy involves the steps below, which you can automate in your CI build process:
1. Run Faux Pas
2. Convert the Faux Pas cli output to a format that the Codacy API accepts
3. Send the results to Codacy
4. Finally, signal that Codacy can use the sent results and start a new analysis
> When the option **“Run analysis through build server”** is enabled, the Codacy analysis will not start until you call the endpoint `/2.0/commit/{commitUuid}/resultsFinal` signalling that Codacy can use the sent results and start a new analysis.
With script:
```bash
export PROJECT_TOKEN="YOUR-TOKEN"
export COMMIT="COMMIT-UUID"
export CODACY_URL="CODACY-INSTALLATION-URL" # if not defined https://api.codacy.com will be used
export CODACY_FAUX_PAS_VERSION=0.2.3 # if not defined, latest will be used
fauxpas -o json check | \
.//scripts/send-results.sh # requires a codacy-faux-pas-"" in the current directory
```
Without script (step-by-step):
```bash
export PROJECT_TOKEN="YOUR-TOKEN"
export COMMIT="COMMIT-UUID"
# 1. Run Faux Pas
fauxpas -o json check | \
# 2. Convert the Faux Pas output to a format that the Codacy API accepts
./codacy-faux-pas-"" | \
# 3. Send the results to Codacy
curl -XPOST -L -H "project-token: $PROJECT_TOKEN" \
-H "Content-type: application/json" -d @- \
"https://api.codacy.com/2.0/commit/$COMMIT/issuesRemoteResults"
# 4. Signal that Codacy can use the sent results and start a new analysis
curl -XPOST -L -H "project-token: $PROJECT_TOKEN" \
-H "Content-type: application/json" \
"https://api.codacy.com/2.0/commit/$COMMIT/resultsFinal"
```
For self-hosted installations:
```bash
export PROJECT_TOKEN="YOUR-TOKEN"
export COMMIT="COMMIT-UUID"
export CODACY_URL="CODACY-INSTALLATION-URL"
# 1. Run Faux Pas
fauxpas -o json check | \
# 2. Convert the Faux Pas output to a format that the Codacy API accepts
./codacy-faux-pas-"" | \
# 3. Send the results to Codacy
curl -XPOST -L -H "project-token: $PROJECT_TOKEN" \
-H "Content-type: application/json" -d @- \
"$CODACY_URL/2.0/commit/$COMMIT/issuesRemoteResults"
# 4. Signal that Codacy can use the sent results and start a new analysis
curl -XPOST -L -H "project-token: $PROJECT_TOKEN" \
-H "Content-type: application/json" \
"$CODACY_URL/2.0/commit/$COMMIT/resultsFinal"
```
## Command line flags
`codacy-faux-pas` accepts as command line arguments:
- `--encoding ` or `-e ` - encoding to use when parsing the input (default: `UTF-8`). The encoding should be one of the possible [Java Charsets](https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html#java.nio.charset.Charset).
Example:
```bash
./codacy-faux-pas-"" --encoding LATIN1
```
## Building
##### Compile
`sbt compile`
##### Format
`sbt ";scalafmt;test:scalafmt;sbt:scalafmt"`
##### Tests
`sbt test`
##### Build native image (requires docker)
`sbt "graalvm-native-image:packageBin"`
##### Build fat-jar
`sbt assembly`
##### Update documentation
`sbt doc-generator/run`
## 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.
### Among Codacy’s features:
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.
### Free for Open Source
Codacy is free for Open Source projects.