feat(utils): max

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

src/index.ts

@@ -6,3 +6,4 @@
 export * from './enums'
 export * from './interfaces'
 export * from './types'
+export * from './utils'

src/utils/__tests__/max.spec.ts

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

src/utils/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Utilities
+ * @module commitlint-config/utils
+ */
+
+export { default as max } from './max'

src/utils/max.ts

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