keystonejs/keystone-classic

Numeral is not unformatted after a format is called

Open

#4060 opened on Mar 3, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
bughelp wanted

Description

Steps to reproduce the behavior

Call .format() on a money field with a locale set, such as en-gb, then call numeral.format() without defining a locale anywhere else within keystone.

Expected behavior

The new call will be agnostic of the first call occurring, and have no locale.

Actual behavior

The locale is not unset, and all future calls to numeral.format() will use the defined locale, until the locale is reset.

Possible solutions

Move away from numeral, probably to using toLocaleString(). Refactor code so our locale is reset to the default numeral locale ('en') after we have formatted anything. If we take this path, we need to also set a default for all money fields.

Additionally, this holds an impact on how the Number field operates if there is a Money field, and a Money field that sets currency is going to cause numbers to be formatted using the locale unless it is reset afterwards.

I'd also suggest perhaps deprecating the 'money' field. It holds very little functionality, and is likely better to just use the number field for this.

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsKeystone CMSnumeral.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the implementation of the 'money' field in Keystone Classic, likely in the fields directory. The issue describes a locale persistence bug after calling numeral.format(). Possible fixes include resetting the locale to default after each format call or replacing numeral with toLocaleString(). Consider the impact on the Number field and the suggestion to deprecate the money field. Since no one is assigned, a newcomer can propose a pull request with the simplest fix (resetting locale) or start a discussion on the best approach.