Merge pull request #361 from shilman/341-fix-remove-optional-undefined

Fix shouldRemoveUndefinedFromOptional in TypeScript strict mode

Author: pvasek

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "trailingComma": "none",
+  "singleQuote": true
+}

src/__tests__/data/RemoveOptionalValuesFromEnum.tsx

@@ -0,0 +1,23 @@
+import * as React from 'react';
+
+enum sampleEnum {
+  ONE = 'one',
+  TWO = 'two',
+  THREE = 'three'
+}
+
+interface RemoveOptionalValuesFromEnumProps {
+  /** sampleString description */
+  sampleString?: string;
+  /** sampleBoolean description */
+  sampleBoolean?: boolean;
+  /** sampleEnum description */
+  sampleEnum?: sampleEnum;
+}
+
+/** RemoveOptionalValuesFromEnum description */
+export const Stateless: React.StatelessComponent<RemoveOptionalValuesFromEnumProps> = ({
+  sampleString = 'hello',
+  sampleBoolean = true,
+  sampleEnum = 'three'
+}) => <div>test</div>;

src/__tests__/data/RemoveOptionalValuesFromUnion.tsx

@@ -0,0 +1,16 @@
+import * as React from 'react';
+
+interface RemoveOptionalValuesFromUnionProps {
+  /** sampleStringUnion description */
+  sampleStringUnion?: 'string1' | 'string2';
+  /** sampleNumberUnion description */
+  sampleNumberUnion?: 1 | 2 | 3;
+  /** sampleMixedUnion description */
+  sampleMixedUnion?: 1 | 2 | 'string1' | 'string2';
+}
+
+export const Stateless: React.StatelessComponent<RemoveOptionalValuesFromUnionProps> = ({
+  sampleStringUnion = 'string1',
+  sampleNumberUnion = 1,
+  sampleMixedUnion = 1
+}) => <div>test</div>;

src/__tests__/parser.ts

@@ -1482,6 +1482,78 @@ describe('parser', () => {
     });
   });
 
+  describe('typescript strict mode', () => {
+    // typescript strict mode adds an extra `undefined` to enums
+    // may have other funky behavior
+    describe('remove undefined from optional', () => {
+      const options = {
+        shouldExtractLiteralValuesFromEnum: true,
+        shouldRemoveUndefinedFromOptional: true,
+        savePropValueAsString: true
+      };
+      const parser = withCustomConfig(
+        // tsconfig with strict: true
+        path.join(__dirname, '../../src/__tests__/data/tsconfig.json'),
+        options
+      );
+      it('removes undefined from enums', () => {
+        const result = parser.parse(
+          fixturePath('RemoveOptionalValuesFromEnum')
+        );
+        const expected = {
+          RemoveOptionalValuesFromEnum: {
+            sampleBoolean: { type: 'boolean', required: false },
+            sampleEnum: {
+              raw: 'sampleEnum',
+              required: false,
+              type: 'enum',
+              value: [
+                { value: '"one"' },
+                { value: '"two"' },
+                { value: '"three"' }
+              ]
+            },
+            sampleString: { type: 'string', required: false }
+          }
+        };
+        checkComponent(result, expected, false);
+      });
+      it('removes undefined from unions', () => {
+        const result = parser.parse(
+          fixturePath('RemoveOptionalValuesFromUnion')
+        );
+        const expected = {
+          RemoveOptionalValuesFromUnion: {
+            sampleStringUnion: {
+              required: false,
+              raw: '"string1" | "string2"',
+              type: 'enum',
+              value: [{ value: '"string1"' }, { value: '"string2"' }]
+            },
+            sampleNumberUnion: {
+              required: false,
+              raw: '1 | 2 | 3',
+              type: 'enum',
+              value: [{ value: '1' }, { value: '2' }, { value: '3' }]
+            },
+            sampleMixedUnion: {
+              required: false,
+              raw: '"string1" | "string2" | 1 | 2',
+              type: 'enum',
+              value: [
+                { value: '"string1"' },
+                { value: '"string2"' },
+                { value: '1' },
+                { value: '2' }
+              ]
+            }
+          }
+        };
+        check('RemoveOptionalValuesFromUnion', expected, false, null, options);
+      });
+    });
+  });
+
   describe('parseWithProgramProvider', () => {
     it('should accept existing ts.Program instance', () => {
       let programProviderInvoked = false;

src/parser.ts

@@ -576,6 +576,9 @@ export class Parser {
     }
 
     let propTypeString = this.checker.typeToString(propType);
+    if (this.shouldRemoveUndefinedFromOptional && !isRequired) {
+      propTypeString = propTypeString.replace(' | undefined', '');
+    }
 
     if (propType.isUnion()) {
       if (
@@ -590,12 +593,18 @@ export class Parser {
                 ts.TypeFlags.Undefined)
           ))
       ) {
+        let value = propType.types.map(type => ({
+          value: this.getValuesFromUnionType(type)
+        }));
+
+        if (this.shouldRemoveUndefinedFromOptional && !isRequired) {
+          value = value.filter(option => option.value != 'undefined');
+        }
+
         return {
           name: 'enum',
           raw: propTypeString,
-          value: propType.types.map(type => ({
-            value: this.getValuesFromUnionType(type)
-          }))
+          value
         };
       }
     }