Merge branch 'main' into drop-json-stringify

Author: ST-DDT

package.json

@@ -96,12 +96,12 @@
     "@algolia/client-search": "~4.14.1",
     "@types/markdown-it": "~12.2.3",
     "@types/node": "~18.0.6",
-    "@types/prettier": "~2.6.3",
+    "@types/prettier": "~2.6.4",
     "@types/react": "~18.0.15",
     "@types/sanitize-html": "~2.6.2",
     "@types/validator": "~13.7.4",
-    "@typescript-eslint/eslint-plugin": "~5.30.7",
-    "@typescript-eslint/parser": "~5.30.7",
+    "@typescript-eslint/eslint-plugin": "~5.31.0",
+    "@typescript-eslint/parser": "~5.31.0",
     "@vitest/ui": "~0.19.1",
     "c8": "~7.12.0",
     "conventional-changelog-cli": "~2.2.2",

pnpm-lock.yaml

@@ -8,53 +8,61 @@ export type AddressDefinitions = LocaleEntry<{
    * Postcodes patterns by state
    */
   postcode_by_state: { [state: string]: { min: number; max: number } };
+
   /**
-   * Postcodes patterns (Fake-Pattern | Fake-Pattern[]).
+   * Postcodes patterns.
    */
   postcode: string | string[];
 
   /**
    * The patterns to generate city names.
    */
   city: string[];
+
   /**
    * The names of actual cities.
    */
   city_name: string[];
+
   /**
-   * Common city prefixes
+   * Common city prefixes.
    */
   city_prefix: string[];
+
   /**
-   * Common city suffixes
+   * Common city suffixes.
    */
   city_suffix: string[];
 
   /**
-   * The names of all countries
+   * The names of all countries.
    */
   country: string[];
+
   /**
-   * The names of this country's states
+   * The names of this country's states.
    */
   state: string[];
+
   /**
-   * The abbreviated names of this country's states
+   * The abbreviated names of this country's states.
    */
   state_abbr: string[];
+
   /**
-   * The names of counties inside the country or state
+   * The names of counties inside the country or state.
    */
   county: string[];
 
   /**
    * The names of the compass directions.
-   * First the 4 cardinal directions, then the 4 ordinal directions
+   * First the 4 cardinal directions, then the 4 ordinal directions.
    */
   direction: string[];
+
   /**
    * The abbreviated names of the compass directions.
-   * First the 4 cardinal directions, then the 4 ordinal directions
+   * First the 4 cardinal directions, then the 4 ordinal directions.
    */
   direction_abbr: string[];
 
@@ -67,16 +75,19 @@ export type AddressDefinitions = LocaleEntry<{
    * The patterns to generate street names.
    */
   street: string[];
+
   /**
    * The names of actual streets.
    */
   street_name: string[];
+
   /**
-   * Common street prefixes
+   * Common street prefixes.
    */
   street_prefix: string[];
+
   /**
-   * Common street suffixes
+   * Common street suffixes.
    */
   street_suffix: string[];
 
@@ -88,6 +99,7 @@ export type AddressDefinitions = LocaleEntry<{
      * The fake pattern to generate only the street address.
      */
     normal: string;
+
     /**
      * The fake pattern to generate the full street address including the secondary address.
      */
@@ -103,11 +115,14 @@ export type AddressDefinitions = LocaleEntry<{
    * The ISO-3166-1 ALPHA-2 country codes related to this locale.
    */
   country_code: string[];
+
   /**
    * The ISO-3166-1 ALPHA-3 country codes related to this locale.
    */
   country_code_alpha_3: string[];
 
-  // A list of timezones names.
+  /**
+   * A list of timezones names.
+   */
   time_zone: string[];
 }>;

src/definitions/address.ts

@@ -1,13 +1,14 @@
 import type { LocaleEntry } from './definitions';
 
 /**
- * The possible definitions related to color.
+ * The possible definitions related to colors.
  */
 export type ColorDefinitions = LocaleEntry<{
   /**
-   * Human readable color names
+   * Human readable color names.
    */
   human: string[];
+
   /**
    * Color space names.
    */

src/definitions/color.ts

@@ -8,10 +8,12 @@ export type CommerceDefinitions = LocaleEntry<{
    * Department names inside a shop.
    */
   department: string[];
+
   /**
    * Product name generation definitions.
    */
   product_name: CommerceProductNameDefinitions;
+
   /**
    * Descriptions for products.
    */
@@ -26,10 +28,12 @@ export interface CommerceProductNameDefinitions {
    * Adjectives describing a product (e.g. tasty).
    */
   adjective: string[];
+
   /**
    * Materials describing a product (e.g. wood).
    */
   material: string[];
+
   /**
    * Types of products (e.g. chair).
    */