Skip to content
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

Add option to display the full time (HH:mm:ss) in the timer view #988

Merged
merged 2 commits into from
Jun 1, 2024

Conversation

thelan
Copy link
Contributor

@thelan thelan commented May 21, 2024

Hello,

Its just a small patch to add an view option to enable the timer to display the full-clock instead of being hardcoded to remove leading zeros.

Let me know if i need to change or optimize things

Copy link
Contributor

coderabbitai bot commented May 21, 2024

Important

Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (3)
  • apps/client/src/common/components/view-params-editor/constants.ts is excluded by none and included by none
  • apps/client/src/features/viewers/common/viewUtils.ts is excluded by none and included by none
  • apps/client/src/features/viewers/timer/Timer.tsx is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Owner

@cpvalente cpvalente left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

The change itself looks good to me, but I am a bit confused with the setup.
Maybe I misunderstood something?

@thelan thelan force-pushed the ft-timer-removeLeadingZero branch from 275786c to c56dd86 Compare May 21, 2024 14:23
@thelan thelan force-pushed the ft-timer-removeLeadingZero branch from c56dd86 to 8b6d0ec Compare May 21, 2024 14:51
@thelan
Copy link
Contributor Author

thelan commented May 21, 2024

Ok so i fixed the typos, also inverted the logic to keep the default setting as it use to be to be.

I think it's fully functional now.
Let me know if i need to change anything more.

PS: I'll look forward to setup a proper environment to deal with node (actually using vim to edit files is pretty limited)

apps/client/src/features/viewers/common/viewUtils.ts Outdated Show resolved Hide resolved
@@ -30,6 +30,14 @@ const hideTimerSeconds: ParamField = {
defaultValue: false,
};

const showLeadingZeros: ParamField = {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all other options are for hiding custom behaviour, should we keep it here as well? I guess we can just default it to true

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I don't know. Usually I prefer keeping the original behavior and use an option to change it.
User updating the app will probably be surprised that the default format of the timer has changed ?

But if you prefer i can reverse the condition to make it the new default

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the variable was to hide, and the default was on, the users wouldnt see a difference.

My suggestion was with the inclination that all the other options are to hide things, so this one is different.

But I guess you may be correct in the idea that it doesnt matter if it is hide / show, what we are doing is changing the default behaviour. In which case your change makes more sense than my proposal. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the text and the default value of the option should be nice to have all the option text to do a "hide function" but i struggle with the boolean parser here:
https://github.com/cpvalente/ontime/blob/master/apps/client/src/features/viewers/common/viewUtils.ts#L32-36

When the parameter is absent from the parameters part in url it will be parsed to "false" thus breaking the default value.
I don't know how to fix this so that's why I inverted the logic from "hide" to "show"

@cpvalente
Copy link
Owner

Thank you @thelan , left some small suggestions and questions for you.

Setting up an environment should be pretty straightforward, you can also use GitHub codespaces in your fork.
If you get into any trouble or the documentation for developers is insufficient please let me know, I would like this to be as easy as possible
https://github.com/cpvalente/ontime/blob/master/DEVELOPMENT.md

@cpvalente
Copy link
Owner

Thank you @thelan , apologies it took so long.
We have been considering whether we should be looking at cleanup the the options for time formatting altogether, but that wont happen at this time

@cpvalente cpvalente merged commit d8626ff into cpvalente:master Jun 1, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants