refactor(parse): add strict options interface

conventional-changelog · Jul 29, 2019 · cc7373a · cc7373a
1 parent 8cd3051
commit cc7373a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/@commitlint/parse/src/index.ts b/@commitlint/parse/src/index.ts
@@ -1,5 +1,5 @@
 import {isArray, mergeWith} from 'lodash';
-import {Commit} from './types';
+import {Commit, ParserOptions} from './types';
 
 const {sync} = require('conventional-commits-parser');
 const defaultChangelogOpts = require('conventional-changelog-angular');
@@ -8,9 +8,9 @@ export default parse;
 export * from './types';
 
 async function parse(
-	message?: any,
+	message?: string,
 	parser: any = sync,
-	parserOpts: any = undefined
+	parserOpts?: ParserOptions
 ): Promise<Commit> {
 	const defaultOpts = (await defaultChangelogOpts).parserOpts;
 	const parsed = parser(

diff --git a/@commitlint/parse/src/types.ts b/@commitlint/parse/src/types.ts
@@ -26,3 +26,13 @@ export interface CommitReference {
 	repository: string | null;
 	issue: string | null;
 }
+
+export interface ParserOptions {
+	headerCorrespondence?: string[];
+	headerPattern?: RegExp;
+	mergeCorrespondence?: string[];
+	mergePattern?: RegExp;
+	noteKeywords?: string[];
+	revertCorrespondence?: string[];
+	revertPattern?: RegExp;
+}