Addon-docs: Support JSDoc @ignore tag to remove a prop from the props table

Is your feature request related to a problem? Please describe. My component contains props that the consumer shouldn’t be bothered with. I would like those props to be ignored by the props table.

Describe the solution you’d like JSDoc already support the @ignore tag. The props table could also use this tag to ignore the props.

Usage:

static propTypes = {
   /**
    * @ignore
    */
   reactDatesCalendar: node
};

[shilman]

@eybbus In SB6-beta, you can use the propFilter option of react-docgen-typescript-loader

See: https://github.com/storybookjs/storybook/blob/next/docs/src/pages/configurations/typescript-config/index.md#mainjs-configuration

https://github.com/strothj/react-docgen-typescript-loader#loader-options

As a hack, you can also use the include prop of the Props block to create a whitelist for that particular component.

[georgewilde]

@eybbus I had the same question and @shamin your response was spot-on, so thanks for that. Just in case anyone else is wondering what that actually looks like when you add the propFilter here is the end result from my main.ts file:

config.module.rules.push({
    test: /\.(ts|tsx)$/,
    use: [
        {
            loader: require.resolve('babel-loader'),
            options: {
                presets: [
                    '@babel/preset-react',
                    '@babel/preset-typescript',
                ],
            },
        },
        {
            loader: require.resolve('react-docgen-typescript-loader'),
            options: {
            propFilter: prop =>
                prop.parent
                    ? !/node_modules/.test(prop.parent.fileName)
                    : true,
            },
        },
    ],
});