{"id":16234656,"url":"https://github.com/sielay/doc2dot","last_synced_at":"2025-10-08T16:10:32.519Z","repository":{"id":57213844,"uuid":"112765953","full_name":"sielay/doc2dot","owner":"sielay","description":"Generates dot (graphviz) document from code documentation comments like JSDoc, JavaDoc, PHPDoc","archived":false,"fork":false,"pushed_at":"2017-12-03T23:01:44.000Z","size":29,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-23T04:29:20.106Z","etag":null,"topics":["cli","graphviz","graphviz-dot","javadoc","jsdoc","nodejs","phpdoc","typedoc"],"latest_commit_sha":null,"homepage":null,"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/sielay.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":"2017-12-01T17:12:01.000Z","updated_at":"2022-03-26T18:15:14.000Z","dependencies_parsed_at":"2022-08-26T13:11:48.824Z","dependency_job_id":null,"html_url":"https://github.com/sielay/doc2dot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sielay/doc2dot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sielay%2Fdoc2dot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sielay%2Fdoc2dot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sielay%2Fdoc2dot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sielay%2Fdoc2dot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sielay","download_url":"https://codeload.github.com/sielay/doc2dot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sielay%2Fdoc2dot/sbom","scorecard":{"id":822744,"data":{"date":"2025-08-11","repo":{"name":"github.com/sielay/doc2dot","commit":"d2ab341061993208d0e749302da6964232ae9e8e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.4,"checks":[{"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":"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":"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":0,"reason":"Found 0/8 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":"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":"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":"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":"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":"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 '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":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h"],"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-23T15:59:07.284Z","repository_id":57213844,"created_at":"2025-08-23T15:59:07.284Z","updated_at":"2025-08-23T15:59:07.284Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278973152,"owners_count":26078174,"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-10-08T02:00:06.501Z","response_time":56,"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":["cli","graphviz","graphviz-dot","javadoc","jsdoc","nodejs","phpdoc","typedoc"],"created_at":"2024-10-10T13:16:42.644Z","updated_at":"2025-10-08T16:10:32.503Z","avatar_url":"https://github.com/sielay.png","language":"JavaScript","readme":"# doc2dot\nGenerates dot (graphviz) document from code documentation comments like JSDoc, JavaDoc, PHPDoc\n\n```bash\nyarn global add dot2doc\n# or\nnpm -g i dot2doc\n```\n\n```bash\ndot2doc './test/**/*.js'\ndot2doc './test/**/*.js' \u003e file.dot\n```\n\n## Usage\n\n### Raw DOT entry\n``` \n@dot nodeA -\u003e nodeB\n```\n\n### DOT node type\n\n```\n@dot-type MyNode [color=red]\n@dot {MyNode} nodeA\n```\n\nwill result with\n\n```\nnodeA [color=red]\n```\n\n### All of type rule\n\n```\n@dot-type MyNode [color=red]\n@dot {MyNode} nodeA\n@dot-rule MyNode -\u003e foo\n```\n\nwill result with\n\n```\nnodeA [color=red]\nnodeA -\u003e foo\n```\n\n## Define cluster\n\n```\n@dot-subgraph Name style=whatever;color=other\n@dot-rule foo in A\n@dot-rule {Any} in A\n@dot {Any} B\n```\n\nwill result in \n\n```\nsubgraph clusterName { style=whatever;color=other A B }\n```\n\n## Example\n\n```javascript\n/**\n * @name abc\n * @param a\n * @param b\n * @dot tester -\u003e noop\n * @dot {ClassA} tester\n * @dot-type ClassA [color=blue]\n */\nfunction tester(a, b) {\n\n}\n\n/**\n * @dot {RelationB} noop -\u003e tester \n * @dot-type RelationB [shape=arrow]\n */\n\n // @dot noop -\u003e boop\n\n /**\n  * @dot-rule ClassA \u003c- foop\n  * @dot-rule ClassA -\u003e boop\n  * @dot-rule ClassA eachIn A\n  * @dot-rule foop in A\n  * @dot-subgraph A style=filled;color=gray;\n  */\n\n\n```\n\n```dot\ndigraph G {\ngraph [rankdir=LR, fontsize=10, margin=0.001];\nsubgraph clusterA { style=filled;color=gray; foop tester }\ntester -\u003e noop\ntester [color=blue]\ntester -\u003e boop\nfoop -\u003e tester\nnoop -\u003e tester [shape=arrow]\nnoop -\u003e boop\n{ rank=\"max\";   e; }\n}\n\n\n```\n\n## Licence\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsielay%2Fdoc2dot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsielay%2Fdoc2dot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsielay%2Fdoc2dot/lists"}