{"id":13452597,"url":"https://github.com/microsoft/tsdoc","last_synced_at":"2025-09-09T20:43:41.995Z","repository":{"id":37493288,"uuid":"123358607","full_name":"microsoft/tsdoc","owner":"microsoft","description":"A doc comment standard for TypeScript","archived":false,"fork":false,"pushed_at":"2025-07-15T22:47:44.000Z","size":7504,"stargazers_count":4871,"open_issues_count":144,"forks_count":142,"subscribers_count":47,"default_branch":"main","last_synced_at":"2025-09-03T14:12:46.783Z","etag":null,"topics":["comments","doc-comments","documentation","jsdoc","markdown","parser","rushstack","specification","syntax","typescript"],"latest_commit_sha":null,"homepage":"https://tsdoc.org/","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/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-03-01T00:16:52.000Z","updated_at":"2025-09-02T14:05:57.000Z","dependencies_parsed_at":"2024-11-23T01:18:56.142Z","dependency_job_id":"043dd76c-076c-45bc-92dc-91a87ebe679b","html_url":"https://github.com/microsoft/tsdoc","commit_stats":{"total_commits":934,"total_committers":43,"mean_commits":21.72093023255814,"dds":0.5856531049250535,"last_synced_commit":"0362e09e0a3f6652475b33fbb9ccb4f861323dd0"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/tsdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Ftsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Ftsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Ftsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Ftsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/tsdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Ftsdoc/sbom","scorecard":{"id":93865,"data":{"date":"2022-08-15","repo":{"name":"github.com/microsoft/tsdoc","commit":"8b0d97f06009ab8fe086aed237b2c3a878d9d9e1"},"scorecard":{"version":"v4.5.0-26-g10b6052","commit":"10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93"},"score":7.7,"checks":[{"name":"Maintained","score":10,"reason":"11 commit(s) out of 30 and 1 issue activity out of 30 found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#maintained"}},{"name":"Code-Review","score":7,"reason":"GitHub code reviews found for 22 commits out of the last 30 -- score normalized to 7","details":["Warn: no reviews found for commit: d8ce4aedcf64b5c948e7152ba02ac6c7bdedc9be","Warn: no reviews found for commit: 33065d9b0b8bcf0ea084d94da208e9c85e02d890","Warn: no reviews found for commit: 8d56b9e75c2c85d247de1e881dddb95ada9d8345","Warn: no reviews found for commit: 72a0833c3b34e7bac8896a20e3ff3c83b329599c"],"documentation":{"short":"Determines if the project requires code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no badge detected","details":null,"documentation":{"short":"Determines if the project has a CII Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"no vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":["Warn: no GitHub releases found"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#signed-releases"}},{"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/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":10,"reason":"tokens are read-only in GitHub workflows","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"no published package detected","details":["Warn: no GitHub 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/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#packaging"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: : LICENSE:1"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":10,"reason":"all dependencies are pinned","details":["Info: GitHub-owned GitHubActions are pinned","Info: Third-party GitHubActions are pinned","Info: Dockerfile dependencies are pinned","Info: no insecure (not pinned by hash) dependency downloads found in Dockerfiles","Info: no insecure (not pinned by hash) dependency downloads found in shell scripts"],"documentation":{"short":"Determines if the project has declared and pinned its dependencies.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#pinned-dependencies"}},{"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/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#binary-artifacts"}},{"name":"Dependency-Update-Tool","score":0,"reason":"no update tool detected","details":["Warn: dependabot config file not detected in source location.\n\t\t\tWe recommend setting this configuration in code so it can be easily verified by others.","Warn: renovatebot config file not detected in source location.\n\t\t\tWe recommend setting this configuration in code so it can be easily verified by others."],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#dependency-update-tool"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy detected in org repo: github.com/microsoft/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":null,"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":8,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'force pushes' disabled on branch 'main'","Info: 'allow deletion' disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Warn: number of required reviewers is only 1 on 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/10b6052acfb4f0b8136bc4876cb6f5b6f26bfe93/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-15T08:27:57.703Z","repository_id":37493288,"created_at":"2025-08-15T08:27:57.703Z","updated_at":"2025-08-15T08:27:57.703Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273469871,"owners_count":25111411,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"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":["comments","doc-comments","documentation","jsdoc","markdown","parser","rushstack","specification","syntax","typescript"],"created_at":"2024-07-31T07:01:28.659Z","updated_at":"2025-09-09T20:43:41.970Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","readme":"\u003ctable\u003e\u003ctr\u003e\u003ctd\u003e\r\n\u003ca href=\"https://tsdoc.org\"\u003e\u003cimg src=\"https://tsdoc.org/images/site/tsdoc-open.svg\" width=\"300px\" /\u003e\u003c/a\u003e\r\n\u003cp align=\"center\"\u003e\u003ca href=\"https://tsdoc.org/\"\u003ehttps://tsdoc.org/\u003c/a\u003e\u003c/p\u003e\r\n\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\r\n\r\n[![#tsdoc chat room](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://rushstack.zulipchat.com/#narrow/stream/266672-tsdoc) \u0026nbsp; [![Build Status](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_apis/build/status/tsdoc/TSDoc%20CI%20Build?branchName=main)](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_build/latest?definitionId=5\u0026branchName=main)\r\n\r\n\r\n## Documentation Links\r\n\r\n- [What is TSDoc?](https://tsdoc.org/) - project overview and roadmap\r\n- [Zulip chat room](https://rushstack.zulipchat.com/#narrow/stream/266672-tsdoc) - live help from other developers\r\n- [TSDoc tag reference](https://tsdoc.org/pages/tags/alpha/) - learn about syntax elements such as `@param`, `@remarks`, etc.\r\n- [TSDoc Playground](https://tsdoc.org/play) - interactive demo of the parser engine\r\n- [Contributing: Building the projects](https://tsdoc.org/pages/contributing/building/) - how to build and debug the projects in this repo\r\n- [Contributing: Submitting a PR](https://tsdoc.org/pages/contributing/pr_checklist/) - instructions for making a pull request\r\n\r\n\r\n## Projects in this monorepo\r\n\r\n| Folder | Version | Changelog | Description |\r\n| ------ | ------- | --------- | ------- |\r\n| [/api-demo](./api-demo/) | (local project) |  | Code samples illustrating how to use the **@microsoft/tsdoc** parser |\r\n| [/eslint-plugin](./eslint-plugin/) | [![npm version](https://badge.fury.io/js/eslint-plugin-tsdoc.svg)](https://badge.fury.io/js/eslint-plugin-tsdoc) | [changelog](./eslint-plugin/CHANGELOG.md) | [eslint-plugin-tsdoc](https://www.npmjs.com/package/eslint-plugin-tsdoc) plugin for ESLint|\r\n| [/playground](./playground/) | (local project) |  | Source code for the [TSDoc Playground](https://tsdoc.org/play) web app |\r\n| [/tsdoc](./tsdoc/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Ftsdoc.svg)](https://badge.fury.io/js/%40microsoft%2Ftsdoc) | [changelog](./tsdoc/CHANGELOG.md) | [@microsoft/tsdoc](https://www.npmjs.com/package/@microsoft/tsdoc) parser library |\r\n| [/tsdoc-config](./tsdoc/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Ftsdoc-config.svg)](https://badge.fury.io/js/%40microsoft%2Ftsdoc-config) | [changelog](./tsdoc-config/CHANGELOG.md) | [@microsoft/tsdoc-config](https://www.npmjs.com/package/@microsoft/tsdoc-config) loader for **tsdoc.json** |\r\n\r\n\r\n##  Contributor Notice\r\n\r\nThis project welcomes contributions and suggestions.  Most contributions require you to agree to a\r\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\r\nthe rights to use your contribution. For details, visit https://cla.microsoft.com.\r\n\r\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide\r\na CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions\r\nprovided by the bot. You will only need to do this once across all repos using our CLA.\r\n\r\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\r\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\r\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\r\n","funding_links":[],"categories":["TypeScript","API Docs","Documentation Types","📦 Modules/Packages","typescript"],"sub_categories":["Code Documentation","Documentation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Ftsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Ftsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Ftsdoc/lists"}