styleguidist/react-styleguidist

Ignore doctag doesn't work with TypeScript

Open

#830 opened on Feb 18, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

    "react-styleguidist": "^6.2.5",
    "react-docgen-typescript": "^1.2.3",

using

export interface RoleProps {
    /** 
     * @ignore 
     */
    css?: M.Styling.CSSProperties
    /** @ignore */
    dontappear?: string;
} 

Both appear in the generated Styleguide.

Contributor guide

Research direction
Investigate why the @ignore tag is not being respected by react docgen typescript. Check if the tag is parsed correctly and whether there are filters that should exclude ignored properties.
Tech stack
typescript
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70