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

Improve date format in last updated field #168

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Conversation

chacha912
Copy link
Contributor

@chacha912 chacha912 commented Aug 29, 2024

What this PR does / why we need it?

This PR addresses several issues with the date format display in the Last Updated field:

  1. AM/PM indicator is now displayed on the same line as the time.
  2. Year is now included for dates not in the current year.
  3. Fixed the display of 24-hour time format to ensure proper representation.

image

Any background context you want to provide?

What are the relevant tickets?

Fixes #167

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Introduced customizable document update timestamps, allowing users to choose between 24-hour and 12-hour formats.
    • Enhanced date formatting in the document list to omit the year for recent updates, improving readability.
  • Style

    • Updated styles for responsive design in document elements, increasing adaptability across different display contexts.

@chacha912 chacha912 requested a review from hackerwins August 29, 2024 08:15
Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes introduced involve enhancements to the display of document timestamps and styling adjustments for improved responsiveness. Specifically, the date formatting logic has been modified to allow for user preference in time display (24-hour or 12-hour format) and to conditionally show the year based on the date's recency. Additionally, the styling for certain elements has been updated to allow for better adaptability in the layout.

Changes

Files Change Summary
src/assets/styles/components/list_document.scss Updated .updated and .size classes to change width to max-width for improved responsiveness.
src/features/documents/DocumentDetail.tsx Introduced user preference for time format (24-hour or 12-hour) in document timestamps.
src/features/documents/DocumentList.tsx Enhanced date formatting logic to conditionally display the year based on whether the date is from the current year.

Assessment against linked issues

Objective Addressed Explanation
Display AM/PM on the same line as the time (#[167])
Include the year for dates not in the current year (#[167])
Correctly display the 24-hour time format (#[167])

Poem

🐰 In the meadow where time hops high,
The clocks now twinkle, oh my, oh my!
With dates that dance in the sun’s warm glow,
A year to remember, or let it go slow.
So cheer for the changes, let joy take flight,
Our documents shine, all day and night! 🌼


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai anywhere in the PR title to generate the title automatically.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.

CodeRabbit Configuration 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
Member

@hackerwins hackerwins left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 92376a5 and 08044b7.

Files selected for processing (3)
  • src/assets/styles/components/list_document.scss (1 hunks)
  • src/features/documents/DocumentDetail.tsx (2 hunks)
  • src/features/documents/DocumentList.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/assets/styles/components/list_document.scss
Additional comments not posted (3)
src/features/documents/DocumentDetail.tsx (2)

21-21: LGTM!

The import statement for selectPreferences is correct and necessary for retrieving user preferences.

The code changes are approved.


Line range hint 28-65: LGTM! But verify the use24HourClock preference.

The implementation correctly retrieves the user preference and applies it to the date formatting logic. However, ensure that the use24HourClock preference is correctly set in the application's state.

The code changes are approved.

Run the following script to verify the use24HourClock preference:

Verification successful

The use24HourClock preference is correctly set and used in the application's state.

The preference is defined and managed in usersSlice.ts, initialized from localStorage, and used consistently across different components for formatting time. This confirms its intended functionality.

  • src/features/users/usersSlice.ts: Initialization and management of use24HourClock.
  • src/features/users/Preferences.tsx: Usage in user preferences.
  • src/features/documents/DocumentList.tsx and DocumentDetail.tsx: Usage in document components.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Test: Search for the `use24HourClock` preference. Expect: Correct setting in the application's state.
rg --type js --type ts --type tsx --type json 'use24HourClock'

Length of output: 90


Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Test: Search for the `use24HourClock` preference. Expect: Correct setting in the application's state.
rg --type js --type ts --type jsx --type json 'use24HourClock'

Length of output: 90


Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Test: Search for the `use24HourClock` preference. Expect: Correct setting in the application's state.
rg 'use24HourClock'

Length of output: 1306

src/features/documents/DocumentList.tsx (1)

214-217: LGTM! But verify the use24HourClock preference.

The implementation correctly updates the date formatting logic to conditionally include the year based on the date's recency. However, ensure that the use24HourClock preference is correctly set in the application's state.

The code changes are approved.

Run the following script to verify the use24HourClock preference:

Verification successful

Verification Successful: use24HourClock Preference is Correctly Set

The use24HourClock preference is correctly set and utilized within the application's state. It is defined in usersSlice.ts and accessed through useAppSelector(selectPreferences) in various components, confirming its proper integration and usage.

  • File: src/features/users/usersSlice.ts
  • Usage: Accessed in Preferences.tsx, DocumentList.tsx, and DocumentDetail.tsx.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Test: Search for the `use24HourClock` preference. Expect: Correct setting in the application's state.
rg --type js --type ts --type tsx --type json 'use24HourClock'

Length of output: 90


Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Test: Search for the `use24HourClock` preference. Expect: Correct setting in the application's state.
rg --type js --type ts --type tsx 'use24HourClock'

Length of output: 78


Script:

#!/bin/bash
# Description: Verify the `use24HourClock` preference is correctly set in the application's state.

# Find all .tsx files and search for the `use24HourClock` preference within them.
fd --extension tsx --exec rg 'use24HourClock' {}
# Also search in .ts and .js files
rg --type js --type ts 'use24HourClock'

Length of output: 2013

@hackerwins hackerwins merged commit fb9a8ae into main Aug 29, 2024
2 checks passed
@hackerwins hackerwins deleted the date-format-ui branch August 29, 2024 08:17
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.

Date Format Improvements in Last Updated Field
2 participants