refactor!: remove deprecations (#3553)

Author: Shinigami92

README.md

@@ -65,7 +65,7 @@ const { faker } = require('@faker-js/faker');
 export function createRandomUser() {
   return {
     userId: faker.string.uuid(),
-    username: faker.internet.username(), // before version 9.1.0, use userName()
+    username: faker.internet.username(),
     email: faker.internet.email(),
     avatar: faker.image.avatar(),
     password: faker.internet.password(),

docs/api/ApiIndex.vue

@@ -69,13 +69,8 @@ const filtered = computed(() => {
           </h3>
           <ul>
             <li v-for="h of item.headers" :key="h.anchor">
-              <!-- TODO @ST-DDT 2024-09-25: Remove this in v10 -->
               <a
-                :href="
-                  item.link +
-                  '#' +
-                  (h.anchor === 'userName' ? 'username-1' : slugify(h.anchor))
-                "
+                :href="item.link + '#' + slugify(h.anchor)"
                 :class="{ deprecated: h.deprecated }"
                 >{{ h.text }}</a
               >

docs/guide/frameworks.md

@@ -71,7 +71,7 @@ import { faker } from '@faker-js/faker/locale/en';
 
 describe('Testing the application', () => {
   it('should create an account with username and password', () => {
-    let username = faker.internet.username(); // before version 9.1.0, use userName()
+    let username = faker.internet.username();
     let password = faker.internet.password();
     let email = faker.internet.exampleEmail();
 
@@ -111,7 +111,7 @@ test.describe('Testing the application', () => {
   test('should create an account with username and password', async ({
     page,
   }) => {
-    const username = faker.internet.username(); // before version 9.1.0, use userName()
+    const username = faker.internet.username();
     const password = faker.internet.password();
     const email = faker.internet.exampleEmail();
 

src/faker.ts

@@ -1,6 +1,5 @@
 import type { LocaleDefinition, MetadataDefinition } from './definitions';
 import { FakerError } from './errors/faker-error';
-import { deprecated } from './internal/deprecated';
 import type { LocaleProxy } from './internal/locale-proxy';
 import { createLocaleProxy } from './internal/locale-proxy';
 import { AirlineModule } from './modules/airline';
@@ -18,11 +17,9 @@ import { HackerModule } from './modules/hacker';
 import { HelpersModule } from './modules/helpers';
 import { ImageModule } from './modules/image';
 import { InternetModule } from './modules/internet';
-import type { LocationModule as AddressModule } from './modules/location';
 import { LocationModule } from './modules/location';
 import { LoremModule } from './modules/lorem';
 import { MusicModule } from './modules/music';
-import type { PersonModule as NameModule } from './modules/person';
 import { PersonModule } from './modules/person';
 import { PhoneModule } from './modules/phone';
 import { ScienceModule } from './modules/science';
@@ -87,29 +84,6 @@ export class Faker extends SimpleFaker {
   readonly vehicle: VehicleModule = new VehicleModule(this);
   readonly word: WordModule = new WordModule(this);
 
-  // Aliases
-  /** @deprecated Use {@link Faker#location} instead */
-  get address(): AddressModule {
-    deprecated({
-      deprecated: 'faker.address',
-      proposed: 'faker.location',
-      since: '8.0',
-      until: '10.0',
-    });
-    return this.location;
-  }
-
-  /** @deprecated Use {@link Faker#person} instead */
-  get name(): NameModule {
-    deprecated({
-      deprecated: 'faker.name',
-      proposed: 'faker.person',
-      since: '8.0',
-      until: '10.0',
-    });
-    return this.person;
-  }
-
   /**
    * Creates a new instance of Faker.
    *

src/modules/date/index.ts

@@ -160,13 +160,6 @@ export class SimpleDateModule extends SimpleModuleBase {
      */
     to: string | Date | number;
   }): Date {
-    // TODO @matthewmayer 2023-03-27: Consider removing in v10 as this check is only needed in JS
-    if (options == null || options.from == null || options.to == null) {
-      throw new FakerError(
-        'Must pass an options object with `from` and `to` values.'
-      );
-    }
-
     const { from, to } = options;
 
     const fromMs = toDate(from, 'from').getTime();
@@ -234,13 +227,6 @@ export class SimpleDateModule extends SimpleModuleBase {
           max: number;
         };
   }): Date[] {
-    // TODO @matthewmayer 2023-03-27: Consider removing in v10 as this check is only needed in JS
-    if (options == null || options.from == null || options.to == null) {
-      throw new FakerError(
-        'Must pass an options object with `from` and `to` values.'
-      );
-    }
-
     const { from, to, count = 3 } = options;
     return this.faker.helpers
       .multiple(() => this.between({ from, to }), { count })
@@ -486,21 +472,8 @@ export class SimpleDateModule extends SimpleModuleBase {
       min = 18,
       max = 80,
       refDate: rawRefDate = this.faker.defaultRefDate(),
-      mode: originalMode,
-      min: originalMin,
-      max: originalMax,
     } = options;
 
-    // TODO @ST-DDT 2024-03-17: Remove check in v10
-    const optionsSet = [originalMin, originalMax, originalMode].filter(
-      (x) => x != null
-    ).length;
-    if (optionsSet % 3 !== 0) {
-      throw new FakerError(
-        "The 'min', 'max', and 'mode' options must be set together."
-      );
-    }
-
     const refDate = toDate(rawRefDate);
     const refYear = refDate.getUTCFullYear();
 

src/modules/finance/index.ts

@@ -1,5 +1,4 @@
 import { FakerError } from '../../errors/faker-error';
-import { deprecated } from '../../internal/deprecated';
 import { ModuleBase } from '../../internal/module-base';
 import type { BitcoinAddressFamilyType, BitcoinNetworkType } from './bitcoin';
 import {
@@ -206,171 +205,6 @@ export class FinanceModule extends ModuleBase {
     return `${routingNumber}${Math.ceil(sum / 10) * 10 - sum}`;
   }
 
-  /**
-   * Generates a random masked number.
-   *
-   * @param length The length of the unmasked number. Defaults to `4`.
-   *
-   * @example
-   * faker.finance.maskedNumber() // '(...9711)'
-   * faker.finance.maskedNumber(3) // '(...342)'
-   *
-   * @since 8.0.0
-   *
-   * @deprecated Use `faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*')` or a similar approach instead.
-   */
-  maskedNumber(length?: number): string;
-  /**
-   * Generates a random masked number.
-   *
-   * @param options An options object.
-   * @param options.length The length of the unmasked number. Defaults to `4`.
-   * @param options.parens Whether to use surrounding parenthesis. Defaults to `true`.
-   * @param options.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`.
-   *
-   * @example
-   * faker.finance.maskedNumber() // '(...9711)'
-   * faker.finance.maskedNumber({ length: 3 }) // '(...342)'
-   * faker.finance.maskedNumber({ length: 3, parens: false }) // '...236'
-   * faker.finance.maskedNumber({ length: 3, parens: false, ellipsis: false }) // '298'
-   *
-   * @since 8.0.0
-   *
-   * @deprecated Use `faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*')` or a similar approach instead.
-   */
-  maskedNumber(options?: {
-    /**
-     * The length of the unmasked number.
-     *
-     * @default 4
-     */
-    length?: number;
-    /**
-     * Whether to use surrounding parenthesis.
-     *
-     * @default true
-     */
-    parens?: boolean;
-    /**
-     * Whether to prefix the numbers with an ellipsis.
-     *
-     * @default true
-     */
-    ellipsis?: boolean;
-  }): string;
-  /**
-   * Generates a random masked number.
-   *
-   * @param optionsOrLength An options object or the length of the unmask number.
-   * @param optionsOrLength.length The length of the unmasked number. Defaults to `4`.
-   * @param optionsOrLength.parens Whether to use surrounding parenthesis. Defaults to `true`.
-   * @param optionsOrLength.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`.
-   *
-   * @example
-   * faker.finance.maskedNumber() // '(...9711)'
-   * faker.finance.maskedNumber(3) // '(...342)'
-   * faker.finance.maskedNumber({ length: 3 }) // '(...342)'
-   * faker.finance.maskedNumber({ length: 3, parens: false }) // '...236'
-   * faker.finance.maskedNumber({ length: 3, parens: false, ellipsis: false }) // '298'
-   *
-   * @since 8.0.0
-   *
-   * @deprecated Use `faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*')` or a similar approach instead.
-   */
-  maskedNumber(
-    optionsOrLength?:
-      | number
-      | {
-          /**
-           * The length of the unmasked number.
-           *
-           * @default 4
-           */
-          length?: number;
-          /**
-           * Whether to use surrounding parenthesis.
-           *
-           * @default true
-           */
-          parens?: boolean;
-          /**
-           * Whether to prefix the numbers with an ellipsis.
-           *
-           * @default true
-           */
-          ellipsis?: boolean;
-        }
-  ): string;
-  /**
-   * Generates a random masked number.
-   *
-   * @param options An options object.
-   * @param options.length The length of the unmasked number. Defaults to `4`.
-   * @param options.parens Whether to use surrounding parenthesis. Defaults to `true`.
-   * @param options.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`.
-   *
-   * @example
-   * faker.finance.maskedNumber() // '(...9711)'
-   * faker.finance.maskedNumber(3) // '(...342)'
-   * faker.finance.maskedNumber({ length: 3 }) // '(...342)'
-   * faker.finance.maskedNumber({ length: 3, parens: false }) // '...236'
-   * faker.finance.maskedNumber({ length: 3, parens: false, ellipsis: false }) // '298'
-   *
-   * @since 8.0.0
-   *
-   * @deprecated Use `faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*')` or a similar approach instead.
-   */
-  maskedNumber(
-    options:
-      | number
-      | {
-          /**
-           * The length of the unmasked number.
-           *
-           * @default 4
-           */
-          length?: number;
-          /**
-           * Whether to use surrounding parenthesis.
-           *
-           * @default true
-           */
-          parens?: boolean;
-          /**
-           * Whether to prefix the numbers with an ellipsis.
-           *
-           * @default true
-           */
-          ellipsis?: boolean;
-        } = {}
-  ): string {
-    deprecated({
-      deprecated: 'faker.finance.maskedNumber()',
-      proposed:
-        "faker.finance.iban().replace(/(?<=.{4})\\w(?=.{2})/g, '*') or a similar approach",
-      since: '9.3.0',
-      until: '10.0.0',
-    });
-
-    if (typeof options === 'number') {
-      options = { length: options };
-    }
-
-    const { ellipsis = true, length = 4, parens = true } = options;
-
-    let template = this.faker.string.numeric({ length });
-
-    if (ellipsis) {
-      template = `...${template}`;
-    }
-
-    if (parens) {
-      template = `(${template})`;
-    }
-
-    return template;
-  }
-
   /**
    * Generates a random amount between the given bounds (inclusive).
    *

src/modules/helpers/eval.ts

@@ -81,7 +81,7 @@ export function fakeEval(
   do {
     let index: number;
     if (remaining.startsWith('(')) {
-      [index, current] = evalProcessFunction(remaining, current, expression);
+      [index, current] = evalProcessFunction(remaining, current);
     } else {
       [index, current] = evalProcessExpression(remaining, current);
     }
@@ -109,12 +109,10 @@ export function fakeEval(
  *
  * @param input The input string to parse.
  * @param entrypoints The entrypoints to attempt the call on.
- * @param expression The full expression to use in errors.
  */
 function evalProcessFunction(
   input: string,
-  entrypoints: ReadonlyArray<unknown>,
-  expression: string
+  entrypoints: ReadonlyArray<unknown>
 ): [continueIndex: number, mapped: unknown[]] {
   const [index, params] = findParams(input);
   const nextChar = input[index + 1];
@@ -135,23 +133,7 @@ function evalProcessFunction(
   return [
     index + (nextChar === '.' ? 2 : 1), // one for the closing bracket, one for the dot
     entrypoints.map((entrypoint): unknown =>
-      // TODO @ST-DDT 2023-12-11: Replace in v10
-      // typeof entrypoint === 'function' ? entrypoint(...params) : undefined
-      {
-        if (typeof entrypoint === 'function') {
-          return entrypoint(...params);
-        }
-
-        // eslint-disable-next-line no-undef
-        console.warn(
-          `[@faker-js/faker]: Invoking expressions which are not functions is deprecated since v9.0 and will be removed in v10.0.
-Please remove the parentheses or replace the expression with an actual function.
-${expression}
-${' '.repeat(expression.length - input.length)}^`
-        );
-
-        return entrypoint;
-      }
+      typeof entrypoint === 'function' ? entrypoint(...params) : undefined
     ),
   ];
 }