Add deprecation status in prop types
#### install
```
npm install react-docgen-deprecation-handler --save-dev
```
#### what does it do?
You can add `@deprecated` in the leading comments for a prop,
and it will appear in the documentation as a key
```jsx
const Component = () =>
Component.propTypes = {
/** @deprecated dont use this prop */
old: PropTypes.any,
/** this isn't deprecated, use it */
new: PropTypes.any,
/** @deprecated:new deprecated, you can add metadata like the replacement */
old2: PropTypes.any
}
export default Component
```
⬇️
```js
{
displayName: "Component",
props: {
old: {
type: { name: 'any' },
required: false,
description: "dont use this prop",
👉 deprecated: true
},
new: {
type: { name: 'any' },
required: false,
description: "this isn't deprecated, use it"
},
old2: {
type: { name: 'any' },
required: false,
description: "dont use this prop",
👉 deprecated: true,
👉 deprecationData: "new"
},
}
}
```
#### usage
You can add this handler to `react-docgen`'s handlers
```js
// grab the deprecation handler
const deprecationHandler = require("react-docgen-deprecation-handler")
// add this to docgen's handlers
const handlers = docgen.defaultHandlers.concat(deprecationHandler)
// pass these handlers to docgen.parse
const data = docgen.parse(code, null, handlers)
```
#### like it?
:star: this repo
#### license
MIT © [siddharthkp](https://github.com/siddharthkp)