fix: handle numbers and some puncuation in enum values (#89)

Author: MarshallOfSound

src/__tests__/markdown-helpers.spec.ts

@@ -170,6 +170,34 @@ def fn():
         expect(values[1].value).toBe('b_c');
         expect(values[2].value).toBe('d');
       });
+
+      it('should extract an enum with fullstops in the values', () => {
+        const values = extractStringEnum('Values includes `a`, `b.c` and `d`')!;
+        expect(values).not.toBe(null);
+        expect(values).toHaveLength(3);
+        expect(values[0].value).toBe('a');
+        expect(values[1].value).toBe('b.c');
+        expect(values[2].value).toBe('d');
+      });
+
+      it('should extract an enum with colons in the values', () => {
+        const values = extractStringEnum('Values includes `a`, `https:` and `d`')!;
+        expect(values).not.toBe(null);
+        expect(values).toHaveLength(3);
+        expect(values[0].value).toBe('a');
+        expect(values[1].value).toBe('https:');
+        expect(values[2].value).toBe('d');
+      });
+
+      it('should extract an enum with numbers in the values', () => {
+        const values = extractStringEnum('Can be `tls1`, `tls1.1`, `tls1.2` or `tls1.3`.')!;
+        expect(values).not.toBe(null);
+        expect(values).toHaveLength(4);
+        expect(values[0].value).toBe('tls1');
+        expect(values[1].value).toBe('tls1.1');
+        expect(values[2].value).toBe('tls1.2');
+        expect(values[3].value).toBe('tls1.3');
+      });
     });
 
     describe('with single quotes', () => {

src/markdown-helpers.ts

@@ -456,11 +456,11 @@ export enum StripReturnTypeBehavior {
 export const extractStringEnum = (description: string): PossibleStringValue[] | null => {
   const possibleValues: PossibleStringValue[] = [];
 
-  const inlineValuesPattern = /(?:can be|values? includes?) ((?:(?:[`|'][a-zA-Z-_]+[`|'])(?:(, | )?))*(?:(?:or|and) [`|'][a-zA-Z-_]+[`|'])?)/i;
+  const inlineValuesPattern = /(?:can be|values? includes?) ((?:(?:[`|'][a-zA-Z0-9-_\.:]+[`|'])(?:(, | )?))*(?:(?:or|and) [`|'][a-zA-Z0-9-_\.:]+[`|'])?)/i;
   const inlineMatch = inlineValuesPattern.exec(description);
   if (inlineMatch) {
     const valueString = inlineMatch[1];
-    const valuePattern = /[`|']([a-zA-Z-_]+)[`|']/g;
+    const valuePattern = /[`|']([a-zA-Z0-9-_\.:]+)[`|']/g;
     let value = valuePattern.exec(valueString);
 
     while (value) {