JSDo c (лучше-документы) неправильно показывает необходимый propType - PullRequest
Новая
       81

JSDo c (лучше-документы) неправильно показывает необходимый propType

0 голосов
/ 03 марта 2020

Использование плагина better-docs для JSDocs с приложением React. Он предназначен для синтаксического анализа прототипов, получения информации из PropTypes и помещения их в массив. Оно делает. Но показывает «Обязательно» как «Нет» в таблице, даже если propType помечен isRequired.

https://github.com/SoftwareBrothers/better-docs#usage -2

https://softwarebrothers.github.io/admin-bro-dev/index.html

Пример компонента 

/**
 * Some documented component
 *
 * @component
 * @example
 * const text = 'some example text'
 * return (
 *   <Documented text={text} />
 * )
 * @category Dumb component
 */

const Documented = (props) => {
    const { text } = props
    return (
        <div>{text}</div>
    )
}

Documented.propTypes = {
    /**
     * Text is a text
     */
    text: PropTypes.string.isRequired,
}

export default Documented

JSDo c Конфиг 

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc"]
  },
  "source": {
    "include": ["src"],
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_"
  },
  "plugins": [
    "plugins/markdown",
    "node_modules/better-docs/component",
    "node_modules/better-docs/category"
  ],
  "templates": {
    "better-docs": {
      "name": "My React components"
    }
  },
  "opts": {
    "destination": "docs",
    "encoding": "utf8",
    "recurse": true,
    "verbose": true,
    "readme": "README.md",
    "template": "node_modules/better-docs/"
  }
}

enter image description here

Поочередно ищем плагин JSDo c, который анализирует комментарии для проптипов и также указывает необходимые реквизиты для компонента.

Спасибо!

...