Skip to content

Commit f8d6672

Browse files
committed
docs: types
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent b6a346a commit f8d6672

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Shareable [`commitlint`][1] config enforcing [conventional commits][2]
1919
- [Use](#use)
2020
- [API](#api)
2121
- [Types](#types)
22+
- [Enums](#enums)
23+
- [Interfaces](#interfaces)
24+
- [Type Definitions](#type-definitions)
2225
- [Contribute](#contribute)
2326

2427
## What is this?
@@ -64,6 +67,32 @@ yarn add -D @flex-development/commitlint-config@flex-development/commitlint-conf
6467

6568
This package is fully typed with [TypeScript][7].
6669

70+
### Enums
71+
72+
- [`PromptKind`](src/enums/kind-prompt.ts)
73+
- [`ReferenceAction`](src/enums/reference-action.ts)
74+
- [`Scope`](src/enums/scope.ts)
75+
- [`Type`](src/enums/type.ts)
76+
77+
### Interfaces
78+
79+
- [`Commit`](src/interfaces/commit.ts)
80+
- [`Config`](src/interfaces/config.ts)
81+
- [`Note`](src/interfaces/note.ts)
82+
- [`ParserOptions`](src/interfaces/options-parser.ts)
83+
- [`PromptConfig`](src/interfaces/config-prompt.ts)
84+
- [`Reference`](src/interfaces/reference.ts)
85+
- [`Revert`](src/interfaces/revert.ts)
86+
- [`RulesConfig`](src/interfaces/config-rules.ts)
87+
88+
### Type Definitions
89+
90+
- [`NoteKeyword`](src/types/note-keyword.ts)
91+
- [`ParserPreset`](src/types/parser-preset.ts)
92+
- [`QuestionEnum`](src/types/question-enum.ts)
93+
- [`Question`](src/types/question.ts)
94+
- [`Questions`](src/types/questions.ts)
95+
6796
## Contribute
6897

6998
See [`CONTRIBUTING.md`](CONTRIBUTING.md).

0 commit comments

Comments
 (0)