{"id":17654039,"url":"https://github.com/tomchen/typedoc-plugin-not-exported","last_synced_at":"2025-05-07T09:13:15.658Z","repository":{"id":41045673,"uuid":"332472430","full_name":"tomchen/typedoc-plugin-not-exported","owner":"tomchen","description":"TypeDoc plugin that forces inclusion of non-exported symbols (variables)","archived":false,"fork":false,"pushed_at":"2022-06-21T00:04:55.000Z","size":195,"stargazers_count":11,"open_issues_count":3,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T09:13:09.361Z","etag":null,"topics":["exported","include","plugin","typedoc","typedoc-plugin","typedocplugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomchen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-24T14:38:13.000Z","updated_at":"2024-05-28T23:01:53.000Z","dependencies_parsed_at":"2022-09-26T16:22:13.692Z","dependency_job_id":null,"html_url":"https://github.com/tomchen/typedoc-plugin-not-exported","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchen%2Ftypedoc-plugin-not-exported","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchen%2Ftypedoc-plugin-not-exported/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchen%2Ftypedoc-plugin-not-exported/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomchen%2Ftypedoc-plugin-not-exported/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomchen","download_url":"https://codeload.github.com/tomchen/typedoc-plugin-not-exported/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252847514,"owners_count":21813457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["exported","include","plugin","typedoc","typedoc-plugin","typedocplugin"],"created_at":"2024-10-23T12:08:26.350Z","updated_at":"2025-05-07T09:13:15.636Z","avatar_url":"https://github.com/tomchen.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-plugin-not-exported\n\n[![npm package](https://img.shields.io/badge/npm%20i%20--D-typedoc--plugin--not--exported-brightgreen)](https://www.npmjs.com/package/typedoc-plugin-not-exported) [![version number](https://img.shields.io/npm/v/typedoc-plugin-not-exported?color=green\u0026label=version)](https://github.com/tomchen/typedoc-plugin-not-exported/releases) [![Actions Status](https://github.com/tomchen/typedoc-plugin-not-exported/workflows/Test/badge.svg)](https://github.com/tomchen/typedoc-plugin-not-exported/actions) [![License](https://img.shields.io/github/license/tomchen/typedoc-plugin-not-exported)](https://github.com/tomchen/typedoc-plugin-not-exported/blob/main/LICENSE)\n\nThis [TypeDoc](https://typedoc.org/) plugin can force inclusion of specific symbols (variables) that are not exported, by making them fake exports.\n\n## Usage\n\n(Assuming you have already installed TypeDoc (`npm i -D typedoc`) of [version](https://www.npmjs.com/package/typedoc?activeTab=versions) **equal to or greater than v0.20.16** (released on 2021-01-17, this is the minimum required by this plugin. If you need to update the version, change TypeDoc's version number in package.json and rerun `npm i` / `yarn`))\n\nInstall the plugin with [npm](https://www.npmjs.com/):\n\n```bash\nnpm i -D typedoc-plugin-not-exported\n```\n\nOr with [yarn](https://yarnpkg.com/):\n\n```bash\nyarn add -D typedoc-plugin-not-exported\n```\n\nIn your code, tag the symbols (i.e. variables / types / interfaces / classes / object properties / class members etc.) that are not exported but you still want to include in the generated documentation.\n\nThe default tag is `@notExported`.\n\nExample 1:\n\n```ts\n/**\n * My class\n * @notExported\n */\nclass MyClass {\n  convert(str: string): string {\n    return str\n  }\n}\nexport const me = new MyClass()\n```\n\nExample 2:\n\n```ts\n/**\n * @notExported\n */\ntype twoNumbers = [number, number]\n/**\n * @notExported\n */\ntype threeNumbers = [number, number, number]\n\nexport type twoOrThreeNumbers = twoNumbers | threeNumbers\nexport function sum(ns: twoOrThreeNumbers): number {\n  return ns.reduce((a, b) =\u003e a + b)\n}\n```\n\nThen use the command as usual:\n\n```bash\ntypedoc src/index.ts\n```\n\nOr, if you are using `@internalDoNotUse` tag instead of `@notExported`, run:\n\n```bash\ntypedoc --includeTag internalDoNotUse src/index.ts\n```\n\n## Links, Tips \u0026 Others\n\nOriginally from [here](https://github.com/TypeStrong/typedoc/issues/1474#issuecomment-766178261).\n\n[CC0](LICENSE).\n\nTypeDoc converts comments in TypeScript source code into rendered HTML documentation. See [Guides](https://typedoc.org/guides/installation/), [API](https://typedoc.org/api/) \u0026 [repo](https://github.com/TypeStrong/typedoc).\n\nTypeDoc loads all plugins by default, if you want to specify plugins to load, use [`--plugin`](https://typedoc.org/guides/options/#plugin) flag.\n\nThose non-exported symbols (variables) you want to include in the doc, are not public and the [`@public`](https://tsdoc.org/pages/tags/public/) tag shouldn't be applied. TypeDoc's `@internal` tag and [typedoc-plugin-internal-external](https://github.com/christopherthielen/typedoc-plugin-internal-external)'s `@internal` and `@external` are not made to solve the problem in question.\n\nNevertheless, if you want to include a symbol (variable) in the documentation, you should usually export it.\n\n**Keywords: typedoc plugin force include non exported unexported variable symbol member fake export option flag tag mode file exclude inclusion internal external**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomchen%2Ftypedoc-plugin-not-exported","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomchen%2Ftypedoc-plugin-not-exported","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomchen%2Ftypedoc-plugin-not-exported/lists"}