sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: remove cost, document missing options and improve docs (#653)

Browse Source
This commit is contained in:
Simon Lecoq
2021-11-04 19:33:29 -04:00
committed by GitHub
parent e147d2ac32
commit a291e35774
56 changed files with 82 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/quickstart/plugin/metadata.yml vendored
View File

@@ -1,5 +1,4 @@
name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
category: other # Set plugin category ("github", "social" or "other")
supports:
- user # Support users account

2
.github/readme/partials/documentation/compatibility.md vendored
View File

@@ -10,7 +10,7 @@
<tr>
<td nowrap="nowrap"><%- name %></td><%# -%>
<% for (const [plugin] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
<td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= readme.compatibility[plugin] ? "✔️" : "❌" %></td><% } %>
<td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= {true:"✔️", false:"❌", embed:"✓"}[readme.compatibility[plugin]] %></td><% } %>
</tr><% } %>
<tr>
<td colspan="<%= Object.keys(plugins).length %>"></td>

1
CONTRIBUTING.md
View File

@@ -423,7 +423,6 @@ For example:
Here's an example:
```yaml
name: "🧩 Plugin name (with emoji icon)"
cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
category: github # Plugin category ("github", "social" or "other")
index: ~ # Leave as it (this is used to order plugins on metrics README.md)
supports:

5
source/app/metrics/metadata.mjs
View File

@@ -297,7 +297,10 @@ metadata.template = async function({__templates, name, plugins, logger}) {
supports:meta.supports ?? null,
readme:{
demo:readme.match(/(?<demo><table>[\s\S]*?<[/]table>)/)?.groups?.demo?.replace(/<[/]?(?:table|tr)>/g, "")?.trim() ?? (name === "community" ? '<td align="center" colspan="2">See <a href="/source/templates/community/README.md">documentation</a> 🌍</td>' : "<td></td>"),
compatibility:{...compatibility, base:true},
compatibility:{
...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => value)),
...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => !value).map(([key, _]) => [key, "embed"])),
},
},
check({q, account = "bypass", format = null}) {
//Support check

5
source/plugins/achievements/README.md
View File

@@ -38,7 +38,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
plugin_achievements: yes
plugin_achievements_threshold: B # Display achievements with rank B or higher
plugin_achievements_secrets: yes # Display unlocked secrets achievements
plugin_achievements_ignored: octonaut # Hide octonaut achievement
plugin_achievements_limit: 0 # Display all unlocked achievement matching threshold and secrets params
plugin_achievements_display: compact # Use compact display
plugin_achievements_limit: 0 # Display all unlocked achievements (no limit)
plugin_achievements_ignored: octonaut # Hide "octonaut" achievement
plugin_achievements_only: explorer # Display only "explorer" achievement (don't use with "ignored" option)
```

1
source/plugins/achievements/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🏆 Achievements"
cost: ~5 GraphQL request
category: github
index: 17
supports:

6
source/plugins/activity/README.md
View File

@@ -39,6 +39,10 @@ Use a full `repo` scope token to display **private** events.
# ... other options
plugin_activity: yes
plugin_activity_limit: 5 # Limit to 5 events
plugin_activity_days: 14 # Keep only events from last 14 days (can be set to 0 to disable limitations)
plugin_activity_load: 100 # Load up to 100 recent events from API (should be higher than "limit")
plugin_activity_days: 14 # Keep only events from last 14 days (set to 0 for no limit)
plugin_activity_filter: all # Show all events (use table above to filter events types)
plugin_activity_visibility: public # Only display public events
plugin_activity_timestamps: yes # Display events timestamps
plugin_activity_skipped: repo # Ignored repositories
```

3
source/plugins/activity/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📰 Recent activity"
cost: 1 REST request per 100 events
category: github
index: 16
supports:
@@ -86,4 +85,4 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...

2
source/plugins/anilist/README.md
View File

@@ -35,7 +35,7 @@ These sections can also be filtered by media type, which can be either `anime`,
plugin_anilist_medias: anime, manga # Display both animes and mangas
plugin_anilist_sections: favorites, characters # Display only favorites and characters sections
plugin_anilist_limit: 2 # Limit to 2 entry per section (characters section excluded)
plugin_anilist_limit_characters: 22 # Limit to 22 characters in characters section
plugin_anilist_shuffle: yes # Shuffle data for more varied outputs
plugin_anilist_user: .user.login # Use same username as GitHub login
plugin_anilist_limit_characters: 22 # Limit to 22 characters in characters section
```

