Improve specification of Address.countryCode()

[ST-DDT]

faker/src/address.ts

Lines 277 to 288 in 5642470

	/**
	* Returns a random country code.
	*
	* @param alphaCode The code to return. Can be either `'alpha-2'` (2 letter code)
	* or `'alpha-3'` (three letter code). Defaults to `'alpha-2'`.
	*
	* @example
	* faker.address.countryCode() // 'SJ'
	* faker.address.countryCode('alpha-2') // 'GA'
	* faker.address.countryCode('alpha-3') // 'TJK'
	* faker.address.countryCode('unsupported') // 'DJ'
	*/

faker/src/definitions/address.ts

Lines 74 to 81 in 5642470

	/**
	* The ISO-3166-1 ALPHA-2 country codes
	*/
	country_code: string[];
	/**
	* The ISO-3166-1 ALPHA-3 country codes
	*/
	country_code_alpha_3: string[];

Currently it is not clear whether the method should return a country code related to that locale/language or any of the world.
We should decide on either of these and thus adjust the documentation.

Affects:

• src/locales/de_CH/address/country_code.ts (Related to the locale)
• src/locales/fa/address/country_code.ts (Duplicates en)
• src/locales/fr_CH/address/country_code.ts (Related to the locale)
• src/locales/he/address/country_code.ts (Empty/Invalid)
• Respective alpha3 files

If we use "any of the world" these files have to be deleted. ( * -> anyof ['AZ', ..., 'ZY'])
If we use "related to that locale" we have to update them. ( de -> anyof ['CH', 'DE'])

Blocks #609

[ST-DDT]

If we limit it to "related to that locale" ( de -> anyof ['CH', 'DE']), then we have to apply the same logic to some of the other methods too, such as iban generation.

[Shinigami92]

Maybe this issue is so huge, that we should put it on agenda for team meeting 🤔

[ST-DDT]

In our last team meeting we decided to let the locale decide which countries to return.
I will create a PR that removes the invalid files.