interface-forge - v2.5.0
    Preparing search index...

    Class GitModule

    Module to generate git related entries.

    commitEntry() generates a random commit entry as printed by git log. This includes a commit hash commitSha(), author, date commitDate(), and commit message commitMessage(). You can also generate a random branch name with branch().

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    branch commitDate commitEntry commitMessage commitSha

    Constructors

    Properties

    faker: Faker

    Methods

    • Generates a random branch name.

      Returns string

      faker.git.branch() // 'feed-parse'

      5.0.0

    • Generates a date string for a git commit using the same format as git log.

      Parameters

      • Optionaloptions: { refDate?: string | number | Date }

        The optional options object.

        • OptionalrefDate?: string | number | Date

          The date to use as reference point for the commit.

          faker.defaultRefDate()

      Returns string

      faker.git.commitDate() // 'Mon Nov 7 14:40:58 2022 +0600'
      faker.git.commitDate({ refDate: '2020-01-01' }) // 'Tue Dec 31 05:40:59 2019 -0400'

      8.0.0

    • Generates a random commit entry as printed by git log.

      Parameters

      • Optionaloptions: { eol?: "LF" | "CRLF"; merge?: boolean; refDate?: string | number | Date }

        Options for the commit entry.

        • Optionaleol?: "LF" | "CRLF"

          Choose the end of line character to use.

          • 'LF' = '\n',
          • 'CRLF' = '\r\n'
          'CRLF'
        • Optionalmerge?: boolean

          Set to true to generate a merge message line.

          faker.datatype.boolean({ probability: 0.2 })
        • OptionalrefDate?: string | number | Date

          The date to use as reference point for the commit.

          new Date()

      Returns string

      faker.git.commitEntry()
      // commit fe8c38a965d13d9794eb36918cb24cebe49a45c2
      // Author: Marion Becker <Marion_Becker49@gmail.com>
      // Date: Mon Nov 7 05:38:37 2022 -0600
      //
      //     generate open-source system

      5.0.0

    • Generates a random commit message.

      Returns string

      faker.git.commitMessage() // 'reboot cross-platform driver'

      5.0.0

    • Generates a random commit sha.

      By default, the length of the commit sha is 40 characters.

      For a shorter commit sha, use the length option.

      Usual short commit sha length is:

      • 7 for GitHub
      • 8 for GitLab

      Parameters

      • Optionaloptions: { length?: number }

        Options for the commit sha.

        • Optionallength?: number

          The length of the commit sha.

          40

      Returns string

      faker.git.commitSha() // '2c6e3880fd94ddb7ef72d34e683cdc0c47bec6e6'
      faker.git.commitSha({ length: 7 }) // 'dbee57b'
      faker.git.commitSha({ length: 8 }) // '0e52376a'

      5.0.0

    Settings

    Member Visibility

    On This Page

    Overview
    Constructors
    Properties
    Methods