{"id":28346811,"url":"https://github.com/anixe/doku","last_synced_at":"2025-08-20T08:17:49.925Z","repository":{"id":46622527,"uuid":"384048627","full_name":"anixe/doku","owner":"anixe","description":"fn(Code) -\u003e Docs","archived":false,"fork":false,"pushed_at":"2023-06-09T08:13:25.000Z","size":381,"stargazers_count":85,"open_issues_count":3,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-29T04:13:40.153Z","etag":null,"topics":["documentation","documentation-generator","json","rust","rust-lang","serialization"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/anixe.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,"zenodo":null}},"created_at":"2021-07-08T08:04:34.000Z","updated_at":"2025-03-09T11:42:18.000Z","dependencies_parsed_at":"2025-06-02T21:34:31.381Z","dependency_job_id":null,"html_url":"https://github.com/anixe/doku","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/anixe/doku","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anixe%2Fdoku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anixe%2Fdoku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anixe%2Fdoku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anixe%2Fdoku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anixe","download_url":"https://codeload.github.com/anixe/doku/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anixe%2Fdoku/sbom","scorecard":{"id":197074,"data":{"date":"2025-08-11","repo":{"name":"github.com/anixe/doku","commit":"775aca169d058482020fd1c7ebc29024e357a668"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"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":"Code-Review","score":2,"reason":"Found 6/25 approved changesets -- score normalized to 2","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":"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":"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":"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":"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":-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":"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 '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/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 11 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":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: RUSTSEC-2020-0159","Warn: Project is vulnerable to: RUSTSEC-2020-0095","Warn: Project is vulnerable to: RUSTSEC-2024-0421 / GHSA-h97m-ww89-6jmq","Warn: Project is vulnerable to: RUSTSEC-2020-0071 / GHSA-wcg3-cvx6-7396"],"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-16T22:00:02.077Z","repository_id":46622527,"created_at":"2025-08-16T22:00:02.077Z","updated_at":"2025-08-16T22:00:02.077Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271285534,"owners_count":24732930,"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-08-20T02:00:09.606Z","response_time":69,"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","documentation-generator","json","rust","rust-lang","serialization"],"created_at":"2025-05-27T15:10:39.781Z","updated_at":"2025-08-20T08:17:49.920Z","avatar_url":"https://github.com/anixe.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doku \u0026emsp; [![crates-badge]][crates-link] [![docs-badge]][docs-link]\n\n[crates-badge]: https://img.shields.io/crates/v/doku.svg\n[crates-link]: https://crates.io/crates/doku\n[docs-badge]: https://img.shields.io/badge/docs.rs-latest-informational\n[docs-link]: https://docs.rs/doku\n\nDoku is a framework for documenting Rust data structures - it allows to generate\naesthetic, human-friendly descriptions of configuration types, requests /\nresponses, and so on.\n\nSay goodbye to stale, hand-written documentation - with Doku, _code_ is the\ndocumentation!\n\n## Example\n\n```toml\n[dependencies]\ndoku = \"0.21\"\n```\n\n```rust\nuse doku::Document;\nuse serde::Deserialize;\n\n#[derive(Deserialize, Document)]\nstruct Config {\n    /// Database's engine\n    db_engine: DbEngine,\n\n    /// Database's host\n    #[doku(example = \"localhost\")]\n    db_host: String,\n\n    /// Database's port\n    #[doku(example = \"5432\")]\n    db_port: usize,\n}\n\n#[derive(Deserialize, Document)]\nenum DbEngine {\n    #[serde(rename = \"pgsql\")]\n    PostgreSQL,\n\n    #[serde(rename = \"mysql\")]\n    MySQL,\n}\n\nfn main() {\n    println!(\"```json\");\n    println!(\"{}\", doku::to_json::\u003cConfig\u003e());\n    println!(\"```\");\n    println!();\n    println!(\"```toml\");\n    println!(\"{}\", doku::to_toml::\u003cConfig\u003e());\n    println!(\"```\");\n}\n```\n\n```\n{\n  // Database's engine\n  \"db_engine\": \"pgsql\" | \"mysql\",\n  // Database's host\n  \"db_host\": \"localhost\",\n  // Database's port\n  \"db_port\": 5432\n}\n```\n\n```\n# Database's engine\ndb_engine = \"pgsql\" | \"mysql\"\n\n# Database's host\ndb_host = \"localhost\"\n\n# Database's port\ndb_port = 5432\n```\n\nYou'll find more examples in [./doku/examples](./doku/examples); there's also a\ndocumentation at \u003chttps://docs.rs/doku/\u003e.\n\n## Contributing\n\nFound a bug, have an idea? Please let us know on GitHub - patches are welcome,\ntoo!\n\nIf you want to try hacking on Doku, the entry points are:\n\n- [the JSON pretty-printer](./doku/src/printers/json.rs),\n- [the TOML pretty-printer](./doku/src/printers/toml.rs),\n- [the data model](./doku/src/objects.rs),\n- [the derive macro](./doku-derive/src/lib.rs).\n\nThere are also integration tests at [./doku/tests](./doku/tests).\n\n## License\n\nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanixe%2Fdoku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanixe%2Fdoku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanixe%2Fdoku/lists"}