https://github.com/vinceh121/git-swears

Counts swear words over time in a git repository
https://github.com/vinceh121/git-swears

git java service vertx

Last synced: 2 months ago
JSON representation

Counts swear words over time in a git repository

• Host: GitHub
• URL: https://github.com/vinceh121/git-swears
• Owner: vinceh121
• License: gpl-3.0
• Created: 2020-08-16T13:20:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-27T09:49:03.000Z (6 months ago)
• Last Synced: 2024-07-27T10:54:02.664Z (6 months ago)
• Topics: git, java, service, vertx
• Language: Java
• Homepage: https://swear.vinceh121.me/count.png?width=1024&height=500&type=timelinecum&branch=v2-dev&uri=https://github.com/powercord-org/powercord
• Size: 182 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-swears

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vinceh121/git-swears/Java%20CI%20with%20Maven)

![Most used swear](https://img.shields.io/badge/dynamic/json?color=yellow&label=Most%20used%20swear&query=%24.mostUsed.word&url=https%3A%2F%2Fswear.vinceh121.me%2Fcount.json%3Furi%3Dhttps%3A%2F%2Fgithub.com%2Fvinceh121%2Fgit-swears)

Counts swear words over time in a git repository. Available as a standalone executable and as a service.

## Examples

Cummulative timeline of Powercord:

![Swear count timeline of Powercord](https://swear.vinceh121.me/count.png?width=1024&height=500&type=timelinecum&branch=v2-dev&uri=https://github.com/powercord-org/powercord)

Histogram word count of South Park episode descriptions:

![Swear count histogram of South Park episode descriptions](https://swear.vinceh121.me/count.png?width=600&height=500&uri=https://github.com/wargio/plugin.video.southpark_unofficial&type=histogram&branch=addon-data)

## How to use the service

The JSON endpoint returning the count of swears is the following:

```

https://swear.vinceh121.me/count.json?uri=repo_uri[&branch=branch_name]

```

The endpoint returning PNG images of graphs is the following:

```

https://swear.vinceh121.me/count.png?type=timeline&uri=repo_uri[&branch=branch_name]

```

To know more on the endpoints, see the [wiki](https://github.com/vinceh121/git-swears/wiki/Endpoints)

### Using with shields.io

Using shields.io's dynamic json endpoint you can interface with the service to get beautiful badges, for example:

`https://img.shields.io/badge/dynamic/json?color=yellow&label=Most%20used%20swear&query=%24.mostUsed.word&url=https%3A%2F%2Fswear.vinceh121.me%2Fcount.json%3Furi%3Dhttps%3A%2F%2Fgithub.com%2Fvinceh121%2Fgit-swears`

## How to use the command line

```

usage: git-swears

 -a,--list-graphs        Lists available graph types

 -b,--branch        Git branch to count in

 -g,--graph         Outputs a graph

 -i,--image-type    Image type

 -r,--repo          Path to the git repository

 -s,--swears        Swear list. Either a comma-separated list, or

                         fully qualified URL to a newline-separated list

 -t,--list-image-types   Image type

```

## Build instructions

`mvn compile assembly:single -P `

The following Maven profiles are available:

 - `` builds what's needed to use git-swears as a library

 - `cli` builds the base + the CLI

 - `service` builds the base + the Vert.x service

## Why is the code running this ugly?

You think this is supposed to be a serious project?