feat(utils): scopes

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

Author: unicornware

src/utils/__tests__/scopes.spec.ts

@@ -0,0 +1,19 @@
+/**
+ * @file Unit Tests - scopes
+ * @module commitlint-config/utils/tests/unit/scopes
+ */
+
+import { Scope } from '#src/enums'
+import testSubject from '../scopes'
+
+describe('unit:utils/scopes', () => {
+  it('should return array containing valid commit scopes', () => {
+    // Arrange
+    const extras: string[] = ['build', 'bundle', 'transpile']
+
+    // Act + Expect
+    expect(testSubject(extras)).to.include.members([
+      ...new Set<string>([...Object.values(Scope), ...extras])
+    ])
+  })
+})

src/utils/index.ts

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

src/utils/scopes.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Utilities - scopes
+ * @module commitlint-config/utils/scopes
+ */
+
+import { Scope } from '#src/enums'
+import type { LiteralUnion } from '@flex-development/tutils'
+
+/**
+ * Returns an array of valid commit scopes.
+ *
+ * @param {(Set<string> | string[])?} [extras=[]] - Additional commit scopes
+ * @return {LiteralUnion<Scope, string>[]} Commit scopes array
+ */
+const scopes = (
+  extras: Set<string> | string[] = []
+): LiteralUnion<Scope, string>[] => {
+  return [...new Set([...Object.values(Scope), ...extras])].sort((s1, s2) => {
+    return s1.localeCompare(s2)
+  })
+}
+
+export default scopes