fix: adds lang count option properly

- adds language count, thanks @novialriptide
- validates language count input
- adds documentation for lang count
- adds lang count in action.yml
- stricter type checks & changes were made
- formatting changes
- updates dependencies
This commit is contained in:
Jovial Joe Jayarson
2023-02-04 17:31:44 +05:30
parent 6e66f34e5a
commit b2db3c3280
6 changed files with 621 additions and 510 deletions

View File

@@ -4,9 +4,7 @@
</center>
# Dev Metrics in Readme [![UnitTests](https://github.com/athul/waka-readme/actions/workflows/testing.yml/badge.svg)](https://github.com/athul/waka-readme/actions/workflows/testing.yml)
<center>
# Dev Metrics in Readme [![Unit Tests](https://github.com/athul/waka-readme/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/athul/waka-readme/actions/workflows/testing.yml) ![Python Version](https://img.shields.io/badge/python-v3.11-blue)
[WakaTime](https://wakatime.com) weekly metrics on your profile readme.
@@ -14,8 +12,6 @@
:speech_balloon: **Forum** | [GitHub discussions][gh_discuss]
</center>
## New to WakaTime?
> Nope? Skip to [prep work](#prep-work).
@@ -32,15 +28,17 @@ Alternatively, you can also fetch data from WakaTime compatible services like [W
## Prep Work
A GitHub repository and a README file is required. We'll be making use of readme in the [profile repository][profile_readme]\*.
A GitHub repository and a `README.md` file is required. We'll be making use of readme in the [profile repository][profile_readme]\*.
- Save the README file after copy-pasting the following special comments. Your dev-metics will show up in between. `waka` here can be replaced by any string as long as you set the `SECTION_NAME` environment variable [as per the Tweaks section](tweaks).
- Save the `README.md` file after copy-pasting the following special comments. Your dev-metics will show up in between.
```md
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->
```
"`waka`" can be replaced by any alphanumeric string with the `SECTION_NAME` environment variable. See the [#tweaks](#tweaks) section for more.
- Navigate to your repo's `Settings > Secrets` and add a new secret _named_ `WAKATIME_API_KEY` with your API key as it's _value_.
> Or use the url <https://github.com/USERNAME/USERNAME/settings/secrets/actions/new> by replacing the `USERNAME` with your own username.
@@ -90,6 +88,7 @@ There are many flags that you can tweak to suit your taste!
| `SHOW_TIME` | `true` | `false`, `true` | Displays the amount of time spent for each language |
| `SHOW_TOTAL` | `false` | `false`, `true` | Show total coding time |
| `SHOW_MASKED_TIME` | `false` | `false`, `true` | Adds total coding time including unclassified languages (overrides: `SHOW_TOTAL`) |
| `LANG_COUNT` | `5` | Any reasonable number | Number of languages to be displayed |
# Example
@@ -117,6 +116,7 @@ jobs:
TIME_RANGE: all_time
SHOW_TIME: true
SHOW_MASKED_TIME: true
LANG_COUNT: 10
```
**`README.md`**