Merge branch 'next' into docs/fix-see-also

Author: ST-DDT

.github/workflows/ci.yml

@@ -110,7 +110,8 @@ jobs:
 
   e2e-test:
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    container: cypress/browsers:node18.12.0-chrome107
+    timeout-minutes: 10
     name: 'E2E Doc Test: node-18, ubuntu-latest'
     steps:
       - name: Checkout
@@ -121,11 +122,6 @@ jobs:
         with:
           version: 7
 
-      - name: Set node version to 18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
       - name: Install deps
         run: pnpm install
 
@@ -134,11 +130,6 @@ jobs:
 
       - id: e2e
         name: Run e2e
-        run: timeout 5m pnpm run docs:test:e2e:run
-        continue-on-error: true
-
-      - name: Run e2e (2nd attempt)
-        if: ${{ steps.e2e.outcome != 'success' }}
         run: pnpm run docs:test:e2e:run
 
   lint:

docs/guide/upgrading.md

@@ -103,11 +103,20 @@ The `faker.address.*` methods will continue to work as an alias in v8 and v9, bu
 The number-related methods previously found in `faker.datatype` have been moved to a new `faker.number` module.
 For the old `faker.datatype.number` method you should replace with `faker.number.int` or `faker.number.float` depending on the precision required.
 
-    faker.datatype.number() //35
-    faker.datatype.int() //35
-
-    faker.datatype.number({precision:0.01}) //35.21
-    faker.datatype.float({precision:0.01}) //35.21
+By default, `faker.number.float` no longer defaults to a precision of 0.01
+
+```js
+// OLD
+faker.datatype.number({ max: 100 }); // 35
+faker.datatype.number({ max: 100, precision: 0.01 }); // 35.21
+faker.datatype.float({ max: 100 }); // 35.21
+faker.datatype.float({ max: 100, precision: 0.001 }); // 35.211
+
+// NEW
+faker.number.int({ max: 100 }); // 35
+faker.number.float({ max: 100 }); // 35.21092065742612
+faker.number.float({ max: 100, precision: 0.01 }); // 35.21
+```
 
 | Old method              | New method                                 |
 | ----------------------- | ------------------------------------------ |

package.json

@@ -90,8 +90,8 @@
     "@types/sanitize-html": "~2.8.0",
     "@types/semver": "~7.3.13",
     "@types/validator": "~13.7.10",
-    "@typescript-eslint/eslint-plugin": "~5.48.2",
-    "@typescript-eslint/parser": "~5.48.2",
+    "@typescript-eslint/eslint-plugin": "~5.49.0",
+    "@typescript-eslint/parser": "~5.49.0",
     "@vitest/coverage-c8": "~0.27.3",
     "@vitest/ui": "~0.27.3",
     "@vueuse/core": "~9.11.1",
@@ -126,7 +126,7 @@
     "vitest": "~0.27.3",
     "vue": "~3.2.45"
   },
-  "packageManager": "pnpm@7.25.1",
+  "packageManager": "pnpm@7.26.2",
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
     "npm": ">=6.14.13"

pnpm-lock.yaml

