commitlint-config/src/interfaces/reference.ts at main · flex-development/commitlint-config · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/**
 * @file Interfaces - Reference
 * @module commitlint-config/interfaces/Reference
 */

import type { ReferenceAction } from '#src/enums'
import type { Nullable } from '@flex-development/tutils'

/**
 * Object representing a reference action in a commit.
 */
interface Reference {
  /**
   * Reference action, if any.
   */
  action: Nullable<ReferenceAction>

  /**
   * Referenced issue.
   */
  issue: string

  /**
   * Repository owner.
   */
  owner: Nullable<string>

  /**
   * Issue prefix.
   */
  prefix: string

  /**
   * Raw reference from commit.
   */
  raw: string

  /**
   * Name of repository the reference belongs to.
   *
   * If `null`, reference is from `origin`.
   */
  repository: Nullable<string>
}

export type { Reference as default }