feat(utils): min

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

src/utils/__tests__/min.spec.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Unit Tests - min
+ * @module commitlint-config/utils/tests/unit/min
+ */
+
+import { Type } from '#src/enums'
+import testSubject from '../min'
+
+describe('unit:utils/min', () => {
+  it('should return length of shortest string in given array', () => {
+    // Arrange
+    const array: Type[] = [Type.BUILD, Type.DOCS, Type.REFACTOR]
+
+    // Act + Expect
+    expect(testSubject(array)).to.equal(Type.DOCS.length)
+  })
+})

src/utils/index.ts

@@ -4,3 +4,4 @@
  */
 
 export { default as max } from './max'
+export { default as min } from './min'

src/utils/min.ts

@@ -0,0 +1,18 @@
+/**
+ * @file Utilities - min
+ * @module commitlint-config/utils/min
+ */
+
+/**
+ * Returns the length of the shortest string in the given `array`.
+ *
+ * @param {string[]} array - Array to evaluate
+ * @return {number} Length of shortest string in `array`
+ */
+const min = (array: string[]): number => {
+  return array.reduce((min: number, str: string, index: number): number => {
+    return index === 0 || str.length < min ? str.length : min
+  }, 0)
+}
+
+export default min