-
Notifications
You must be signed in to change notification settings - Fork 15
feat(utils): measure utils #1211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
View your CI Pipeline Execution ↗ for commit f641ae0
☁️ Nx Cloud last updated this comment at |
@code-pushup/ci
@code-pushup/cli
@code-pushup/core
@code-pushup/create-cli
@code-pushup/models
@code-pushup/nx-plugin
@code-pushup/axe-plugin
@code-pushup/coverage-plugin
@code-pushup/eslint-plugin
@code-pushup/js-packages-plugin
@code-pushup/jsdocs-plugin
@code-pushup/lighthouse-plugin
@code-pushup/typescript-plugin
@code-pushup/utils
commit: |
Code PushUp🤨 Code PushUp report has both improvements and regressions – compared current commit e09ca57 with previous commit 7d3681c. 🕵️ See full comparison in Code PushUp portal 🔍 🏷️ Categories👍 2 groups improved, 👎 1 group regressed, 👍 7 audits improved, 👎 5 audits regressed, 13 audits changed without impacting score🗃️ Groups
31 other groups are unchanged. 🛡️ Audits
654 other audits are unchanged. |
Code PushUp🤨 Code PushUp report has both improvements and regressions – compared current commit e09ca57 with previous commit 7d3681c. 💼 Project
|
| 🏷️ Category | ⭐ Previous score | ⭐ Current score | 🔄 Score change |
|---|---|---|---|
| Documentation | 🔴 36 | 🔴 37 | |
| Code coverage | 🟢 94 | 🟢 95 |
4 other categories are unchanged.
👍 2 groups improved, 👍 4 audits improved, 👎 2 audits regressed, 1 audit changed without impacting score
🗃️ Groups
| 🔌 Plugin | 🗃️ Group | ⭐ Previous score | ⭐ Current score | 🔄 Score change |
|---|---|---|---|---|
| JSDocs coverage | Documentation coverage | 🔴 36 | 🔴 37 | |
| Code coverage | Code coverage metrics | 🟢 94 | 🟢 95 |
13 other groups are unchanged.
🛡️ Audits
| 🔌 Plugin | 🛡️ Audit | 📏 Previous value | 📏 Current value | 🔄 Value change |
|---|---|---|---|---|
| JSDocs coverage | Types coverage | 🟥 59 undocumented types | 🟥 64 undocumented types | |
| JSDocs coverage | Functions coverage | 🟥 246 undocumented functions | 🟥 240 undocumented functions | |
| Code coverage | Line coverage | 🟩 93.8 % | 🟩 94 % | |
| JSDocs coverage | Variables coverage | 🟥 43 undocumented variables | 🟥 47 undocumented variables | |
| Code coverage | Function coverage | 🟩 95.8 % | 🟩 96 % | |
| Code coverage | Branch coverage | 🟩 91.8 % | 🟩 91.8 % | |
| JSDocs coverage | Properties coverage | 🟥 24 undocumented properties | 🟥 23 undocumented properties |
437 other audits are unchanged.
13 other projects are unchanged.
| * cosnt {start, success, error} = apiMeasure('login'); | ||
| * | ||
| * start(); | ||
| * try { | ||
| * cosnt result = myWork(); | ||
| * success(result); | ||
| * return result; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🪡 A couple of typos and formatting inconsistencies:
| * cosnt {start, success, error} = apiMeasure('login'); | |
| * | |
| * start(); | |
| * try { | |
| * cosnt result = myWork(); | |
| * success(result); | |
| * return result; | |
| * const { start, success, error } = apiMeasure('login'); | |
| * | |
| * start(); | |
| * try { | |
| * const result = myWork(); | |
| * success(result); | |
| * return result; |
| * properties: [['action', 'save'], ['duration', 150]] | ||
| * }); | ||
| * // { dataType: 'marker', color: 'primary', tooltipText: 'User action completed', ... } | ||
| * ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🪡 You don't actually need to wrap the @example content into a code block; it's automatically formatted as a code block.
| * ``` | |
| * @example | |
| * const payload = markerPayload({ | |
| * color: 'primary', | |
| * tooltipText: 'User action completed', | |
| * properties: [['action', 'save'], ['duration', 150]] | |
| * }); | |
| * // { dataType: 'marker', color: 'primary', tooltipText: 'User action completed', ... } |
This applies to several JSDocs in this file.
Related to #1197
Example of how it will get used in the profiler: