elastic/kibana

[Field Formats] Duration formatter should handle pluralization for single values

Open

#196,761 opened on Oct 17, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (8,021 forks)batch import
Feature:FieldFormattersTeam:DataDiscoverygood first issueimpact:lowloe:small

Repository metrics

Stars
 (19,065 stars)
PR merge metrics
 (Avg merge 1d 16h) (999 merged PRs in 30d)

Description

Describe the feature:

The Friendly duration formatters should account for singular values. Currently, we only use pluralized formats.

This is where we compute the unit text and join it with the value...

https://github.com/elastic/kibana/blob/89d833bf58ba614a0e9eb6a38a02c4eb5a641aeb/src/plugins/field_formats/common/converters/duration.ts#L134-L137

Here is the list of all values...

https://github.com/elastic/kibana/blob/89d833bf58ba614a0e9eb6a38a02c4eb5a641aeb/src/plugins/field_formats/common/constants/duration_formats.ts#L18-L167

This only applies to the long form text strings and not the shortText strings.

Describe a specific use case for the feature:

Image

Notice 1 seconds should be 1 second.

Pretty simple and low impact but could be nice.

Contributor guide

Research direction
Locate the unit text mapping in duration formats.ts and modify the formatting logic in duration.ts to select singular forms when the value equals 1 for long text strings.
Tech stack
typescript
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85