1
source/plugins/anilist/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🌸 Anilist watch list and reading list"
cost: N/A
category: social
index: 4
supports:

2
source/plugins/base/README.md
View File

@@ -34,7 +34,9 @@ These are all enabled by default, but you can explicitely opt out from them.
# ... other options
base: header, repositories # Only display "header" and "repositories" sections
repositories: 100 # Query only last 100 repositories
repositories_batch: 25 # Query repositories 25 by 25 (lower this to avoid API timeouts)
repositories_forks: no # Don't include forks
repositories_affiliations: owner, collaborator # Display only repositories where user is owner or collaborator
repositories_skipped: lowlighter/lowlighter # Exclude automatically "lowlighter/lowlighter" repository from plugins allowing a skip list
commits_authoring: octocat@github.com # Handle you use when authoring commits, which can be used to filter commits in other plugins
```

3
source/plugins/base/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🗃️ Base content"
cost: 2 GraphQL requests + 1 GraphQL request per 100 repositories fetched
category: core
supports:
- user
@@ -64,7 +63,7 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...
# List of surnames or email addresses you use when authoring commits
# These are mostly used to perform commits analysis to detect ownership

1
source/plugins/code/README.md
View File

@@ -24,4 +24,5 @@ Display a random code snippet from your recent activity history.
plugin_code_load: 100 # Fetch 100 events from activity
plugin_code_visibility: public # Only display snippets from public activity
plugin_code_skipped: github/octocat # Skip github/octocat repository
plugin_code_languages: javascript # Limit code snippets to JavaScript code
```

5
source/plugins/code/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "♐ Code snippet of the day"
cost: 1 REST request per 100 events fetched
category: github
index: 22
supports:
@@ -44,7 +43,7 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...
# Restrict code snippet languages
# These are guessed through linguist
@@ -53,4 +52,4 @@ inputs:
type: array
format: comma-separated
default: ""
example: javascript, typescript, ....
example: javascript, typescript, ...

6
source/plugins/contributors/README.md
View File

