propTypes not showing unless defaultProps for Prop

[bluetidepro]

My issue/problem:

It seems like propTypes Don't show up unless there is a defaultProps for that prop. Is this intended? Is there a fix for this?

Details:

• Using "webpack": "1.12.14"
• Here is my styleguide.config.js:

const path = require('path');
const webpack = require('webpack');
const _ = require('lodash');

const BASE_PATH = path.join(__dirname, './src');

module.exports = {
  title: 'Styleguide Title',
  components: './src/components/**/*.js',
  updateWebpackConfig(webpackConfig, env) {
    webpackConfig.eslint = {
      configFile: './.eslintrc',
    };
    webpackConfig.devtool = '#cheap-module-source-map';
    webpackConfig.module.preLoaders = [
      {
        test: /\.js$/,
        exclude: [
          /node_modules/,
        ],
        loader: 'eslint-loader'
      }
    ];
    webpackConfig.module.loaders.push(
      {
        test: /\.js?$/,
        include: BASE_PATH,
        loader: 'babel'
      }
    );
    webpackConfig.plugins.push(
      new webpack.DefinePlugin({
        ICONS_FILE: JSON.stringify('icons.svg'),
        WEBPACK__NODE_PRODUCTION: process.env.NODE_ENV === 'production',
      })
    );
    webpackConfig.resolve.alias = _.extend(webpackConfig.resolve.alias, {
      'bambu-colors': path.join(BASE_PATH, '/styles/Colors')
    });
    return webpackConfig;
  },
};

• Here is a snippet of my component:

/**
 * The Badge
 */
class Badge extends React.PureComponent {
  static propTypes () {
    return {
      /**
       * The background of the Badge
       */
      background: PropTypes.string,
      /**
       * The text color for the Badge
       */
      color: PropTypes.string,
      /**
       * The text displayed inside the Badge
       */
      text: PropTypes.string,
    };
  }

  static get defaultProps () {
    return {
      background: null,
      color: Colors.WHITE,
    };
  }

  render () {
      ...
  }
}

export default Badge;

• And it outputs like this (screenshot):

[bluetidepro]

Oh, and I just noticed it seems like descriptions are not being pulled in, either.

[sapegin]

Looks like react-docgen doesn’t understand your propTypes so it catches your props only from defaultProps and shows only default values because of that.

Actually I don’t see any reason to use a function here (didn’t know that this is possible for classes — do they even work?). Could you try to use an object like in this example.

[bluetidepro]

Ahhh, that did it. Thanks @sapegin!