Merge pull request #2 from styleguidist/master

Sync with upstream

Author: Havret

README.md

@@ -19,15 +19,23 @@ npm install --save-dev react-docgen-typescript
 Include following line in your `styleguide.config.js`:
 
 ```javascript
-propsParser: require('react-docgen-typescript').withDefaultConfig().parse
+propsParser: require('react-docgen-typescript').withDefaultConfig([parserOptions]).parse
 ```
 
 or if you want to use custom tsconfig file
 
 ```javascript
-propsParser: require('react-docgen-typescript').withCustomConfig('./tsconfig.json').parse
+propsParser: require('react-docgen-typescript').withCustomConfig('./tsconfig.json', [parserOptions]).parse
 ```
 
+### parserOptions
+- `skipPropsWithName?: string[] | string;`
+- `skipPropsWithoutDoc?: boolean;`
+
+or
+
+`(props: PropItem, component: Component) => boolean`
+
 ## Example
 
 In the example folder you can see React Styleguidist integration.
@@ -121,6 +129,8 @@ the part it's fixing.
 
 @brettjurgens Brett Jurgens - adding support for default props
 
+@dotcs Fabian Mueller - introduced parserOptions for skipping undocumented properties
+
 ## Thanks to others
 
 The integration with React Styleguidist wouldn't be possible without [Vyacheslav Slinko](https://github.com/vslinko) pull request [#118](https://github.com/styleguidist/react-styleguidist/pull/118) at React Styleguidist.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-docgen-typescript",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "",
   "main": "lib/index.js",
   "scripts": {

src/__tests__/buildFilter.ts

@@ -0,0 +1,99 @@
+import { assert, expect } from 'chai';
+import { buildFilter } from '../buildFilter';
+import { ParserOptions, Props, PropItem } from '../parser';
+
+function createProp(name: string, required: boolean = false, defaultValue: any = undefined, 
+  description: string = '', type = {name: 'string'}): PropItem {
+  return {
+    name,
+    type,
+    required,
+    defaultValue,
+    description
+  }
+}
+
+describe('buildFilter', () => {
+
+  describe('default behaviour', () => {
+    it('should skip "children" property if no description is set', () => {
+      const prop1 = createProp('prop1', false, undefined, 'prop1 description');
+      const prop2 = createProp('prop2', false, undefined, 'prop2 description');
+      const children = createProp('children', false, undefined, '');
+      const opts: ParserOptions = {};
+      const filterFn = buildFilter(opts);
+      expect([prop1, prop2, children].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop1, prop2]);
+    });
+    it('should not skip "children" property if description is set', () => {
+      const prop1 = createProp('prop1', false, undefined, 'prop1 description');
+      const prop2 = createProp('prop2', false, undefined, 'prop2 description');
+      const children = createProp('children', false, undefined, 'children description');
+      const opts: ParserOptions = {};
+      const filterFn = buildFilter(opts);
+      expect([prop1, prop2, children].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop1, prop2, children]);
+    });
+  });
+
+  describe('static prop filter', () => {
+
+    describe('skipPropsWithName', () => {
+      it('should skip single prop by name', () => {
+        const prop1 = createProp('prop1', false, undefined, 'prop1 description');
+        const prop2 = createProp('prop2', false, undefined, 'prop2 description');
+        const opts: ParserOptions = {
+          propFilter: { skipPropsWithName: 'prop1' }
+        };
+        const filterFn = buildFilter(opts);
+        expect([prop1, prop2].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop2]);
+      });
+      it('should skip multiple props by name', () => {
+        const prop1 = createProp('prop1', false, undefined, 'prop1 description');
+        const prop2 = createProp('prop2', false, undefined, 'prop2 description');
+        const prop3 = createProp('prop3', false, undefined, 'prop3 description');
+        const opts: ParserOptions = {
+          propFilter: { skipPropsWithName: ['prop1', 'prop3'] }
+        };
+        const filterFn = buildFilter(opts);
+        expect([prop1, prop2, prop3].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop2]);
+      });
+    });
+
+    describe('skipPropsWithoutDoc', () => {
+      it('should skip children props with no documentation', () => {
+        const prop1 = createProp('prop1', false, undefined, 'prop1 description');
+        const prop2 = createProp('prop2', false, undefined, '');
+        const opts: ParserOptions = {
+          propFilter: { skipPropsWithoutDoc: true }
+        };
+        const filterFn = buildFilter(opts);
+        expect([prop1, prop2].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop1]);
+      });
+    });
+
+  });
+
+  describe('dynamic prop filter', () => {
+    it('should skip props based on dynamic filter rule', () => {
+      const prop1 = createProp('foo', false, undefined, 'foo description');
+      const prop2 = createProp('bar', false, undefined, 'bar description');
+      const prop3 = createProp('foobar', false, undefined, 'foobar description');
+      const opts: ParserOptions = {
+        propFilter: (prop, component) => prop.name.indexOf('foo') === -1
+      };
+      const filterFn = buildFilter(opts);
+      expect([prop1, prop2, prop3].filter((prop) => filterFn(prop, {name: prop.name}))).to.eql([prop2]);
+    });
+
+    it('should get be possible to filter by component name', () => {
+      const prop1 = createProp('foo', false, undefined, 'foo description');
+      const prop2 = createProp('bar', false, undefined, 'bar description');
+      const prop3 = createProp('foobar', false, undefined, 'foobar description');
+      const opts: ParserOptions = {
+        propFilter: (prop, component) => component.name.indexOf('BAR') === -1
+      };
+      const filterFn = buildFilter(opts);
+      expect([prop1, prop2, prop3].filter((prop) => filterFn(prop, { name: prop.name.toUpperCase() }))).to.eql([prop1]);
+    });
+  });
+
+});

src/__tests__/data/ColumnWithAnnotatedChildren.tsx

@@ -0,0 +1,36 @@
+import * as React from 'react';
+
+/**
+ * Column properties.
+ */
+export interface IColumnProps {
+    /** prop1 description */
+    prop1?: string;
+    /** prop2 description */
+    prop2: number;
+    /**
+     * prop3 description
+     */
+    prop3: () => void;
+    /** prop4 description */
+    prop4: 'option1' | 'option2' | "option3";
+
+    /** children description */
+    children?: React.ReactNode;
+}
+
+/**
+ * Column description
+ */
+export class Column extends React.Component<IColumnProps, {}> {
+    public static defaultProps: Partial<IColumnProps> = {
+        prop1: 'prop1'
+    };
+
+    render() {
+        const {prop1} = this.props;
+        return <div>{prop1}</div>;
+    }
+}
+
+export default Column;

src/__tests__/data/ColumnWithUndocumentedProps.tsx

@@ -0,0 +1,27 @@
+import * as React from 'react';
+
+/**
+ * Column properties.
+ */
+export interface IColumnProps {
+    /** prop1 description */
+    prop1?: string;
+    /** prop2 description */
+    prop2: number;
+}
+
+/**
+ * Column description
+ */
+export class Column extends React.Component<IColumnProps, {}> {
+    public static defaultProps: Partial<IColumnProps> = {
+        prop1: 'prop1'
+    };
+
+    render() {
+        const {prop1} = this.props;
+        return <div>{prop1}</div>;
+    }
+}
+
+export default Column;