refactor(locale)!: remove location data index-value-binding (#2476)

Author: xDivisionByZerox

docs/guide/upgrading_v9/2476.md

@@ -0,0 +1,12 @@
+### Direction definitions reorganized
+
+The locale definitions used by `faker.location.direction()`, `faker.location.cardinalDirection()` and `faker.location.ordinalDirection()` have been reorganized.
+Previously, they were organized under `definitions.location.direction` and `definitions.location.direction_abbr` and where values were required to be in a specific order.
+Now, all values are nested under `definitions.location.direction` with descriptive property names.
+If you are using the public methods, no changes are required.
+You only need to change your code if you are accessing the raw definitions e.g. in `faker.helpers.fake()`.
+
+| Before                    | After                                                                   |
+| ------------------------- | ----------------------------------------------------------------------- |
+| `location.direction`      | `location.direction.cardinal` or `location.direction.ordinal`           |
+| `location.direction_abbr` | `location.direction.cardinal_abbr` or `location.direction.ordinal_abbr` |

src/definitions/location.ts

@@ -65,13 +65,31 @@ export type LocationDefinition = LocaleEntry<{
    * The names of the compass directions.
    * First the 4 cardinal directions, then the 4 ordinal directions.
    */
-  direction: string[];
+  direction: {
+    /**
+     * The names of the cardinal compass directions.
+     * Cardinal directions are the four main points of a compass.
+     */
+    cardinal: string[];
 
-  /**
-   * The abbreviated names of the compass directions.
-   * First the 4 cardinal directions, then the 4 ordinal directions.
-   */
-  direction_abbr: string[];
+    /**
+     * The abbreviated names of the cardinal compass directions.
+     * Cardinal directions are the four main points of a compass.
+     */
+    cardinal_abbr: string[];
+
+    /**
+     * The names of ordinal compass directions.
+     * Ordinal directions are combinations of cardinal directions.
+     */
+    ordinal: string[];
+
+    /**
+     * The abbreviated names of ordinal compass directions.
+     * Ordinal directions are combinations of cardinal directions.
+     */
+    ordinal_abbr: string[];
+  };
 
   /**
    * The pattern used to generate building numbers. Since building numbers rarely start with 0, any consecutive # characters will be replaced by a number without a leading zero.

src/locales/da/location/direction.ts

@@ -1,10 +1,6 @@
-export default [
-  'Nord',
-  'Øst',
-  'Syd',
-  'Vest',
-  'Nordøst',
-  'Nordvest',
-  'Sydøst',
-  'Sydvest',
-];
+export default {
+  cardinal: ['Nord', 'Øst', 'Syd', 'Vest'],
+  cardinal_abbr: ['N', 'Ø', 'S', 'V'],
+  ordinal: ['Nordøst', 'Nordvest', 'Sydøst', 'Sydvest'],
+  ordinal_abbr: ['NØ', 'NV', 'SØ', 'SV'],
+};

src/locales/da/location/direction_abbr.ts

@@ -8,7 +8,6 @@ import city_name from './city_name';
 import city_pattern from './city_pattern';
 import country from './country';
 import direction from './direction';
-import direction_abbr from './direction_abbr';
 import postcode from './postcode';
 import secondary_address from './secondary_address';
 import street_address from './street_address';
@@ -21,7 +20,6 @@ const location: LocationDefinition = {
   city_pattern,
   country,
   direction,
-  direction_abbr,
   postcode,
   secondary_address,
   street_address,

src/locales/da/location/index.ts

@@ -1,10 +1,6 @@
-export default [
-  'North',
-  'East',
-  'South',
-  'West',
-  'Northeast',
-  'Northwest',
-  'Southeast',
-  'Southwest',
-];
+export default {
+  cardinal: ['North', 'East', 'South', 'West'],
+  cardinal_abbr: ['N', 'E', 'S', 'W'],
+  ordinal: ['Northeast', 'Northwest', 'Southeast', 'Southwest'],
+  ordinal_abbr: ['NE', 'NW', 'SE', 'SW'],
+};

src/locales/en/location/direction.ts

@@ -11,7 +11,6 @@ import city_suffix from './city_suffix';
 import country from './country';
 import county from './county';
 import direction from './direction';
-import direction_abbr from './direction_abbr';
 import postcode from './postcode';
 import secondary_address from './secondary_address';
 import state from './state';
@@ -30,7 +29,6 @@ const location: LocationDefinition = {
   country,
   county,
   direction,
-  direction_abbr,
   postcode,
   secondary_address,
   state,

src/locales/en/location/direction_abbr.ts

@@ -1,10 +1,6 @@
-export default [
-  'nordo',
-  'oriento',
-  'sudo',
-  'okcidento',
-  'nordoriento',
-  'nordokcidenta',
-  'sudoriento',
-  'sudokcidento',
-];
+export default {
+  cardinal: ['nordo', 'oriento', 'sudo', 'okcidento'],
+  cardinal_abbr: ['N', 'E', 'S', 'U'],
+  ordinal: ['nordoriento', 'nordokcidenta', 'sudoriento', 'sudokcidento'],
+  ordinal_abbr: ['NE', 'NU', 'SE', 'SU'],
+};