{"_id":"typedoc-plugin-mark-react-functional-components","_rev":"3-ce898e23fef5ca9dae56b42cb2cbc905","name":"typedoc-plugin-mark-react-functional-components","dist-tags":{"latest":"0.2.2"},"versions":{"0.1.0":{"name":"typedoc-plugin-mark-react-functional-components","version":"0.1.0","description":"A plugin for TypeDoc to mark React functional components differently than ordinary functions","main":"./dist/index.js","exports":"./dist/index.js","author":{"name":"Jan Stránský","url":"https://stranskyjan.cz"},"license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components.git"},"bugs":{"url":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues"},"keywords":["typedoc","typedoc-plugin","react","functional component"],"dependencies":{},"devDependencies":{"typedoc":"^0.22.15","react":"^18","@types/react":"^18","typescript":"^4.4.3"},"scripts":{"build":"tsc","test":"typedoc --options example/options.json","clean":"rm -rf dist/ public/","prepack":"npm run clean && npm run build"},"gitHead":"f705ef3e957db0718f3d1bcb8278cd076461fdb6","homepage":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components#readme","_id":"typedoc-plugin-mark-react-functional-components@0.1.0","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-xyT1ZDoNt73zUgsXlMISY+gEKQA/JkHu/Y8wm6ShupDrirwId5xaR4Xo3t00R0DTfiB00xwJKIpMEZd6CXY2eA==","shasum":"97446dfa5b8faf3888c4b6ce585ed859326c5056","tarball":"https://registry.npmjs.org/typedoc-plugin-mark-react-functional-components/-/typedoc-plugin-mark-react-functional-components-0.1.0.tgz","fileCount":10,"unpackedSize":100546,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAR7m8IVmViuFhqLhWG00+6f+orxyUzHDc8BlzoogzyhAiBzCKLDNpToEZMG+ZFT9SAleU3HJb870NPOvQMDEfQk+w=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJilQEmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrMVg//ded4IIixYGCnJK1U01g/3xCcPyLX0YGf3irZj6RGL6DTPnFK\r\nnYwKNY8k7CR0T7iuB/giUsc/iHvB1QZOE+Ga4Umm6hdZsAwV5xkFG0gMML8A\r\nxfUfv8ksUB+pK9q4GQp5/UrbZ2UkfBq8AFRPUgtx3XYZwPxDV6tzSDPn3P3m\r\n8QRhXlGzb0XGmALJi/tBhmsELSSh84EcjvuNi+dmNKvuw3obBAA3L6mM/NO4\r\n+KnVa/vAjDIUCfW8AJAqolLMoaawfHwEYtvgCVvYy0G9451TgFNo3MErb1iT\r\nO3v7ZkOGv5lx9iNrDpxf3DKaRZoiUA83u9LAo6dZ26TFfskOviggpLfy8VIO\r\nwq+1VbVsVQvVxVORfMOvvmg+qtjCNzLuBmNNaRURXhn+yVhrBvzseKweFGXw\r\nI4m05/UQxYA5zwuX44Msml/0UrPGHsv9fkCc0e7vieL0uNk81Y7MJIuSa0Bu\r\nKlhQ/w8xqepDJZMVx2c2tRD5oLgVfi+teHOA+TmPqqlXmLf4K3R8+V4Ivswv\r\nVA+bOb41GQ7+ccmrEM1s9v2FZJxpeFedtF2XN64KMKPVdyyNX9uGVuYRGWh3\r\n+h1KZQ1DtyPqT3h9mvGEEke4nSd1E/fl2fbp99hRepQtbscOvNIr0Ib3vpvX\r\n+C0WzK+k+ohQq54woQ3eFcxAa0Jh18tncnA=\r\n=PqrL\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"stranskyjan","email":"honzik.stransky@gmail.com"},"directories":{},"maintainers":[{"name":"stranskyjan","email":"honzik.stransky@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-mark-react-functional-components_0.1.0_1653932326480_0.5984599644308839"},"_hasShrinkwrap":false},"0.1.1":{"name":"typedoc-plugin-mark-react-functional-components","version":"0.1.1","description":"A plugin for TypeDoc to mark React functional components differently than ordinary functions","main":"./dist/index.js","exports":"./dist/index.js","author":{"name":"Jan Stránský","url":"https://stranskyjan.cz"},"license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components.git"},"bugs":{"url":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues"},"keywords":["typedoc","typedoc-plugin","react","functional component"],"dependencies":{},"devDependencies":{"typedoc":"^0.22.15","react":"^18","@types/react":"^18","typescript":"^4.4.3"},"scripts":{"build":"tsc","test":"typedoc --options example/options.json","clean":"rm -rf dist/ public/","prepack":"npm run clean && npm run build"},"gitHead":"d98d090e1caf3332c121e5f18ba45490ead07e26","homepage":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components#readme","_id":"typedoc-plugin-mark-react-functional-components@0.1.1","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-ylbQE9qu6YCSHTHCw9kdriGUk2WN2U5WqdI3Zild3zUIgLZ0OHK07lPZ3u6FlCgU1ychjiTlwYZv6uDw74o7BA==","shasum":"e3177671bcc7810db9383acf9e7258a41ff2fab0","tarball":"https://registry.npmjs.org/typedoc-plugin-mark-react-functional-components/-/typedoc-plugin-mark-react-functional-components-0.1.1.tgz","fileCount":10,"unpackedSize":100612,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCB/x+uDrWQ8175FjG3qjafZwq5bTmXM20ko0PFxhQC4QIgeP8oG01vdpmUoo2iU9V4dXyLjDW6FzPKfG7zOXRGIpo="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJilQTSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo8IQ//d2IcigNBlJ+Np7pm3ZUkn6d29WYMBdhKL/k3jdtiJVMXFjod\r\n4nh4QnwQiVbvepkOBHIwPglkYf3SLGHIAXOFKEXSz/v4acuSdc+85sQaCDMt\r\nExu2o6xpgcWu2Px+HfN2TZCS4pNKfxYFME+0gsvzVI6fyqtGgQoKMN7TBzF7\r\nLGxuZXfHd/MzHtP2FF9RkbvRNl1boBV5boUITvqKeyLjYvbPOomMelFUnKBm\r\nGWBndqf13Zm1lNtv9moIwBlUEQUV0pXm5jb/am7ljMEkTctqlPTUh9QVKygA\r\nT10MFRhljlza3P+/TxNLnpR3Sd5iJY64Xe5JQ6V/ODOqFvsY0rUeICW7Vi5P\r\n/A0+9KiJGvhv8Y7EtIcPydk3Xm1XvTf8z88XIVX9fsw/gT6CblUt7tut7YSz\r\nmvTPqtoSfkdYJL37+iOwNpz6uIiY/PKunaYabKCo88mGgFLTQkyul2iGimiC\r\n3zbrYVcAA9CZnqa0djIYGdhMY7GSpMK6ZpDJok8/6eIW0PaQeQTJ+tZUkdiw\r\ndkTizjOcvSayMcMRMdVfluHKIbfPueHuyBDsKtr1dAUH8UuK2gJD4Z8YVUU8\r\n58cgtdDueryBh4GNb+OEoSZJ62zvptujp9cuEGKtvziwwvd6c6Cq0LhDG65l\r\naBKJYHV3Bfi9QcTkBUkQP2nTWQZAFhgCIA0=\r\n=NqCq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"stranskyjan","email":"honzik.stransky@gmail.com"},"directories":{},"maintainers":[{"name":"stranskyjan","email":"honzik.stransky@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-mark-react-functional-components_0.1.1_1653933266118_0.49389025712720636"},"_hasShrinkwrap":false},"0.2.1":{"name":"typedoc-plugin-mark-react-functional-components","version":"0.2.1","description":"A plugin for TypeDoc to mark React functional components differently than ordinary functions","main":"./dist/index.js","exports":"./dist/index.js","author":{"name":"Jan Stránský","url":"https://stranskyjan.cz"},"license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components.git"},"bugs":{"url":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues"},"keywords":["typedoc","typedoc-plugin","react","functional component"],"dependencies":{},"devDependencies":{"typedoc":"^0.22.15","react":"^18","@types/react":"^18","@types/node":"*","typescript":"^4.4.3"},"scripts":{"build":"tsc","postbuild":"for d in css img; do cp -r src/$d dist; done","test":"typedoc --options example/options.json","clean":"rm -rf dist/ public/","prepack":"npm run clean && npm run build"},"gitHead":"90402a8d2c9aae0eda8d6c083d36e0b435585228","homepage":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components#readme","_id":"typedoc-plugin-mark-react-functional-components@0.2.1","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-Yvvw0AKuYLwlrkeLNy1f2FlhoMZJVs5N6UP+09Pm0ISu1m33X9ahFb48zC9gbI63nLMX2uRssoXVlSpT0ltHNQ==","shasum":"f08f4a282130c0fbb57d9a64062e088efa3e0fa0","tarball":"https://registry.npmjs.org/typedoc-plugin-mark-react-functional-components/-/typedoc-plugin-mark-react-functional-components-0.2.1.tgz","fileCount":17,"unpackedSize":291760,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDVD/VL9nyLSQVFichs/H3jZFNzoWuTVWLyeedOvtu0TAIgHbOqHfwW/qBirw+cbDbrHXDaafHXZlWLPPpMui56WyQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJil1MhACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpEdA//UmFnNxm0FOD+O4JRsQbsHnjAcShNm5KY3C709CakboMIQQQH\r\nZg0X5qwJYD37IO53l2dwgriyBY5BG/mi22bih3bkSCf18gRhvaylkTpTzXx8\r\nzqUPbDNK7cW+aqMYutW+AZL/0V1KuxYkRzrqTSMVtu0kTbw0x6nyYNeJUUTy\r\nNKZAPqzKItDxqCyrgkYBVaCMQVUSkdw+BgZD/vZhTU3tiMsfQDu2QmTn5E3o\r\nmsFwgyTlyVAEzJXIuYz/5R3J4cPaSaqVXUVqShPiYuYYILDxBJvZSPxumK7H\r\nrpd1q1H9X7y+wDnHIn73NyAezAOmBz9aHxGSrBNWfoLjuBMXZ+Qx3B6f+Gj5\r\n5cEiTPGAhklUTJ3DT7vbiiL8VQ8rK0MbRiUnUi89apsljI6XW9joHGijelWX\r\n27uOdPY2bnNIz2YTfEais/z9aTIwTNVDXLPSTk+5Y/9r7oJRTc6B2HRfLw77\r\nOFfgOrsEcPnwXpXqtwT4QFHkmS4c6c4OUHrlAnD4alCy8C3Mww89KXkhpBkI\r\nRm4YRxmzLeyEvLZdPcJe6fU51JmL0UUthaUp3EvCcDXiANhzNhOxbyPZLKi3\r\npDhXVGmBGT4DXPP0pu1dDyhYURkVDCnjZZgphTgm7Imit+t8gH79FiLuSjEJ\r\n6afYCletqb6zFDpTHaec8/35G7bsz6l92NY=\r\n=LuEZ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"stranskyjan","email":"honzik.stransky@gmail.com"},"directories":{},"maintainers":[{"name":"stranskyjan","email":"honzik.stransky@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-mark-react-functional-components_0.2.1_1654084385197_0.9306911812805749"},"_hasShrinkwrap":false},"0.2.2":{"name":"typedoc-plugin-mark-react-functional-components","version":"0.2.2","description":"A plugin for TypeDoc to mark React functional components differently than ordinary functions","main":"./dist/index.js","exports":"./dist/index.js","author":{"name":"Jan Stránský","url":"https://stranskyjan.cz"},"license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components.git"},"bugs":{"url":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues"},"keywords":["typedoc","typedoc-plugin","react","functional component"],"dependencies":{},"devDependencies":{"typedoc":"^0.22.15","react":"^18","@types/react":"^18","@types/node":"*","typescript":"^4.4.3"},"scripts":{"build":"tsc","postbuild":"for d in css img; do cp -r src/$d dist; done","test":"typedoc --options example/options.json","clean":"rm -rf dist/ public/","prepack":"npm run clean && npm run build"},"gitHead":"a74fa39b13b64f730a756e2d4f836dbdb43f9de0","homepage":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components#readme","_id":"typedoc-plugin-mark-react-functional-components@0.2.2","_nodeVersion":"16.15.0","_npmVersion":"8.5.5","dist":{"integrity":"sha512-4nk3NPD35bfd4cPRylqk/SjkOruU46tG8tJ+IDnpgidzDwf5yEyr1XL9gxCX5dZblCMExPbMhNweIY/kzSL+Nw==","shasum":"9236bb71dc811b18a508946c58392e83f48144ca","tarball":"https://registry.npmjs.org/typedoc-plugin-mark-react-functional-components/-/typedoc-plugin-mark-react-functional-components-0.2.2.tgz","fileCount":17,"unpackedSize":343297,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA37vPpR3Uas0SpbO0bAfFQ40PPQqxVAVxF2rGkF+gPjAiEAt9Kxh+OpWJTVB2AfMw1bsta2sfC7Od3o6J4txk53zg8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJinzatACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqOxQ/9FMkhXCoPrHJccpiLmS/7OriWLabXnn+iFbIxbzgBDan+IVpq\r\nxUQkp/3yLcKn+Aof11xrP9gh4A5BW0Sc0b7FQ4yxtCfzUgxPrPmmOJTwAaAi\r\nkRLxqR6WhatJpuTzeqcVnXfJ091nIlX6FhdmSJHNoxKQkOtswQEbQlB7ToBA\r\nif5GV+0G3K2dYJGZaTL25WBFYAmMOUxGCsJhVhEBnQF2UGO3myan/lHigxXi\r\ns37cPqVZU3f97qefQspFJbSpLy6Ev7uTWJdrU49s7PwGqBfYLxJhoS5JuG1p\r\nep2bXyLw/U0W8d8RGAHOaIUZFxPgzHj4Z55uI/a1V28ECZkQ+FaE1RkUYNTx\r\nlENOuODl9gx6Y2cTrYqGZd757ZsjvEbFphccgEAAbpGIJ+qhDeIku39I1dPB\r\n3OsWQFZ3DqwmHgK+ElajrBqkkN03dVg+f9Wz40nguhuJEo0+EgtJwLWfQNbW\r\nNuqZ5H20m4Rr68TQ8yCKTsAINH/p62C0wKsYmydl2d862PSeAA59GdP4TLUW\r\nK+RwdGfTo9kZyiGFwAWnV80Wy1dSRUyrot62q8H7E2O9TtBWJhTJccAzn/6Y\r\nqK9Pnf0lGTcfjXGEb4xmdIbYQIuCwiKMGXJracdrxdLNazmvReInhItRGmng\r\nKpvDkhNMkyZdinuhT7ERWvWb3oohcw8Fr6o=\r\n=qDh4\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"stranskyjan","email":"honzik.stransky@gmail.com"},"directories":{},"maintainers":[{"name":"stranskyjan","email":"honzik.stransky@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/typedoc-plugin-mark-react-functional-components_0.2.2_1654601388810_0.22374369655320248"},"_hasShrinkwrap":false}},"time":{"created":"2022-05-30T17:38:46.479Z","0.1.0":"2022-05-30T17:38:46.641Z","modified":"2022-06-07T11:29:49.138Z","0.1.1":"2022-05-30T17:54:26.372Z","0.2.1":"2022-06-01T11:53:05.345Z","0.2.2":"2022-06-07T11:29:49.034Z"},"maintainers":[{"name":"stranskyjan","email":"honzik.stransky@gmail.com"}],"description":"A plugin for TypeDoc to mark React functional components differently than ordinary functions","homepage":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components#readme","keywords":["typedoc","typedoc-plugin","react","functional component"],"repository":{"type":"git","url":"git+https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components.git"},"author":{"name":"Jan Stránský","url":"https://stranskyjan.cz"},"bugs":{"url":"https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues"},"license":"MIT","readme":"# [typedoc-plugin-mark-react-functional-components](https://www.npmjs.com/package/typedoc-plugin-mark-react-functional-components)\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-mark-react-functional-components)](https://www.npmjs.com/package/typedoc-plugin-mark-react-functional-components)\n\nA plugin for [TypeDoc](https://typedoc.org/) to mark\n[React](https://reactjs.org/)\n[functional components](https://reactjs.org/docs/components-and-props.html)\ndifferently than ordinary functions.\n\nSee [demo](https://stranskyjan.gitlab.io/typedoc-plugin-mark-react-functional-components/)\n(built from\n[this module](https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/-/tree/pages/example/example.tsx)\n) or its screenshot:\n\n![demo](https://unpkg.com/typedoc-plugin-mark-react-functional-components@0.2.2/assets/demo.png)\n\n## Overview\nCurrently it is a simple `head.end` hook, adding:\n- one `script`\n   - defines `window` `load` event\n   - find functions, whose return type is given `reactReturnType` option\n   - get its \"title\" name\n   - according to this name, get all relevant \"title\" elements\n   - add class `react-functional-component` to these relevant elements\n   - find functions whose name matches `/^use[A-Z]/` regexp and add class `react-hook` to these elements\n- one `style`\n   - adjust `.react-functional-component::before` to display react icon\n   - adjust `.react-hook::before` to display react hook icon\n\n\n## Installation\n```\nnpm install --save-dev typedoc-plugin-mark-react-functional-components\n```\n\n## Usage\nPlugin should be automaticall detected by TypeDoc.\nIf not, see [TypeDoc `plugin` option](https://typedoc.org/guides/options/#plugin).\n\n### Options:\n\n- `reactReturnType` (`string | string[]`)\n\n    Return type of react functional components.\n\n    Typically `Element`, `JSX.Element` or similar.\n\n- `notReactHook` (`string | string[]`, optional)\n\n    By default, mark all functions mathing `/^use[A-Z]/` as react hooks.\n    This option define names, which should be excluded.\n\n- `markReactHooks` (`boolean`, optional, default `true`)\n\n    Mark react hooks or not.\n\n## Compatibility\ntested with [TypeDoc 0.22.15](https://www.npmjs.com/package/typedoc/v/0.22.15) and its **default template**.\n\n## Testing\n- `npm run build`\n- `npm run test`\n- view `public/index.html`\n\n## Contributing\nis welcome :-)\n- via the [GitLab pages of the project](https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components)\n\n#### Bugs\n[issue tracker](https://gitlab.com/stranskyjan/typedoc-plugin-mark-react-functional-components/issues)\n\n## Maintainer\n[Jan Stránský](https://stranskyjan.cz)\n\n## License\n[MIT](https://opensource.org/licenses/MIT)\n\n## TODO\n- customization?\n- different approach (e.g. full theme, more internal plugin, ...)?\n- other occurrences (e.g. class method returning component)?\n- ... ?\n","readmeFilename":"README.md"}