{"id":13760089,"url":"https://github.com/sutoiku/jsdox","last_synced_at":"2026-04-05T01:31:45.180Z","repository":{"id":65128878,"uuid":"4448452","full_name":"sutoiku/jsdox","owner":"sutoiku","description":"simplified jsdoc 3","archived":false,"fork":false,"pushed_at":"2023-04-18T13:27:18.000Z","size":284,"stargazers_count":210,"open_issues_count":33,"forks_count":50,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-10-02T05:29:12.278Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"jsdox.org","language":"JavaScript","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/sutoiku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"Contributing.md","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}},"created_at":"2012-05-25T18:07:11.000Z","updated_at":"2025-03-04T10:57:09.000Z","dependencies_parsed_at":"2024-01-07T21:52:39.387Z","dependency_job_id":"ced378b1-ffe4-416e-b51f-1666f16226c6","html_url":"https://github.com/sutoiku/jsdox","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/sutoiku/jsdox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutoiku%2Fjsdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutoiku%2Fjsdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutoiku%2Fjsdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutoiku%2Fjsdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sutoiku","download_url":"https://codeload.github.com/sutoiku/jsdox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sutoiku%2Fjsdox/sbom","scorecard":{"id":860573,"data":{"date":"2025-08-11","repo":{"name":"github.com/sutoiku/jsdox","commit":"fd43230c1aeae74962ca07a22d97525a81624516"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"Code-Review","score":1,"reason":"Found 4/27 approved changesets -- score normalized to 1","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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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 'master'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-24T01:08:54.183Z","repository_id":65128878,"created_at":"2025-08-24T01:08:54.183Z","updated_at":"2025-08-24T01:08:54.183Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31421869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T00:25:07.052Z","status":"ssl_error","status_checked_at":"2026-04-05T00:25:05.923Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-08-03T13:01:03.251Z","updated_at":"2026-04-05T01:31:45.154Z","avatar_url":"https://github.com/sutoiku.png","language":"JavaScript","readme":"# jsdox [![npm](http://img.shields.io/npm/v/jsdox.svg)](https://npmjs.org/package/jsdox) [![npm](http://img.shields.io/npm/dm/jsdox.svg)](https://npmjs.org/package/jsdox) [![build status](https://travis-ci.org/sutoiku/jsdox.svg?branch=master)](https://travis-ci.org/sutoiku/jsdox)\n\njsdox is a simple jsdoc 3 generator.  It pulls documentation tags based on a subset of [jsdoc 3](http://usejsdoc.org/) from your javascript files and generates [markdown](http://daringfireball.net/projects/markdown/) files.\n\nRelies on the [JSDoc3 parser](https://github.com/mrjoelkemp/jsdoc3-parser) to get the full AST including comments.\n\n### CLI Options\n\nUsage: `jsdox [options] \u003cfile | directory\u003e`\n\n`--config \u003cfile\u003e` (alias `-c`): Configuration JSON file.\n\n`--All` (alias `-A`): Generates documentation for all available elements including internal methods.\n\n`--debug` (alias `-d`): Prints debugging information to the console.\n\n`--help` (alias `-H`): Prints help and quits.\n\n`--version` (alias `-v`): Prints the current version and quits.\n\n`--output \u003cdir\u003e` (alias `-o`): Output directory. Default value is `output`.\n\n`--templateDir \u003cdir\u003e` (alias `-t`): Template directory to use instead of built-in ones.\n\n`--index \u003cname\u003e` (alias `-i`): Generates an index with the documentation. An optional file name can be provided as an argument. Default value is `index`.\n\n`--index-sort \u003ctype\u003e`: Defines how to sort the index.  Options are: `standard` (sorted by name), `namespace` (sorted by package/module and name), and `none` (not sorted). Default value is `standard`.\n\n`--recursive` (alias `-r`): Generates documentation in all subdirectories of the source folder.\n\n`--respect-recursive` (alias `--rr`): Generate subdirectories and copy the original organization of the sources.\n\n\n# Resources\n* [jsdox](http://jsdox.org) Documentation\n* Github [repo](https://github.com/sutoiku/jsdox)\n* [Changelog](https://github.com/sutoiku/jsdox/blob/master/CHANGES.md)\n* Issue [tracker](https://github.com/sutoiku/jsdox/issues)\n* Contribute by [reading the guidelines](https://github.com/sutoiku/jsdox/blob/master/Contributing.md) and creating [pull requests](https://github.com/sutoiku/jsdox/pulls)!\n* Run the test suite using `npm test`\n\n# Related projects\n* [grunt-jsdox](https://github.com/mmacmillan/grunt-jsdox) A grunt task\n  to run jsdox on your project\n\n# Author and contributors\n* Pascal Belloncle (psq, Original author)\n* Sam Blowes (blowsie)\n* Todd Henderson (thenderson21)\n* Nic Jansma (nicjansma)\n* Joel Kemp (mrjoelkemp)\n* Ron Korving (ronkorving)\n* Mike MacMillan (mmacmillan)\n* Michael Martin-Smucker (mlms13)\n* Akeem McLennon (bluelaguna)\n* Gabor Sar (gaborsar)\n* Marc Trudel (stelcheck)\n* Anselm Stordeur (anselmstordeur)\n* Vladimir de Turckheim (vdeturckheim)\n\n# License\n\njsdox.js is freely distributable under the terms of the MIT license.\n\nCopyright (c) 2012-2016 Sutoiku\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","funding_links":[],"categories":["Documentation","Documentation [🔝](#readme)","Packages","文档","包"],"sub_categories":["Runner","Documentation","运行器","运行器e2e测试"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsutoiku%2Fjsdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsutoiku%2Fjsdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsutoiku%2Fjsdox/lists"}