feat(finance): currency object

[matthewmayer]

fix #1733

[codecov]

Codecov Report

Merging #1809 (a5db4b3) into next (11a5f51) will increase coverage by 0.00%.
The diff coverage is 99.58%.

Additional details and impacted files

@@           Coverage Diff            @@
##             next    #1809    +/-   ##
========================================
  Coverage   99.63%   99.64%            
========================================
  Files        2355     2355            
  Lines      236459   236843   +384     
  Branches     1159     1155     -4     
========================================
+ Hits       235605   235993   +388     
+ Misses        832      828     -4     
  Partials       22       22            

Impacted Files	Coverage Δ
src/definitions/finance.ts	0.00% <0.00%> (ø)
src/definitions/index.ts	0.00% <0.00%> (ø)
src/index.ts	100.00% <100.00%> (ø)
src/locales/el/finance/currency.ts	100.00% <100.00%> (ø)
src/locales/en/finance/currency.ts	100.00% <100.00%> (ø)
src/locales/fa/finance/currency.ts	100.00% <100.00%> (ø)
src/locales/fr/finance/currency.ts	100.00% <100.00%> (ø)
src/locales/fr_CH/finance/currency.ts	100.00% <100.00%> (ø)
src/modules/finance/index.ts	100.00% <100.00%> (ø)
src/modules/internet/user-agent.ts	91.12% <0.00%> (-4.74%)	⬇️
... and 2 more

[ST-DDT]

Team Decision

Change the locale data to contain [{ name, code, symbol }]

[matthewmayer]

Sorry, had some issues with my branch so had to force-push

[matthewmayer]

This was my script to transform the definitions:

'use strict';
const fs = require('fs');
const langs = ['en','el', 'fr_CH', 'fr', 'fa'];
const { faker } = require('@faker-js/faker');
for (let lang of langs) {
  let c = faker.locales[lang].finance.currency;
  let newCurr = Object.keys(c).map((k) => {
    return { name: k, code: c[k].code, symbol: c[k].symbol };
  });
  let str = JSON.stringify(newCurr, null, 2);
  fs.writeFileSync(
    `./src/locales/${lang}/finance/currency.ts`,
    `export default ${str}`
  );
}

[ST-DDT]

Please add a random seeded test for the currency object.

[matthewmayer]

add a test of the currency object

added in 844cb20

[matthewmayer]

i think there are a few "currencies" which could be removed e.g.

{
name: 'Codes specifically reserved for testing purposes',
code: 'XTS',
symbol: '',
},

and various metals like Gold, Platinum etc,

Should i include that in this PR or wait and do as a seperate PR

[matthewmayer]

i think there are a few "currencies" which could be removed e.g.

{ name: 'Codes specifically reserved for testing purposes', code: 'XTS', symbol: '', },

and various metals like Gold, Platinum etc,

Should i include that in this PR or wait and do as a seperate PR

comparing https://en.wikipedia.org/wiki/List_of_circulating_currencies with the list i'd suggest the removal of

[
  'CUC', 'EEK', 'HRK', 'LTL',
  'LVL', 'MRO', 'SLL', 'SVC',
  'XAG', 'XAU', 'XBA', 'XBB',
  'XBC', 'XBD', 'XDR', 'XFU',
  'XPD', 'XPT', 'XTS', 'ZWL'
]

and the addition of

[ 'MRU', 'SLE', 'SSP'] (and possibly 'VED' )

these are a variety of currencies which got replaced (e.g. EEK -> EUR), changed (e.g. MRO -> MRU) or are non-currencies (e.g. XTS, XAU).

[ST-DDT]

i think there are a few "currencies" which could be removed e.g.

{ name: 'Codes specifically reserved for testing purposes', code: 'XTS', symbol: '', },

and various metals like Gold, Platinum etc,

Should i include that in this PR or wait and do as a seperate PR

Please do that in a separate PR as the removed entries will be lost within the other changes to the locale definitions.

[ST-DDT]

Other than the re-export and the deprecation this looks good to me.

[matthewmayer]

Other than the re-export and the deprecation this looks good to me.

i added the re-export in 86d1ae0

Not planning to deperecate other methods (per #1809 (comment) ) unless others feel strongly they should be

[ST-DDT]

Lets discuss this in the next team meeting.

[ST-DDT]

Team decision

We won't deprecate the old methods.

---

Then this PR is ready for review and merge.