Skip to content

Normative: Add [[CompactDisplay]] slot to Intl.PluralRules #1019

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.

Sign up for GitHub

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

Merged
ben-allen merged 3 commits into from
Oct 22, 2025
Merged

Normative: Add [[CompactDisplay]] slot to Intl.PluralRules #1019

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bcefff8
Normative: Add [[CompactDisplay]] slot to Intl.PluralRules
ben-allen Aug 8, 2025
73865be
Update spec/pluralrules.html
ben-allen Aug 12, 2025
c85b34b
restore parameters for PluralRuleSelect and PluralRuleSelectRange, re…
ben-allen Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions spec/pluralrules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <h1>Intl.PluralRules ( [ _locales_ [ , _options_ ] ] )</h1>

<emu-alg>
1. If NewTarget is *undefined*, throw a *TypeError* exception.
1. Let _pluralRules_ be ? OrdinaryCreateFromConstructor(NewTarget, *"%Intl.PluralRules.prototype%"*, « [[InitializedPluralRules]], [[Locale]], [[Type]], [[Notation]], [[MinimumIntegerDigits]], [[MinimumFractionDigits]], [[MaximumFractionDigits]], [[MinimumSignificantDigits]], [[MaximumSignificantDigits]], [[RoundingType]], [[RoundingIncrement]], [[RoundingMode]], [[ComputedRoundingPriority]], [[TrailingZeroDisplay]] »).
1. Let _pluralRules_ be ? OrdinaryCreateFromConstructor(NewTarget, *"%Intl.PluralRules.prototype%"*, « [[InitializedPluralRules]], [[Locale]], [[Type]], [[Notation]], [[CompactDisplay]], [[MinimumIntegerDigits]], [[MinimumFractionDigits]], [[MaximumFractionDigits]], [[MinimumSignificantDigits]], [[MaximumSignificantDigits]], [[RoundingType]], [[RoundingIncrement]], [[RoundingMode]], [[ComputedRoundingPriority]], [[TrailingZeroDisplay]] »).
1. Let _optionsResolution_ be ? ResolveOptions(%Intl.PluralRules%, %Intl.PluralRules%.[[LocaleData]], _locales_, _options_, « ~coerce-options~ »).
1. Set _options_ to _optionsResolution_.[[Options]].
1. Let _r_ be _optionsResolution_.[[ResolvedLocale]].
Expand All @@ -29,6 +29,9 @@ <h1>Intl.PluralRules ( [ _locales_ [ , _options_ ] ] )</h1>
1. Let _notation_ be ? GetOption(_options_, *"notation"*, ~string~, « *"standard"*, *"scientific"*, *"engineering"*, *"compact"* », *"standard"*).
1. Set _pluralRules_.[[Notation]] to _notation_.
1. Perform ? SetNumberFormatDigitOptions(_pluralRules_, _options_, 0, 3, _notation_).
1. Let _compactDisplay_ be ? GetOption(_options_, *"compactDisplay"*, ~string~, « *"short"*, *"long"* », *"short"*).
1. If _notation_ is *"compact"*, then
1. Set _pluralRules_.[[CompactDisplay]] to _compactDisplay_.
1. Return _pluralRules_.
Comment thread
ben-allen marked this conversation as resolved.
</emu-alg>
</emu-clause>
Expand Down Expand Up @@ -149,6 +152,11 @@ <h1>Intl.PluralRules.prototype.resolvedOptions ( )</h1>
<td>*"notation"*</td>
<td></td>
</tr>
<tr>
<td>[[CompactDisplay]]</td>
<td>*"compactDisplay"*</td>
<td></td>
</tr>
<tr>
<td>[[MinimumIntegerDigits]]</td>
<td>*"minimumIntegerDigits"*</td>
Expand Down Expand Up @@ -252,6 +260,7 @@ <h1>Properties of Intl.PluralRules Instances</h1>
<li>[[Locale]] is a String value with the language tag of the locale whose localization is used by the plural rules.</li>
<li>[[Type]] is one of the String values *"cardinal"* or *"ordinal"*, identifying the plural rules used.</li>
<li>[[Notation]] is one of the String values *"standard"*, *"scientific"*, *"engineering"*, or *"compact"*, identifying the notation used.</li>
<li>[[CompactDisplay]] is one of the String values *"short"* or *"long"*, specifying whether to display compact notation affixes in short form ("5K") or long form ("5 thousand") if formatting with the *"compact"* notation, as this can in some cases influence plural form selection. It is only used when [[Notation]] has the value *"compact"*.</li>
<li>[[MinimumIntegerDigits]] is a non-negative integer indicating the minimum integer digits to be used.</li>
<li>[[MinimumFractionDigits]] and [[MaximumFractionDigits]] are non-negative integers indicating the minimum and maximum fraction digits to be used. Numbers will be rounded or padded with trailing zeroes if necessary.</li>
<li>[[MinimumSignificantDigits]] and [[MaximumSignificantDigits]] are positive integers indicating the minimum and maximum fraction digits to be used. Either none or both of these properties are present; if they are, they override minimum and maximum integer and fraction digits.</li>
Expand All @@ -269,15 +278,13 @@ <h1>Abstract Operations for PluralRules Objects</h1>
<emu-clause id="sec-pluralruleselect" type="implementation-defined abstract operation">
<h1>
PluralRuleSelect (
_locale_: a language tag,
_type_: *"cardinal"* or *"ordinal"*,
_notation_: a String,
_pluralRules_: an Intl.PluralRules,
_s_: a decimal String,
): *"zero"*, *"one"*, *"two"*, *"few"*, *"many"*, or *"other"*
</h1>
<dl class="header">
<dt>description</dt>
<dd>The returned String characterizes the plural category of _s_ according to _locale_, _type_, and _notation_.</dd>
<dd>The returned String characterizes the plural category of _s_ according to the effective locale and the internal slots of _pluralRules_: [[Type]], one of the String values *"cardinal"* or *"ordinal"*, [[Notation]], specifying the notation used, and [[CompactDisplay]], specifying whether compact notation affixes are to be displayed in short form or long form.</dd>
</dl>
Comment on lines 280 to 290
Copy link
Copy Markdown
Member

