{"id":17968500,"url":"https://github.com/kamiazya/typedoc-plugin-nomnoml","last_synced_at":"2026-01-21T18:02:01.728Z","repository":{"id":35156391,"uuid":"213940866","full_name":"kamiazya/typedoc-plugin-nomnoml","owner":"kamiazya","description":"A plugin for TypeDoc that generates graphs for nomnoml diagrams by using @nomnoml annotation.","archived":false,"fork":false,"pushed_at":"2023-01-07T04:22:32.000Z","size":340,"stargazers_count":2,"open_issues_count":16,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-27T12:04:26.245Z","etag":null,"topics":["diagram","graph","nomnoml","nomnoml-preview","typedoc","typedocplugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/typedoc-plugin-nomnoml","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/kamiazya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"kamiazya","patreon":null,"open_collective":null,"ko_fi":"kamiazya","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-10-09T14:30:43.000Z","updated_at":"2021-07-22T16:29:17.000Z","dependencies_parsed_at":"2023-01-15T14:58:01.926Z","dependency_job_id":null,"html_url":"https://github.com/kamiazya/typedoc-plugin-nomnoml","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/kamiazya/typedoc-plugin-nomnoml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamiazya%2Ftypedoc-plugin-nomnoml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamiazya%2Ftypedoc-plugin-nomnoml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamiazya%2Ftypedoc-plugin-nomnoml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamiazya%2Ftypedoc-plugin-nomnoml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kamiazya","download_url":"https://codeload.github.com/kamiazya/typedoc-plugin-nomnoml/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamiazya%2Ftypedoc-plugin-nomnoml/sbom","scorecard":{"id":548741,"data":{"date":"2025-08-11","repo":{"name":"github.com/kamiazya/typedoc-plugin-nomnoml","commit":"f3bc4725634cee3bfcd79d847f4cab13b745d64d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"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":"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":"Code-Review","score":0,"reason":"Found 0/7 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":"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Info: Possibly incomplete results: error parsing job operating system: .github/workflows/nodejs.yml:19","Info: Possibly incomplete results: error parsing job operating system: .github/workflows/nodejs.yml:23","Info: Possibly incomplete results: error parsing job operating system: .github/workflows/nodejs.yml:27","Info: Possibly incomplete results: error parsing job operating system: .github/workflows/nodejs.yml:31","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/nodejs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/nodejs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/nodejs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/nodejs.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-management.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/release-management.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc-ci.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/typedoc-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typedoc-ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/kamiazya/typedoc-plugin-nomnoml/typedoc-ci.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:49","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/nodejs.yml:1","Warn: no topLevel permission defined: .github/workflows/release-management.yml:1","Warn: no topLevel permission defined: .github/workflows/typedoc-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":"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":"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":"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":"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":"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 28 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"}},{"name":"Vulnerabilities","score":0,"reason":"20 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-fjxv-7rqg-78g4","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-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","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-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-20T10:13:15.925Z","repository_id":35156391,"created_at":"2025-08-20T10:13:15.926Z","updated_at":"2025-08-20T10:13:15.926Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28638492,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T17:36:33.271Z","status":"ssl_error","status_checked_at":"2026-01-21T17:36:30.617Z","response_time":86,"last_error":"SSL_read: 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":["diagram","graph","nomnoml","nomnoml-preview","typedoc","typedocplugin"],"created_at":"2024-10-29T14:40:28.896Z","updated_at":"2026-01-21T18:02:01.683Z","avatar_url":"https://github.com/kamiazya.png","language":"TypeScript","funding_links":["https://github.com/sponsors/kamiazya","https://ko-fi.com/kamiazya"],"categories":[],"sub_categories":[],"readme":"[![GitHub Action](https://github.com/kamiazya/typedoc-plugin-nomnoml/workflows/Node%20CI/badge.svg)](https://github.com/kamiazya/typedoc-plugin-nomnoml/actions?workflow=Node+CI) [![npm version](https://badge.fury.io/js/typedoc-plugin-nomnoml.svg)](https://badge.fury.io/js/typedoc-plugin-nomnoml) [![Maintainability](https://api.codeclimate.com/v1/badges/330fef9d4d98238e09c1/maintainability)](https://codeclimate.com/github/kamiazya/typedoc-plugin-nomnoml/maintainability) [![BCH compliance](https://bettercodehub.com/edge/badge/kamiazya/typedoc-plugin-nomnoml?branch=master)](https://bettercodehub.com/) [![CodeFactor](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-nomnoml/badge)](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-nomnoml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) \u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n# typedoc-plugin-nomnoml\n\nA plugin for TypeDoc that generates graphs for nomnoml diagrams by @nomnoml annotation.\n\n## Installation\n\nThe plugin can then be installed using [npm](https://www.npmjs.com/):\n\n[![NPM](https://nodei.co/npm/typedoc-plugin-nomnoml.png)](https://nodei.co/npm/typedoc-plugin-nomnoml/)\n\n### npm\n\n```bash\nnpm install --save-dev typedoc-plugin-nomnoml\n```\n\n### yarn\n\n```bash\nyarn add -D typedoc-plugin-nomnoml\n```\n\n## Usage\n\nWrite tsdoc with `@nomnoml` annotation\n\n```typescript\n/**\n * Hoge is sample class for example of `typedoc-plugin-nomnoml`.\n *\n * @nomnoml Alice greet to Jone\n * [Pirate|eyeCount: Int|raid();pillage()|\n *   [beard]--[parrot]\n *   [beard]-:\u003e[foul mouth]\n * ]\n *\n * [\u003cabstract\u003eMarauder]\u003c:--[Pirate]\n * [Pirate]- 0..7[mischief]\n * [jollyness]-\u003e[Pirate]\n * [jollyness]-\u003e[rum]\n * [jollyness]-\u003e[singing]\n * [Pirate]-\u003e *[rum|tastiness: Int|swig()]\n * [Pirate]-\u003e[singing]\n * [singing]\u003c-\u003e[rum]\n *\n * [\u003cstart\u003est]-\u003e[\u003cstate\u003eplunder]\n * [plunder]-\u003e[\u003cchoice\u003emore loot]\n * [more loot]-\u003e[st]\n * [more loot] no -\u003e[\u003cend\u003ee]\n *\n * [\u003cactor\u003eSailor] - [\u003cusecase\u003eshiver me;timbers]\n */\nexport class Hoge { }\n```\n\n### Help\n\n```bash\n$ typedoc --plugin typedoc-plugin-nomnoml -h\nLoaded plugin typedoc-plugin-nomnoml\nUsage:\n typedoc --mode modules --out path/to/documentation path/to/sourcefiles\n\nTypeDoc options:\n ...\n -h, --help                Print this message.\n ...\n --nomnomlVersion          Nomnoml Plugin: Version of nomnoml.\n ...\n\nTypeScript options:\nSee https://www.typescriptlang.org/docs/handbook/compiler-options.html\n```\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://blog.kamiazya.tech/\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/35218186?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eYuki Yamazaki\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kamiazya/typedoc-plugin-nomnoml/commits?author=kamiazya\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/kamiazya/typedoc-plugin-nomnoml/commits?author=kamiazya\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"https://github.com/kamiazya/typedoc-plugin-nomnoml/commits?author=kamiazya\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/baronTommy\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/16768208?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTommy\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#ideas-baronTommy\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors)\nspecification. Contributions of any kind welcome!\n\n## License\n\nThis software is released under the MIT License, see [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamiazya%2Ftypedoc-plugin-nomnoml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkamiazya%2Ftypedoc-plugin-nomnoml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamiazya%2Ftypedoc-plugin-nomnoml/lists"}