Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carmjos/yamlcommentwriter
A file writer for yaml configuration with provided comments.
https://github.com/carmjos/yamlcommentwriter
configration yaml yaml-configuration
Last synced: about 1 month ago
JSON representation
A file writer for yaml configuration with provided comments.
- Host: GitHub
- URL: https://github.com/carmjos/yamlcommentwriter
- Owner: CarmJos
- License: mit
- Created: 2023-03-20T11:30:44.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T14:51:14.000Z (3 months ago)
- Last Synced: 2024-09-15T00:35:16.311Z (3 months ago)
- Topics: configration, yaml, yaml-configuration
- Language: Java
- Homepage:
- Size: 355 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# YAMLCommentWriter
[![version](https://img.shields.io/github/v/release/CarmJos/YAMLCommentWriter)](https://github.com/CarmJos/YAMLCommentWriter/releases)
[![License](https://img.shields.io/github/license/CarmJos/YAMLCommentWriter)](https://opensource.org/licenses/MIT)
[![workflow](https://github.com/CarmJos/YAMLCommentWriter/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/YAMLCommentWriter/actions/workflows/maven.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/carmjos/YAMLCommentWriter/badge)](https://www.codefactor.io/repository/github/carmjos/YAMLCommentWriter)
![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/YAMLCommentWriter)
![](https://visitor-badge.glitch.me/badge?page_id=YAMLCommentWriter.readme)A file writer for yaml configuration with provided comments.
## Usage
1. Implement `CommentedYAML` for writer to get original config contents and comments.
2. Use `CommentedYAMLWriter#writeWithComments(commentedYAML, file)` to write config file.## Dependency
Maven dependency
```xml
maven
Maven Central
https://oss.sonatype.org/content/groups/public/
YAMLCommentWriter
GitHub Packages
https://maven.pkg.github.com/CarmJos/YAMLCommentWriter
cc.carm.lib
YAMLCommentWriter
[LATEST RELEASE]
compile
```
Gradle dependency
```groovy
repositories {
mavenCentral() // Using central repository.
// Using github packages.
maven { url 'https://maven.pkg.github.com/CarmJos/YAMLCommentWriter' }
}dependencies {
api "cc.carm.lib:YAMLCommentWriter:[LATEST RELEASE]"
}
```## Open Source License.
The project using [The MIT License](https://opensource.org/licenses/MIT) .
## Support
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/CarmJos/EasySQL)