Merge branch 'main' into readme-import

Author: ST-DDT

package.json

@@ -95,10 +95,10 @@
     "@types/validator": "~13.7.2",
     "@typescript-eslint/eslint-plugin": "~5.17.0",
     "@typescript-eslint/parser": "~5.17.0",
-    "@vitest/ui": "~0.7.12",
+    "@vitest/ui": "~0.8.0",
     "c8": "~7.11.0",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~9.5.2",
+    "cypress": "~9.5.3",
     "esbuild": "~0.14.28",
     "eslint": "~8.12.0",
     "eslint-config-prettier": "~8.5.0",
@@ -122,7 +122,7 @@
     "validator": "~13.7.0",
     "vite": "~2.8.6",
     "vitepress": "~0.22.3",
-    "vitest": "~0.7.12"
+    "vitest": "~0.8.0"
   },
   "packageManager": "[email protected]",
   "engines": {

pnpm-lock.yaml

@@ -66,7 +66,7 @@ export class DefaultParameterAwareSerializer extends SerializerComponent<Reflect
     return instance instanceof Reflection;
   }
 
-  supports(item: unknown): boolean {
+  supports(): boolean {
     return true;
   }
 

scripts/apidoc/parameterDefaults.ts

@@ -15,25 +15,35 @@ export class Fake {
   }
 
   /**
-   * Generator method for combining faker methods based on string input.
+   * Generator for combining faker methods based on a static string input.
    *
-   * Note: If you just want to create a string on the fly, we recommend using string template literals instead.
-   * This method is useful if you wish to choose a random format from a non-executable source or persistent storage (json etc.).
+   * Note: We recommend using string template literals instead of `fake()`,
+   * which are faster and strongly typed (if you are using TypeScript),
+   * e.g. ``const address = `${faker.address.zipCode()} ${faker.address.city()}`;``
    *
-   * It checks the given string for placeholders and replace them by calling the specified faker method.
-   * E.g. the input `Hi, my name is {{name.firstName}}!`,
-   * will use the `faker.name.firstName()` method to resolve the placeholder.
-   * It is also possible to combine static text with placeholders,
-   * since only the parts inside the double braces `{{placeholder}}` are replaced.
-   * The replacement process is repeated until all placeholders have been replaced by static text.
-   * It is also possible to provide the called method with additional parameters by adding parentheses.
-   * This method will first attempt to parse the parameters as json, if that isn't possible it will use them as string.
-   * E.g. `You can call me at {{phone.phoneNumber(+!# !## #### #####!)}}.`
-   * Currently it isn't possible to set more than a single parameter this way.
+   * This method is useful if you have to build a random string from a static, non-executable source
+   * (e.g. string coming from a user, stored in a database or a file).
    *
-   * Please note that is NOT possible to use any non-faker methods or plain js script in there.
+   * It checks the given string for placeholders and replaces them by calling faker methods:
    *
-   * @param str The format string that will get interpolated. May not be empty.
+   * ```js
+   * const hello = faker.fake('Hi, my name is {{name.firstName}} {{name.lastName}}!')
+   * ```
+   *
+   * This would use the `faker.name.firstName()` and `faker.name.lastName()` method to resolve the placeholders respectively.
+   *
+   * It is also possible to provide parameters. At first, they will be parsed as json,
+   * and if that isn't possible, we will fall back to string:
+   *
+   * ```js
+   * const message = faker.fake(`You can call me at {{phone.phoneNumber(+!# !## #### #####!)}}.')
+   * ```
+   *
+   * Currently it is not possible to set more than a single parameter.
+   *
+   * It is also NOT possible to use any non-faker methods or plain javascript in such templates.
+   *
+   * @param str The template string that will get interpolated. Must not be empty.
    *
    * @see faker.helpers.mustache() to use custom functions for resolution.
    *

src/fake.ts

@@ -175,10 +175,11 @@ export class System {
    * Returns a file path.
    *
    * @example
-   * faker.system.filePath() // '/usr/local/src/money.rmp.dotx'
+   * faker.system.filePath() // '/usr/local/src/money.dotx'
    */
+  // TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
   filePath(): string {
-    return `${this.faker.system.directoryPath()}/${this.faker.system.fileName()}.${this.faker.system.fileExt()}`;
+    return `${this.directoryPath()}/${this.fileName()}`;
   }
 
   /**

src/system.ts

@@ -16,9 +16,13 @@ export class Word {
 
   /**
    * Returns an adjective of random or optionally specified length.
-   * If specified length is unresolvable, returns random adjective.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected adjective length. If specified length is unresolvable, returns adjective of a random length.
+   *
+   * @example
+   * faker.word.adjective() // 'pungent'
+   * faker.word.adjective(5) // 'slimy'
+   * faker.word.adjective(100) // 'complete'
    */
   adjective(length?: number): string {
     let wordList = this.faker.definitions.word.adjective;
@@ -38,9 +42,13 @@ export class Word {
 
   /**
    * Returns an adverb of random or optionally specified length.
-   * If specified length is unresolvable, returns random adverb.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected adverb length. If specified length is unresolvable, returns adverb of a random length.
+   *
+   * @example
+   * faker.word.adverb() // 'quarrelsomely'
+   * faker.word.adverb(5) // 'madly'
+   * faker.word.adverb(100) // 'sadly'
    */
   adverb(length?: number): string {
     let wordList = this.faker.definitions.word.adverb;
@@ -60,9 +68,13 @@ export class Word {
 
   /**
    * Returns a conjunction of random or optionally specified length.
-   * If specified length is unresolvable, returns random conjunction.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected conjunction length. If specified length is unresolvable, returns conjunction of a random length.
+   *
+   * @example
+   * faker.word.conjunction() // 'in order that'
+   * faker.word.conjunction(5) // 'since'
+   * faker.word.conjunction(100) // 'as long as'
    */
   conjunction(length?: number): string {
     let wordList = this.faker.definitions.word.conjunction;
@@ -82,9 +94,13 @@ export class Word {
 
   /**
    * Returns an interjection of random or optionally specified length.
-   * If specified length is unresolvable, returns random interjection.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected interjection length. If specified length is unresolvable, returns interjection of a random length.
+   *
+   * @example
+   * faker.word.interjection() // 'gah'
+   * faker.word.interjection(5) // 'fooey'
+   * faker.word.interjection(100) // 'yowza'
    */
   interjection(length?: number): string {
     let wordList = this.faker.definitions.word.interjection;
@@ -104,9 +120,13 @@ export class Word {
 
   /**
    * Returns a noun of random or optionally specified length.
-   * If specified length is unresolvable, returns random noun.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected noun length. If specified length is unresolvable, returns noun of a random length.
+   *
+   * @example
+   * faker.word.noun() // 'external'
+   * faker.word.noun(5) // 'front'
+   * faker.word.noun(100) // 'care'
    */
   noun(length?: number): string {
     let wordList = this.faker.definitions.word.noun;
@@ -126,9 +146,13 @@ export class Word {
 
   /**
    * Returns a preposition of random or optionally specified length.
-   * If specified length is unresolvable, returns random preposition.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected preposition length. If specified length is unresolvable, returns preposition of a random length.
+   *
+   * @example
+   * faker.word.preposition() // 'without'
+   * faker.word.preposition(5) // 'abaft'
+   * faker.word.preposition(100) // 'an'
    */
   preposition(length?: number): string {
     let wordList = this.faker.definitions.word.preposition;
@@ -148,9 +172,13 @@ export class Word {
 
   /**
    * Returns a verb of random or optionally specified length.
-   * If specified length is unresolvable, returns random verb.
    *
-   * @param length The optional length of word to return.
+   * @param length Expected verb length. If specified length is unresolvable, returns verb of a random length.
+   *
+   * @example
+   * faker.word.verb() // 'act'
+   * faker.word.verb(5) // 'tinge'
+   * faker.word.verb(100) // 'mess'
    */
   verb(length?: number): string {
     let wordList = this.faker.definitions.word.verb;

src/word.ts

@@ -15,8 +15,7 @@ const seededRuns = [
       fileType: 'image',
       fileExt: 'chm',
       directoryPath: '/opt/bin',
-      // TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
-      filePath: '/opt/bin/directives_savings_computer.qwd.jade',
+      filePath: '/opt/bin/directives_savings_computer.qwd',
       semver: '3.7.9',
     },
   },
@@ -31,8 +30,7 @@ const seededRuns = [
       fileType: 'font',
       fileExt: 'gxt',
       directoryPath: '/Library',
-      // TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
-      filePath: '/Library/bike_kiribati.kpr.ez3',
+      filePath: '/Library/bike_kiribati.kpr',
       semver: '2.5.1',
     },
   },
@@ -47,8 +45,7 @@ const seededRuns = [
       fileType: 'x-shader',
       fileExt: 'opml',
       directoryPath: '/var/log',
-      // TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
-      filePath: '/var/log/forward_frozen.swf.fcdt',
+      filePath: '/var/log/forward_frozen.swf',
       semver: '9.4.8',
     },
   },
@@ -104,7 +101,6 @@ describe('system', () => {
             'jpeg',
             'm2a',
             'm2v',
-            'm3a',
             'mp4',
             'mp4v',
             'mpeg',
@@ -118,7 +114,7 @@ describe('system', () => {
           expect(
             extList,
             `generated common file ext should be one of [${extList.join(
-              ','
+              ', '
             )}]. Got "${fileExt}".`
           ).include(fileExt);
         });