infra(unicorn): permanently disable no-object-as-default-parameter

[ST-DDT]

Ref: #2439

• Check eslint-plugin-unicorn rules to enable/configure/disable #2439

---

Permanently disables the [unicorn/disable no-object-as-default-parameter](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/disable no-object-as-default-parameter.md) lint rule.

We assume that our users use typescript so they would always pass all required parameters.
Even if they don't all our methods handle that with basic defaults.

Affected code:

~/faker/src/modules/lorem/index.ts
  135:5  error  Do not use an object literal as default for parameter `wordCount`      unicorn/no-object-as-default-parameter
  203:5  error  Do not use an object literal as default for parameter `sentenceCount`  unicorn/no-object-as-default-parameter
  361:5  error  Do not use an object literal as default for parameter `lineCount`      unicorn/no-object-as-default-parameter

~/faker/test/scripts/apidocs/method.example.ts
  270:5  error  Do not use an object literal as default for parameter `a`  unicorn/no-object-as-default-parameter
  305:5  error  Do not use an object literal as default for parameter `a`  unicorn/no-object-as-default-parameter
  325:5  error  Do not use an object literal as default for parameter `a`  unicorn/no-object-as-default-parameter

Alternative Solution

Change the implementation of the methods to not use signature level defaults.

sentence(
-    wordCount:
+    wordCount?:
      | number
      | {
          /**
           * The minimum number of words to generate.
           */
          min: number;
          /**
           * The maximum number of words to generate.
           */
          max: number;
-        } = { min: 3, max: 10 }
+        }
  ): string {
-    const sentence = this.words(wordCount);
+    const sentence = this.words(wordCount ?? { min: 3, max: 10 });
...

[ST-DDT]

I'm actually not sure which variant I prefer.

[netlify]

✅ Deploy Preview for fakerjs ready!

Name	Link
🔨 Latest commit	fa8c91f
🔍 Latest deploy log	https://app.netlify.com/sites/fakerjs/deploys/6727544e4c713e0008b1a37d
😎 Deploy Preview	https://deploy-preview-3203.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (18f14c8) to head (fa8c91f).
Report is 1 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #3203      +/-   ##
==========================================
- Coverage   99.96%   99.96%   -0.01%     
==========================================
  Files        2805     2805              
  Lines      217098   217098              
  Branches      971      966       -5     
==========================================
- Hits       217025   217013      -12     
- Misses         73       85      +12     

see 1 file with indirect coverage changes

[xDivisionByZerox]

The alternative solution would actually "catch" accidental null inputs from our users:

I compressed the signature for simplicitiy sake:

Object default	Inline default
sentence({ min: number; max: number; } = { min: 3, max: 10 }): string { const sentence = this.words(wordCount); // ... } sentence(); // works sentence(undefined); // works sentence(null); // errors!!!	sentence({ min: number; max: number; }): string { const sentence = this.words(wordCount ?? { min: 3, max: 10 }); // ... } sentence(); // works sentence(undefined); // works sentence(null); // works

I jsut wanted to point that out.

[ST-DDT]

You could say the same for other methods such as faker.number.int(null).
That's why we recommend strict mode.

faker/docs/guide/usage.md

Line 107 in af1dbcd

"strict": true // Optional, but recommended

[ST-DDT]

Also AFAICT:

faker.lorem.sentence(null)
"Tenax vilitas harum."

faker/src/modules/helpers/index.ts

Line 1087 in af1dbcd

const count = this.rangeToNumber(options.count ?? 3);

(That method doesn't follow our usual options deconstruction though)

[matthewmayer]

I also don't have a strong preference. Just want to point out according to #3215 (comment) the faker.lorem.* methods are some of the most heavily used in Faker so we should be very careful not to accidentally change runtime behavior even if it's a subtle change for a edge case.