feat: Update TS & react-docgen-typescript and support parser config (#…

…232)

.eslintrc

@@ -11,12 +11,6 @@
         "no-console": 0,
         "no-process-exit": 0
       }
-    },
-    {
-      "files": ["examples/**/*.js"],
-      "rules": {
-        "import/no-unresolved": 0
-      }
     }
   ]
 }

.github/workflows/preview-site.yml

@@ -24,7 +24,7 @@ jobs:
         run: yarn --frozen-lockfile
 
       - name: Build
-        run: yarn preview:build
+        run: yarn build:themed
 
       - name: Deploy to surge
         run: yarn deploy-preview -d playroom--${GITHUB_SHA}.surge.sh

README.md

@@ -113,9 +113,9 @@ export default [
       <Button weight="strong">
         Button
       </Button>
-    `
+    `,
   },
-  ...
+  // etc...
 ];
 ```
 
@@ -167,11 +167,23 @@ If you need to customise this behaviour, you can provide a `typeScriptFiles` opt
 
 ```js
 module.exports = {
-  ...,
-  typeScriptFiles: [
-    'src/components/**/*.{ts,tsx}',
-    '!**/node_modules'
-  ]
+  // ...
+  typeScriptFiles: ['src/components/**/*.{ts,tsx}', '!**/node_modules'],
+};
+```
+
+If you need to customise the [parser options](https://github.com/styleguidist/react-docgen-typescript#options), you can provide a `reactDocgenTypescriptConfig` option in `playroom.config.js`.
+
+For example:
+
+```js
+module.exports = {
+  // ...
+  reactDocgenTypescriptConfig: {
+    propFilter: (prop, component) => {
+      // ...
+    },
+  },
 };
 ```