{"id":17677446,"url":"https://github.com/jskits/jsdoc-tests","last_synced_at":"2025-07-30T21:37:22.707Z","repository":{"id":57284243,"uuid":"314880925","full_name":"jskits/jsdoc-tests","owner":"jskits","description":"A JSDoc test tool for documentation-driven quality","archived":false,"fork":false,"pushed_at":"2024-11-17T03:46:58.000Z","size":232,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-22T22:48:23.022Z","etag":null,"topics":["documentation-driven-quality","jest","jsdoc-test","testing","testing-tool"],"latest_commit_sha":null,"homepage":"","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/jskits.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-21T18:47:57.000Z","updated_at":"2025-04-09T10:17:19.000Z","dependencies_parsed_at":"2024-11-22T15:16:54.403Z","dependency_job_id":"1317c828-7075-40f6-b859-478f0e1e252d","html_url":"https://github.com/jskits/jsdoc-tests","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"c25ca492ba5c0353b2bd40a4939a60693656de4b"},"previous_names":["testkits/jsdoc-tests","unadlib/jsdoc-tests","jskits/jsdoc-tests"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/jskits/jsdoc-tests","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jskits%2Fjsdoc-tests","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jskits%2Fjsdoc-tests/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jskits%2Fjsdoc-tests/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jskits%2Fjsdoc-tests/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jskits","download_url":"https://codeload.github.com/jskits/jsdoc-tests/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jskits%2Fjsdoc-tests/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267945442,"owners_count":24170219,"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-07-30T02:00:09.044Z","response_time":70,"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":["documentation-driven-quality","jest","jsdoc-test","testing","testing-tool"],"created_at":"2024-10-24T07:28:42.830Z","updated_at":"2025-07-30T21:37:22.669Z","avatar_url":"https://github.com/jskits.png","language":"TypeScript","readme":"# jsdoc-tests\n\n![Node CI](https://github.com/unadlib/jsdoc-tests/workflows/Node%20CI/badge.svg)\n[![npm version](https://badge.fury.io/js/jsdoc-tests.svg)](http://badge.fury.io/js/jsdoc-tests)\n\nA JSDoc test tool for documentation-driven quality, support async function and export module(ES module/CommonJS).\n\n## Installation\n\n```sh\nyarn add -D jsdoc-tests # npm install -D jsdoc-tests\n```\n\n## Usage\n\n- Create A source code in `./src/example.ts` with JSDoc.\n\n````ts\n/**\n * Two numbers added together\n *\n * @param a {number}\n * @param b {number}\n *\n * @example\n *\n * ```ts\n * import { add } from './src/example';\n *\n * expect(add(1, 2)).toBe(3);\n * ```\n */\nexport const add = (a: number, b: number) =\u003e {\n  return a + b;\n};\n````\n\n- Create a test code in `./test/index.test.ts`.\n\n```ts\nimport { jsdocTests } from 'jsdoc-tests';\n\ntest('test \"add\" function', () =\u003e {\n  jsdocTests('./src/example.ts');\n});\n```\n\n## License\n\n`jsdoc-tests` is [MIT licensed](https://github.com/testkits/jsdoc-tests/blob/master/LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjskits%2Fjsdoc-tests","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjskits%2Fjsdoc-tests","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjskits%2Fjsdoc-tests/lists"}