@@ -49,4 +49,10 @@ Matching is performed in keys order.
plugin_contributors_ignored: bot # Ignore "bot" user
plugin_contributors_contributions: yes # Display number of contributions for each contributor
plugin_contributors_sections: contributors # Display contributors sections
plugin_contributors_categories: | # A JSON mapping of labels by files edited
{
"📚 Documentation": ["README.md", "docs/**"],
"💻 Code": ["source/**", "src/**"],
"#️⃣ Others": ["*"]
}
```

1
source/plugins/contributors/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🏅 Repository contributors"
cost: N/A
category: github
index: 5
supports:

1
source/plugins/core/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🧱 Core"
cost: N/A
category: core
supports:
- user

1
source/plugins/discussions/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💬 Discussions"
cost: 1 GraphQL request + 1 GraphQL request per 100 discussions started
category: github
index: 18
supports:

1
source/plugins/followup/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎟️ Follow-up of issues and pull requests"
cost: 0 API request (1 GraphQL request if "user" section is enabled)
category: github
index: 11
supports:

1
source/plugins/gists/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎫 Gists"
cost: 1 GraphQL request per 100 gists
category: github
index: 10
supports:

1
source/plugins/habits/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💡 Coding habits"
cost: 1 REST request per 100 events + 1 REST request per commit
category: github
index: 3
supports:

1
source/plugins/introduction/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🙋 Introduction"
cost: 1 GraphQL request
category: github
index: 2
supports:

1
source/plugins/isocalendar/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📅 Isometric commit calendar"
cost: 1-2 GraphQL requests + 1 GraphQL request per year
category: github
index: 0
supports:

8
source/plugins/languages/README.md
View File

@@ -52,16 +52,18 @@ For better results, it's advised to add either your surnames and eventually no-r
plugin_languages: yes
plugin_languages_ignored: html, css # List of languages to ignore
plugin_languages_skipped: my-test-repo # List of repositories to skip
plugin_languages_limit: 8 # Display up to 8 languages
plugin_languages_sections: most-used, recently-used # Display most used and recently used
plugin_languages_colors: "0:orange, javascript:#ff0000, ..." # Make most used languages orange and JavaScript red
plugin_languages_aliases: "JavaScript:JS, TypeScript:TS, ..." # Customize languages names with aliases
plugin_languages_details: bytes-size, percentage # Additionally display total bytes size and percentage
plugin_languages_threshold: 2% # Hides all languages less than 2%
plugin_languages_limit: 8 # Display up to 8 languages
plugin_languages_sections: most-used, recently-used # Display most used and recently used languages stats
languages stats
plugin_languages_indepth: no # Get indepth stats (see documentation before enabling)
plugin_languages_analysis_timeout: 15 # Set maximum time for indepth analysis
plugin_languages_categories: programming # Display only languages that match these categories in most-used section
plugin_languages_recent_categories: markup, programming, data # Display only languages that match these categories in recently-used section
plugin_languages_recent_load: 500 # Load up to 500 events to compute recently used stats
plugin_languages_recent_days: 7 # Limit recently used stats to last week
commits_authoring: lowlighter@users.noreply.github.com # Surnames or email addresses used to identify your commits
commits_authoring: octocat@users.noreply.github.com # Surnames or email addresses used to identify your commits
```

3
source/plugins/languages/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🈷️ Most used languages"
cost: 0 API request (1 per 100 events fetched when using recently-used section)
category: github
index: 1
supports:
@@ -28,7 +27,7 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...
# Number of languages to display
# Set to 0 to disable limitations

1
source/plugins/licenses/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📜 Repository licenses"
cost: N/A
category: github
index: 4
supports:

1
source/plugins/lines/README.md
View File

