Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/themimitoof/black-gl-code-quality
A simple wrapper to convert Black outputs to codeclimate report format for GitLab-CI
https://github.com/themimitoof/black-gl-code-quality
black code-quality codeclimate gitlab gitlab-ci python
Last synced: about 2 months ago
JSON representation
A simple wrapper to convert Black outputs to codeclimate report format for GitLab-CI
- Host: GitHub
- URL: https://github.com/themimitoof/black-gl-code-quality
- Owner: Themimitoof
- License: bsd-3-clause
- Created: 2023-12-07T19:22:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-13T08:47:53.000Z (3 months ago)
- Last Synced: 2024-10-13T15:22:12.974Z (2 months ago)
- Topics: black, code-quality, codeclimate, gitlab, gitlab-ci, python
- Language: Python
- Homepage: https://pypi.org/project/black-gl-code-quality/
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Black GitLab Code Quality
This project aim to convert [Black](https://github.com/psf/black) report to
[CodeClimate](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md)
format that can be ingest by GitLab.
```
→ poetry run black-gl-cq src/black_gl_code_quality | jq
[
{
"type": "issue",
"description": "Black would reformat",
"location": {
"lines": {
"begin": 1,
"end": 1
},
"path": "src/black_gl_code_quality/__main__.py"
},
"severity": "major"
},
{
"type": "issue",
"description": "Black would reformat",
"location": {
"lines": {
"begin": 1,
"end": 1
},
"path": "src/black_gl_code_quality/error.py"
},
"severity": "major"
}
]
```
## Motivation
For security concerns, Docker-in-Docker has been disabled in all GitLab runners that I
have access/manage. Because the Code Quality template shipped with GitLab instances use
CodeClimate CLI that requires a Docker environment, we can't use it and an alternative
solution was required to obtain Black errors in our Code Quality reports.
## How to install
Simply run the following command:
```
pip install black-gl-code-quality
```
If you use Poetry, you can add it to your dev-dependencies:
```
poetry add --group dev black-gl-code-quality
```
## Usage
There is two ways to use this tool:
- by piping Black
- by calling `black-gl-code-quality` (or by it's alias `black-gl-cq`) directly
### Piping with Black
Piping with Black requires to forward `stderr` to `stdout`. You can use the following
command in the `.gitlab-ci.yml`:
```
black --check src/ 2>&1 | black-gl-cq > black-code-quality-report.json
```
Here's an example for a GitLab-CI job:
```yaml
lint:black:
stage: test
script:
- source .venv/bin/activate
- black --check src/ 2>&1 | black-gl-cq > black-code-quality-report.json
artifacts:
when: always
reports:
codequality: black-code-quality-report.json
```
### Calling `black-gl-code-quality` directly
Calling `black-gl-code-quality` (or it's alias `black-gl-cq`) execute Black with the
`--check` argument. It forwards all arguments you pass if you need to configure Black
via the CLI.
Specifying source folders is **MANDATORY**.
Here's an example for a GitLab-CI job:
```yaml
lint:black:
stage: test
script:
- source .venv/bin/activate
- black-gl-cq src/ > black-code-quality-report.json
artifacts:
when: always
reports:
codequality: black-code-quality-report.json
```
Admit we want to skip string normalization:
```yaml
lint:black:
stage: test
script:
- source .venv/bin/activate
- black-gl-cq -S src/ > black-code-quality-report.json
artifacts:
when: always
reports:
codequality: black-code-quality-report.json
```
### Change severity
By default, all errors have the severity `major`. Depending how you consider Black issues
important, you can change the severity for all errors returned by the report by using
one of the following [values](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#issues)
with the `BLACK_GL_SEVERITY` environment variable: `info`, `minor`, `major`, `critical`, `blocker`.
Here's an example for a GitLab-CI job:
```yaml
lint:black:
stage: test
variables:
BLACK_GL_SEVERITY: minor
script:
- source .venv/bin/activate
- black-gl-cq src/ > black-code-quality-report.json
artifacts:
when: always
reports:
codequality: black-code-quality-report.json
```
### Debugging
It is possible to pass the `-v` argument to `black-gl-cq` to stream Black's output to stderr.
Here's an example:
```
$ poetry run black-gl-cq -v src > black-code-quality-report.json
Identified `/home/themimitoof/repos/black-gl-code-quality` as project root containing a .git directory.
Sources to be formatted: "src"
/home/themimitoof/repos/black-gl-code-quality/src/black_gl_code_quality/__init__.py wasn't modified on disk since last run.
/home/themimitoof/repos/black-gl-code-quality/src/black_gl_code_quality/parser.py wasn't modified on disk since last run.
/home/themimitoof/repos/black-gl-code-quality/src/black_gl_code_quality/error.py already well formatted, good job.
/home/themimitoof/repos/black-gl-code-quality/src/black_gl_code_quality/__main__.py already well formatted, good job.
All done! ✨ 🍰 ✨
4 files would be left unchanged.
```
## Contributions
In case you have a suggestion or want a new feature, feel free to open a
[discussion](https://github.com/Themimitoof/black-gl-code-quality/discussions).
If you found a bug, you can [open an issue](https://github.com/Themimitoof/black-gl-code-quality/issues).
In order to maintain an overall good code quality, this project use the following tools:
- [Black](https://github.com/psf/black)
- [Isort](https://github.com/PyCQA/isort)
- [Flake8](https://flake8.pycqa.org/en/latest/)
Linting and formatting tools are configured to match the [current default rules of Black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html).
Please ensure to run these tools before commiting and submiting a Pull request. In case one of
these mentionned tools report an error, the CI will automatically fail.
In case you are able to fix by yourself a bug, enhance the code or implement a new
feature, feel free to send a [Pull request](https://github.com/Themimitoof/black-gl-code-quality/pulls).
## License
This project is released under the [BSD-3 Clause](LICENSE). Feel free to use,
contribute, fork and do what you want with it. Please keep all licenses, copyright
notices and mentions in case you use, re-use, steal, fork code from this repository.