@gibson042 gibson042 Aug 12, 2025

Choose a reason for hiding this comment

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

Are implementations allowed to use other slots of the Intl.PluralRules instance? A significant benefit of narrowly constraining parameters for implementation-defined abstract operations is that it makes clear what details must not affect their behavior.

Copy link
Copy Markdown
Contributor Author

@ben-allen ben-allen Aug 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The headers specify the slots of _pluralRules_ that are used. Is that sufficient to properly restrict slot usage, or is it necessary to restrict them via the parameters list?

Copy link
Copy Markdown
Member

@gibson042 gibson042 Aug 12, 2025

Choose a reason for hiding this comment

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

I'd prefer to do so via parameters, and if those ever get too excessive I'd advocate for introducing a new specialized record type (which here would be something like a Plural Rule Selector Record { [[Type]]: *"cardinal"* or *"ordinal"*, [[Notation]]: a string, [[CompactDisplay]]: *"short"* or *"long"* }).

Copy link
Copy Markdown
Contributor Author

@ben-allen ben-allen Aug 12, 2025

Choose a reason for hiding this comment

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

Just pushed an update restoring the original parameters + the _compactDisplay_ parameter.

additionally: made the assignment to _pluralRules_.[[CompactDisplay]] in the PluralRules constructor non-conditional, since (correct me if I'm wrong) there's no reason not to just let it be *"short"* when using non-compact notations.

</emu-clause>

Expand All @@ -298,27 +305,22 @@ <h1>
1. Return the Record { [[PluralCategory]]: *"other"*, [[FormattedString]]: _s_ }.
1. Let _res_ be FormatNumericToString(_pluralRules_, ℝ(_n_)).
1. Let _s_ be _res_.[[FormattedString]].
1. Let _locale_ be _pluralRules_.[[Locale]].
1. Let _type_ be _pluralRules_.[[Type]].
1. Let _notation_ be _pluralRules_.[[Notation]].
1. Let _p_ be PluralRuleSelect(_locale_, _type_, _notation_, _s_).
1. Let _p_ be PluralRuleSelect(_pluralRules_, _s_).
1. Return the Record { [[PluralCategory]]: _p_, [[FormattedString]]: _s_ }.
</emu-alg>
</emu-clause>

<emu-clause id="sec-pluralruleselectrange" type="implementation-defined abstract operation">
<h1>
PluralRuleSelectRange (
_locale_: a String,
_type_: *"cardinal"* or *"ordinal"*,
_notation_: a String,
_pluralRules_: an Intl.PluralRules,
_xp_: *"zero"*, *"one"*, *"two"*, *"few"*, *"many"*, or *"other"*,
_yp_: *"zero"*, *"one"*, *"two"*, *"few"*, *"many"*, or *"other"*,
): *"zero"*, *"one"*, *"two"*, *"few"*, *"many"*, or *"other"*
</h1>
<dl class="header">
<dt>description</dt>
<dd>It performs an implementation-dependent algorithm to map the <emu-xref href="#sec-pluralruleselect">plural category</emu-xref> String values _xp_ and _yp_, respectively characterizing the start and end of a range, to a resolved String value for the plural form of the range as a whole denoted by _type_ and _notation_ for the corresponding _locale_, or the String value *"other"*.</dd>
<dd>It performs an implementation-dependent algorithm to map the <emu-xref href="#sec-pluralruleselect">plural category</emu-xref> String values _xp_ and _yp_, respectively characterizing the start and end of a range, to a resolved String value for the plural form of the range as a whole, according to the effective locale and the internal slots of _pluralRules_: [[Type]], one of the String values *"cardinal"* or *"ordinal"*, [[Notation]], specifying the notation used, and [[CompactDisplay]], specifying whether compact notation affixes are displayed in short form or long form. If no such mapping is possible, it returns the String value *"other"*.</dd>
</dl>
</emu-clause>

Expand All @@ -340,10 +342,7 @@ <h1>
1. Let _yp_ be ResolvePlural(_pluralRules_, _y_).
1. If _xp_.[[FormattedString]] is _yp_.[[FormattedString]], then
1. Return _xp_.[[PluralCategory]].
1. Let _locale_ be _pluralRules_.[[Locale]].
1. Let _type_ be _pluralRules_.[[Type]].
1. Let _notation_ be _pluralRules_.[[Notation]].
1. Return PluralRuleSelectRange(_locale_, _type_, _notation_, _xp_.[[PluralCategory]], _yp_.[[PluralCategory]]).
1. Return PluralRuleSelectRange(_pluralRules_, _xp_.[[PluralCategory]], _yp_.[[PluralCategory]]).
</emu-alg>
</emu-clause>
</emu-clause>
Expand Down