{"id":16933915,"url":"https://github.com/neozenith/typedoc-plugin-missing-check","last_synced_at":"2026-05-14T20:31:52.124Z","repository":{"id":57383511,"uuid":"367844899","full_name":"neozenith/typedoc-plugin-missing-check","owner":"neozenith","description":"TypeDoc Plugin to check if typescript documentation is empty or missing.","archived":false,"fork":false,"pushed_at":"2021-05-22T13:47:53.000Z","size":513,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-27T12:04:37.887Z","etag":null,"topics":["typedoc","typedoc-plugin","typedocplugin"],"latest_commit_sha":null,"homepage":"https://neozenith.github.io/typedoc-plugin-missing-check/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neozenith.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-05-16T10:10:35.000Z","updated_at":"2024-01-21T09:35:33.000Z","dependencies_parsed_at":"2022-09-18T10:50:13.021Z","dependency_job_id":null,"html_url":"https://github.com/neozenith/typedoc-plugin-missing-check","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/neozenith/typedoc-plugin-missing-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neozenith%2Ftypedoc-plugin-missing-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neozenith%2Ftypedoc-plugin-missing-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neozenith%2Ftypedoc-plugin-missing-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neozenith%2Ftypedoc-plugin-missing-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neozenith","download_url":"https://codeload.github.com/neozenith/typedoc-plugin-missing-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neozenith%2Ftypedoc-plugin-missing-check/sbom","scorecard":{"id":680007,"data":{"date":"2025-08-11","repo":{"name":"github.com/neozenith/typedoc-plugin-missing-check","commit":"b29f174679ad52835ce9fe54d864ca21bc4a8443"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/neozenith/typedoc-plugin-missing-check/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/neozenith/typedoc-plugin-missing-check/ci.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:19","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"26 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T22:47:54.964Z","repository_id":57383511,"created_at":"2025-08-21T22:47:54.964Z","updated_at":"2025-08-21T22:47:54.964Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33042122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["typedoc","typedoc-plugin","typedocplugin"],"created_at":"2024-10-13T20:50:47.871Z","updated_at":"2026-05-14T20:31:52.106Z","avatar_url":"https://github.com/neozenith.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤷‍♀️ Typedoc Plugin: Missing Check 🤷‍♂️\n\n[![CI](https://github.com/neozenith/typedoc-plugin-missing-check/actions/workflows/ci.yml/badge.svg)](https://github.com/neozenith/typedoc-plugin-missing-check/actions/workflows/ci.yml)\n\nTypeDoc Plugin to check if typescript documentation is empty or missing.\n\nA plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that check TypeScript API documentation actually exists and throws errors when _it is accidentally forgotten_.\n\n## Installation\n\n```bash\nnpm install --save-dev typedoc typedoc-plugin-missing-check\n```\n\n## Usage\n\nUsage is the same as documented at [TypeDoc](https://typedoc.org/guides/installation/#command-line-interface).\n\n```bash\ntypedoc src/\n```\n\n```bash\n# Check only public or higher (default).\ntypedoc --missing-check-level public src/\n\n# Check only protected and public.\ntypedoc --missing-check-level protected src/\n\n# Check all.\ntypedoc --missing-check-level private src/\n\n# Disable missingness checks.\ntypedoc --missing-check-disabled src/\n\n# Enable more verbose error messages.\ntypedoc --missing-check-verbose src/\n```\n\nThese options can also be configured in your `typedoc.json` or `tsconfig.json` like so:\n\n`typedoc.json`\n```json\n{\n    \"missing-check-disabled\": false,\n    \"missing-check-verbose\": false,\n    \"missing-check-level\": \"public\"\n}\n```\n\n`tsconfig.json`\n```json\n{\n    \"compilerOptions\": {\n        ...\n    },\n    \"typedocOptions\": {\n        \"missing-check-disabled\": false,\n        \"missing-check-verbose\": false,\n        \"missing-check-level\": \"public\"\n    }    \n}\n```\n\n## Development\n\nGet setup\n\n```bash\ngit clone https://github.com/neozenith/typedoc-plugin-missing-check\ncd typedoc-plugin-missing-check\nnpm ci\n```\n\nRun a self check since there are no tests just yet.\n\n```bash\nnpm run build\nnpx typedoc --plugin . src/\n```\n## Contributing\n\nReport issues on Github, or more appreciated would be opening a pull request and we can collaborate on getting the needed change over the line.\n\nSince you will need to create a fork to open up a new PR, you can also then immediately use your updated version with:\n\n```bash\nnpm install --save-dev https://github.com/{USER}/typedoc-plugin-missing-check/tarball/{BRANCH}\n```\n\nSee this Stackoverflow article [\"How to install an npm package from github directly?\"](https://stackoverflow.com/questions/17509669/how-to-install-an-npm-package-from-github-directly) for more details.\n\nThen revert back to using this version once your PR is accepted and published:\n\n```bash\nnpm install --save-dev typedoc-plugin-missing-check\n```\n\n## TODO\n\n### Next \n\n - Create jest test suite\n - Handle missing class constructor docs\n - Handle missing method docs \n\n### Later\n\n - Automate process publishing of docs and to npm process after successful CI and merge to `main`.\n - Automate Github Release page.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneozenith%2Ftypedoc-plugin-missing-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneozenith%2Ftypedoc-plugin-missing-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneozenith%2Ftypedoc-plugin-missing-check/lists"}