{"id":20892932,"url":"https://github.com/carmjos/yamlcommentwriter","last_synced_at":"2025-07-25T18:36:08.157Z","repository":{"id":143630361,"uuid":"616431533","full_name":"CarmJos/YAMLCommentWriter","owner":"CarmJos","description":"A file writer for yaml configuration with provided comments.","archived":false,"fork":false,"pushed_at":"2024-09-14T14:51:14.000Z","size":364,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-15T00:35:16.311Z","etag":null,"topics":["configration","yaml","yaml-configuration"],"latest_commit_sha":null,"homepage":"","language":"Java","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/CarmJos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["CarmJos"],"custom":["https://donate.carm.cc"]}},"created_at":"2023-03-20T11:30:44.000Z","updated_at":"2024-09-14T14:51:11.000Z","dependencies_parsed_at":"2024-06-04T05:29:39.846Z","dependency_job_id":"e432fc62-92e6-478f-9f2b-67ddefb8b514","html_url":"https://github.com/CarmJos/YAMLCommentWriter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarmJos%2FYAMLCommentWriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarmJos%2FYAMLCommentWriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarmJos%2FYAMLCommentWriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarmJos%2FYAMLCommentWriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CarmJos","download_url":"https://codeload.github.com/CarmJos/YAMLCommentWriter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225156982,"owners_count":17429701,"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","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":["configration","yaml","yaml-configuration"],"created_at":"2024-11-18T10:14:17.146Z","updated_at":"2024-11-18T10:14:17.666Z","avatar_url":"https://github.com/CarmJos.png","language":"Java","funding_links":["https://github.com/sponsors/CarmJos","https://donate.carm.cc"],"categories":[],"sub_categories":[],"readme":"# YAMLCommentWriter\n\n[![version](https://img.shields.io/github/v/release/CarmJos/YAMLCommentWriter)](https://github.com/CarmJos/YAMLCommentWriter/releases)\n[![License](https://img.shields.io/github/license/CarmJos/YAMLCommentWriter)](https://opensource.org/licenses/MIT)\n[![workflow](https://github.com/CarmJos/YAMLCommentWriter/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/YAMLCommentWriter/actions/workflows/maven.yml)\n[![CodeFactor](https://www.codefactor.io/repository/github/carmjos/YAMLCommentWriter/badge)](https://www.codefactor.io/repository/github/carmjos/YAMLCommentWriter)\n![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/YAMLCommentWriter)\n![](https://visitor-badge.glitch.me/badge?page_id=YAMLCommentWriter.readme)\n\nA file writer for yaml configuration with provided comments.\n\n## Usage\n1. Implement `CommentedYAML` for writer to get original config contents and comments.\n2. Use `CommentedYAMLWriter#writeWithComments(commentedYAML, file)` to write config file.\n\n## Dependency\n\n\u003cdetails\u003e\n\u003csummary\u003eMaven dependency\u003c/summary\u003e\n\n```xml\n\n\u003cproject\u003e\n    \u003crepositories\u003e\n      \n        \u003crepository\u003e\n            \u003c!--Using central repository--\u003e\n            \u003cid\u003emaven\u003c/id\u003e\n            \u003cname\u003eMaven Central\u003c/name\u003e\n            \u003curl\u003ehttps://oss.sonatype.org/content/groups/public/\u003c/url\u003e\n        \u003c/repository\u003e\n      \n        \u003crepository\u003e\n            \u003c!--Using github packages--\u003e\n            \u003cid\u003eYAMLCommentWriter\u003c/id\u003e\n            \u003cname\u003eGitHub Packages\u003c/name\u003e\n            \u003curl\u003ehttps://maven.pkg.github.com/CarmJos/YAMLCommentWriter\u003c/url\u003e\n        \u003c/repository\u003e\n      \n    \u003c/repositories\u003e\n\n    \u003cdependencies\u003e\n      \n        \u003cdependency\u003e\n            \u003cgroupId\u003ecc.carm.lib\u003c/groupId\u003e\n            \u003cartifactId\u003eYAMLCommentWriter\u003c/artifactId\u003e\n            \u003cversion\u003e[LATEST RELEASE]\u003c/version\u003e\n            \u003cscope\u003ecompile\u003c/scope\u003e\n        \u003c/dependency\u003e\n      \n    \u003c/dependencies\u003e\n\n\u003c/project\u003e\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eGradle dependency\u003c/summary\u003e\n\n```groovy\nrepositories {\n  \n    mavenCentral() // Using central repository.\n  \n    // Using github packages.\n    maven { url 'https://maven.pkg.github.com/CarmJos/YAMLCommentWriter' }\n}\n\ndependencies {\n    api \"cc.carm.lib:YAMLCommentWriter:[LATEST RELEASE]\"\n}\n```\n\n\u003c/details\u003e\n\n## Open Source License.\n\nThe project using [The MIT License](https://opensource.org/licenses/MIT) .\n\n## Support\n\nMany thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.  \n[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/CarmJos/EasySQL)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarmjos%2Fyamlcommentwriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarmjos%2Fyamlcommentwriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarmjos%2Fyamlcommentwriter/lists"}