feat(locale): add directions and directions abbr to pl

[hankucz]

No description provided.

[codecov]

Codecov Report

Merging #1225 (67d11d8) into main (5585869) will increase coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 67d11d8 differs from pull request most recent head 1fefd2d. Consider uploading reports for the commit 1fefd2d to get more accurate results

@@            Coverage Diff             @@
##             main    #1225      +/-   ##
==========================================
+ Coverage   99.62%   99.63%   +0.01%     
==========================================
  Files        2154     2156       +2     
  Lines      239914   239940      +26     
  Branches     1003     1008       +5     
==========================================
+ Hits       239015   239066      +51     
+ Misses        878      853      -25     
  Partials       21       21              

Impacted Files	Coverage Δ
src/locales/pl/address/direction.ts	100.00% <100.00%> (ø)
src/locales/pl/address/direction_abbr.ts	100.00% <100.00%> (ø)
src/locales/pl/address/index.ts	100.00% <100.00%> (ø)
src/modules/internet/user-agent.ts	88.35% <0.00%> (+6.61%)	⬆️

[ejcheng]

Translations verified using Google Translate, lgtm

[ST-DDT]

The order of the elements is somewhat important:

faker/src/modules/address/index.ts

Lines 411 to 453 in 04c9d36

	/**
	* Returns a random cardinal direction (north, east, south, west).
	*
	* @param useAbbr If true this will return abbreviated directions (N, E, etc).
	* Otherwise this will return the long name. Defaults to `false`.
	*
	* @example
	* faker.address.cardinalDirection() // 'North'
	* faker.address.cardinalDirection(false) // 'South'
	* faker.address.cardinalDirection(true) // 'N'
	*/
	cardinalDirection(useAbbr: boolean = false): string {
	if (!useAbbr) {
	return this.faker.helpers.arrayElement(
	this.faker.definitions.address.direction.slice(0, 4)
	);
	}
	return this.faker.helpers.arrayElement(
	this.faker.definitions.address.direction_abbr.slice(0, 4)
	);
	}
	/**
	* Returns a random ordinal direction (northwest, southeast, etc).
	*
	* @param useAbbr If true this will return abbreviated directions (NW, SE, etc).
	* Otherwise this will return the long name. Defaults to `false`.
	*
	* @example
	* faker.address.ordinalDirection() // 'Northeast'
	* faker.address.ordinalDirection(false) // 'Northwest'
	* faker.address.ordinalDirection(true) // 'NE'
	*/
	ordinalDirection(useAbbr: boolean = false): string {
	if (!useAbbr) {
	return this.faker.helpers.arrayElement(
	this.faker.definitions.address.direction.slice(4, 8)
	);
	}
	return this.faker.helpers.arrayElement(
	this.faker.definitions.address.direction_abbr.slice(4, 8)
	);
	}

0-3 => cardinal direction
4-7 => ordinal direction

[pkuczynski]

Wow! I would never expect this and it's really hard to catch on the review. It would be way better if TS could catch it automatically...

Should we change the definition to look more like:

interface Directions {
  cardinal: string[]
  ordinal: string[] // or intercardinal ?
  secondaryIntercardinal?: string[]
}

type DirectionType = keyof Directions

And then both directions and directions_abbr should use this type?

Additionally, I think it makes sense to simplify the usage and change direction signature to:

direction ({ abbr: boolean, type: DirectionType, types: DirectionType[]})

// @examples
faker.address.direction() // 'north'
faker.address.direction({ abbr: true }) // 'N'
faker.address.direction({ type: 'ordinal' }) // 'north west'
faker.address.direction({ abbr: true, type: 'ordinal' }) // 'NW'
faker.address.direction({ abbr: true, types: ['ordinal', 'secondaryIntercardinal']  }) // 'NNW'

And then deprecate the other methods? We might also skip secondaryIntercardinal...

[ST-DDT]

@pkuczynski Please create a separate issue for that.

[pkuczynski]

@pkuczynski Please create a separate issue for that.

Sure! #1228

[ST-DDT]

@hankucz Could you please restore the original order? (N,E,S,W, NE, SE, SW, NW)
That way we can merge this and can easily automatically transform it once we change the implementation.

[hankucz]

@ST-DDT original order restored