@@ -18,4 +18,5 @@ The *lines* of code plugin displays the number of lines of code you have added a
with:
# ... other options
plugin_lines: yes
plugin_lines_skipped: repo # List of skipped repositories
```

3
source/plugins/lines/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "👨‍💻 Lines of code changed"
cost: 1 REST request per repository
category: github
index: 12
supports:
@@ -20,4 +19,4 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...

14
source/plugins/music/README.md
View File

@@ -78,14 +78,14 @@ This mode is not supported for now.
plugin_music: yes
plugin_music_limit: 4 # Limit to 4 entries
plugin_music_playlist: https://******** # Use extracted playlist link
# (plugin_music_provider and plugin_music_mode will be set automatically)
# plugin_music_provider: (will be guessed through plugin_music_playlist)
# plugin_music_mode: (will be set to "playlist" when plugin_music_playlist is provided)
```
### Recently played & top modes
Recently played: Display tracks you have played recently.
Top: Display your top artists/tracks for a certain time period.
- **Recently played**: Display tracks you have played recently.
- **Top**: Display your top artists/tracks for a certain time period.
Select a music provider below for additional instructions.
@@ -198,7 +198,6 @@ Register your API key to finish setup.
plugin_music_limit: 4 # Limit to 4 entries
plugin_music_user: .user.login # Use same username as GitHub login
plugin_music_token: ${{ secrets.LASTFM_API_KEY }}
```
##### Top
@@ -210,8 +209,8 @@ Register your API key to finish setup.
plugin_music: yes
plugin_music_provider: spotify # Use Spotify as provider
plugin_music_mode: top # Set plugin mode
plugin_music_top_type: tracks # Set type for "top" mode; either tracks or artists
plugin_music_limit: 4 # Limit to 4 entries, maximum is 50 for "top" mode with spotify
plugin_music_top_type: tracks # Set type for "top" mode; either tracks or artists
plugin_music_time_range: short # Set time range for "top" mode; either short (4 weeks), medium (6 months) or long (several years)
plugin_music_token: "${{ secrets.SPOTIFY_CLIENT_ID }}, ${{ secrets.SPOTIFY_CLIENT_SECRET }}, ${{ secrets.SPOTIFY_REFRESH_TOKEN }}"
```
@@ -223,10 +222,9 @@ Register your API key to finish setup.
plugin_music: yes
plugin_music_provider: lastfm # Use Last.fm as provider
plugin_music_mode: top # Set plugin mode
plugin_music_top_type: artists # Set type for "top" mode; either tracks or artists
plugin_music_limit: 4 # Limit to 4 entries
plugin_music_top_type: artists # Set type for "top" mode; either tracks or artists
plugin_music_time_range: long # Set time range for "top" mode; either short (4 weeks), medium (6 months) or long (several years)
plugin_music_user: .user.login # Use same username as GitHub login
plugin_music_token: ${{ secrets.LASTFM_API_KEY }}
```

1
source/plugins/music/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎼 Music plugin"
cost: N/A
category: social
index: 2
supports:

1
source/plugins/nightscout/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💉 Nightscout"
cost: N/A
category: other
index: 3
supports:

13
source/plugins/notable/README.md
View File

@@ -5,13 +5,23 @@ The *notable* plugin displays badges of organization where you commited at least
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.svg">
<details open><summary>With repository name</summary>
<details><summary>With repository name</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.repositories.svg">
</details>
<details open><summary>Indepth analysis</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.indepth.svg">
</details>
<img width="900" height="1" alt="">
</td>
</table>
#### Using `indepth` statistics
The `plugin_notable_indepth` option lets you get additional metrics about your contribution, such as:
- Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge.
> 🔣 On web instances, `indepth` is an extra feature and must be enabled globally in `settings.json`
#### ℹ️ Examples workflows
[➡️ Available options for this plugin](metadata.yml)
@@ -24,4 +34,5 @@ The *notable* plugin displays badges of organization where you commited at least
plugin_notable_filter: stars:>500 # Only display repositories with 500 stars or more (syntax based on GitHub search query)
plugin_notable_from: organization # Only display contributions within organization repositories
plugin_notable_repositories: yes # Display repositories name instead of only organization name
plugin_notable_indepth: yes # Gather additional informations about contributions
```

1
source/plugins/notable/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎩 Notable contributions"
cost: 1 GraphQL request per 100 repositories fetched
category: github
index: 20
supports:

1
source/plugins/pagespeed/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "⏱️ Website performances"
cost: N/A
category: social
index: 1
supports:

1
source/plugins/people/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🧑‍🤝‍🧑 People plugin"
cost: 1 GraphQL request per 100 users + 1 REST request per user in "plugin_people_thanks"
category: github
index: 9
supports:

3
source/plugins/posts/README.md
View File

