Merge pull request #16 from kilmc/fix-get-key

[fix] Make getKey more resilliant to unknown keys

.changeset/clean-tips-clap.md

@@ -0,0 +1,5 @@
+---
+"@kilmc/music-fns": patch
+---
+
+Make getKey more resilliant

src/keys/getKey.test.ts

@@ -139,4 +139,8 @@ describe('getKey', () => {
     expect(result?.minor.notes).toEqual(minorNotes);
     expect(result?.chords.map((chord) => chord.name)).toEqual(chordNames);
   });
+
+  it('handles unknown keys', () => {
+    expect(getKey('X dorian')).toBe(undefined);
+  });
 });

src/keys/getKey.ts

@@ -32,6 +32,9 @@ type KeyInfo = {
 
 export const getKey = (key: string): KeyInfo | undefined => {
   const [pitch, mode] = extractScaleName(key) || [];
+
+  if (pitch === undefined && mode === undefined) return undefined;
+
   const friendlyModeName = getFriendlyModeName(mode);
   if (mode === undefined || pitch === undefined) return undefined;
 

src/scale/extractName.ts

@@ -6,11 +6,10 @@ export const extractScaleName = (
 ): [string, TScaleType | Mode] | undefined => {
   const regex = new RegExp(/([A-G](?:b|#)?) (.*)/);
   const [pitchClass, scale] = name.match(regex)?.slice(1, 3) || [];
-  const normalScale = scale.toLowerCase().replaceAll(' ', '-');
 
-  if ((pitchClass || scale) === undefined) {
-    console.log('Not a scale');
-  }
+  if ((pitchClass || scale) === undefined) return undefined;
+
+  const normalScale = scale.toLowerCase().replaceAll(' ', '-');
 
   if (normalScale === 'ionian') {
     return [pitchClass, 'major'];