@@ -7,13 +7,10 @@ import Twister from './twister';
  */
 export interface Mersenne {
   /**
-   * Generates a random number between `[min, max)`. The result is already floored.
-   *
-   * @param options The options to generate a random number.
-   * @param options.min The minimum number.
-   * @param options.max The maximum number.
+   * Generates a random float between `[0, 1)`.
+   * This method is called `next` so that it could be used as an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterator_protocol)
    */
-  next(options: { max: number; min: number }): number;
+  next(): number;
 
   /**
    * Sets the seed to use.
@@ -34,10 +31,9 @@ export default function mersenne(): Mersenne {
   twister.initGenrand(Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER));
 
   return {
-    next({ min, max }): number {
-      return Math.floor(twister.genrandReal2() * (max - min) + min);
+    next(): number {
+      return twister.genrandReal2();
     },
-
     seed(seed: number | number[]): void {
       if (typeof seed === 'number') {
         twister.initGenrand(seed);

src/internal/mersenne/mersenne.ts

@@ -377,7 +377,7 @@ export class ColorModule {
 
     color = Array.from({ length: 3 }, () => this.faker.number.int(255));
     if (includeAlpha) {
-      color.push(this.faker.number.float());
+      color.push(this.faker.number.float({ precision: 0.01 }));
       cssFunction = 'rgba';
     }
 
@@ -458,7 +458,7 @@ export class ColorModule {
   }): string | number[];
   cmyk(options?: { format?: ColorFormat }): string | number[] {
     const color: string | number[] = Array.from({ length: 4 }, () =>
-      this.faker.number.float()
+      this.faker.number.float({ precision: 0.01 })
     );
     return toColorFormat(color, options?.format || 'decimal', 'cmyk');
   }
@@ -568,7 +568,7 @@ export class ColorModule {
   }): string | number[] {
     const hsl: number[] = [this.faker.number.int(360)];
     for (let i = 0; i < (options?.includeAlpha ? 3 : 2); i++) {
-      hsl.push(this.faker.number.float());
+      hsl.push(this.faker.number.float({ precision: 0.01 }));
     }
 
     return toColorFormat(
@@ -674,7 +674,7 @@ export class ColorModule {
   }): string | number[] {
     const hsl: number[] = [this.faker.number.int(360)];
     for (let i = 0; i < 2; i++) {
-      hsl.push(this.faker.number.float());
+      hsl.push(this.faker.number.float({ precision: 0.01 }));
     }
 
     return toColorFormat(hsl, options?.format || 'decimal', 'hwb');

src/modules/color/index.ts

@@ -81,8 +81,8 @@ export class NumberModule {
     const mersenne: Mersenne =
       // @ts-expect-error: access private member field
       this.faker._mersenne;
-
-    return mersenne.next({ min: effectiveMin, max: effectiveMax + 1 });
+    const real = mersenne.next();
+    return Math.floor(real * (effectiveMax + 1 - effectiveMin) + effectiveMin);
   }
 
   /**
@@ -91,13 +91,13 @@ export class NumberModule {
    * @param options Upper bound or options object. Defaults to `{}`.
    * @param options.min Lower bound for generated number. Defaults to `0.0`.
    * @param options.max Upper bound for generated number. Defaults to `1.0`.
-   * @param options.precision Precision of the generated number. Defaults to `0.01`.
+   * @param options.precision Precision of the generated number, for example `0.01` will round to 2 decimal points.
    *
    * @example
-   * faker.number.float() // 0.89
-   * faker.number.float(3) // 1.14
-   * faker.number.float({ min: -1000000 }) // -823469.91
-   * faker.number.float({ max: 100 }) // 27.28
+   * faker.number.float() // 0.5688541042618454
+   * faker.number.float(3) // 2.367973240558058
+   * faker.number.float({ min: -1000000 }) //-780678.849672846
+   * faker.number.float({ max: 100 }) // 17.3687307164073
    * faker.number.float({ precision: 0.1 }) // 0.9
    * faker.number.float({ min: 10, max: 100, precision: 0.001 }) // 35.415
    *
@@ -133,7 +133,7 @@ export class NumberModule {
       };
     }
 
-    const { min = 0, max = 1, precision = 0.01 } = options;
+    const { min = 0, max = 1, precision } = options;
 
     if (max === min) {
       return min;
@@ -143,13 +143,23 @@ export class NumberModule {
       throw new FakerError(`Max ${max} should be greater than min ${min}.`);
     }
 
-    const factor = 1 / precision;
-    const int = this.int({
-      min: min * factor,
-      max: max * factor,
-    });
+    if (precision !== undefined) {
+      if (precision <= 0) {
+        throw new FakerError(`Precision should be greater than 0.`);
+      }
 
-    return int / factor;
+      const factor = 1 / precision;
+      const int = this.int({
+        min: min * factor,
+        max: max * factor,
+      });
+      return int / factor;
+    } else {
+      // @ts-expect-error: access private member field
+      const mersenne: Mersenne = this.faker._mersenne;
+      const real = mersenne.next();
+      return real * (max - min) + min;
+    }
   }
 
   /**