@@ -23,4 +23,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts: yes
plugin_posts_source: dev.to # External source
plugin_people_user: .github.user # Use same username as GitHub login
plugin_posts_limit: 4 # Limit to 4 posts
plugin_posts_descriptions: yes # Display article short description (when supported)
plugin_posts_covers: yes # Display article thumbnail (when supported)
```

1
source/plugins/posts/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "✒️ Recent posts"
cost: N/A
category: social
index: 6
supports:

1
source/plugins/projects/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🗂️ Active projects"
cost: 1 GraphQL request + 1 GraphQL request per repository project
category: github
index: 15
supports:

3
source/plugins/reactions/README.md
View File

@@ -20,7 +20,10 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
plugin_reactions: yes
plugin_reactions_limit: 200 # Compute reactions over last 200 issue comments
plugin_reactions_limit_issues: 100 # Compute reactions over last 100 issues/pull requests opened
plugin_reactions_limit_discussions: 100 # Compute reactions over last 100 discussions
plugin_reactions_limit_discussions_comments: 100 # Compute reactions over last 100 discussions comments
plugin_reactions_days: 14 # Compute reactions on issue comments posted less than 14 days ago
plugin_reactions_display: absolute # Display percentages based on the total amoun fetched
plugin_reactions_details: count, percentage # Display reactions count and percentage
plugin_reactions_ignored: bot # Ignore "bot" user
```

1
source/plugins/reactions/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎭 Comment reactions"
cost: 1 GraphQL request per 100 issues and issues comments fetched
category: github
index: 8
supports:

2
source/plugins/repositories/metadata.yml
View File

@@ -1,6 +1,4 @@
name: "📓 Repositories"
cost: 1 GraphQL request per repository
category: github
index: 21
supports:
- user

1
source/plugins/rss/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🗼 Rss feed"
cost: N/A
category: social
index: 6.5
supports:

1
source/plugins/screenshot/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📸 Website screenshot"
cost: N/A
category: other
index: 2
supports:

1
source/plugins/skyline/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🌇 GitHub Skyline 3D calendar"
cost: N/A
category: github
index: 24
supports:

1
source/plugins/sponsors/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💕 GitHub Sponsors"
cost: 1 GraphQL request
category: github
index: 23
supports:

1
source/plugins/stackoverflow/README.md
View File

@@ -33,4 +33,5 @@ Your user id will be in both url and search bar.
plugin_stackoverflow_sections: answers-top, questions-recent # Display top answers and recent questions
plugin_stackoverflow_limit: 2 # Display 2 entries per section
plugin_stackoverflow_lines: 4 # Display 4 lines per entry
plugin_stackoverflow_lines_snippet: 2 # Display 2 lines in embed code snippets
```

1
source/plugins/stackoverflow/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🗨️ Stackoverflow plugin"
cost: N/A
category: social
index: 5
supports:

1
source/plugins/stargazers/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "✨ Stargazers over last weeks"
cost: 1 GraphQL request per 100 stargazers
category: github
index: 14
supports:

1
source/plugins/stars/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🌟 Recently starred repositories"
cost: 1 GraphQL request
category: github
index: 6
supports:

1
source/plugins/stock/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💹 Stock prices"
cost: N/A
category: other
index: 1
supports:

1
source/plugins/support/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "💭 GitHub Community Support"
cost: N/A
category: github
index: 19
supports:

6
source/plugins/topics/README.md
View File

@@ -6,8 +6,8 @@ Check out [GitHub topics](https://github.com/topics) to search interesting topic
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg">
<details open><summary>Mastered and known technologies version</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.mastered.svg">
<details open><summary>With icons instead</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.icons.svg">
</details>
<img width="900" height="1" alt="">
</td>
@@ -25,6 +25,6 @@ This uses puppeteer to navigate through your starred topics page.
# ... other options
plugin_topics: yes
plugin_topics_sort: stars # Sort by most starred topics
plugin_topics_mode: mastered # Display icons instead of labels
plugin_topics_mode: icons # Display icons instead of labels
plugin_topics_limit: 0 # Disable limitations
```

1
source/plugins/topics/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📌 Starred topics"
cost: N/A
category: github
index: 7
supports:

1
source/plugins/traffic/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🧮 Repositories traffic"
cost: 1 REST request per repository
category: github
index: 13
supports:

1
source/plugins/tweets/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🐤 Latest tweets"
cost: N/A
category: social
index: 3
supports:

1
source/plugins/wakatime/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "⏰ WakaTime plugin"
cost: N/A
category: social
index: 7
supports: