hocones-meta-file


License

License

MIT
GroupId

GroupId

pl.muninn
ArtifactId

ArtifactId

hocones-meta-file_2.12
Last Version

Last Version

0.2
Release Date

Release Date

Type

Type

jar
Description

Description

hocones-meta-file
hocones-meta-file
Project URL

Project URL

https://github.com/plmuninn/hocones
Project Organization

Project Organization

pl.muninn
Source Code Management

Source Code Management

https://github.com/plmuninn/hocones

Download hocones-meta-file_2.12

How to add to project

<!-- https://jarcasting.com/artifacts/pl.muninn/hocones-meta-file_2.12/ -->
<dependency>
    <groupId>pl.muninn</groupId>
    <artifactId>hocones-meta-file_2.12</artifactId>
    <version>0.2</version>
</dependency>
// https://jarcasting.com/artifacts/pl.muninn/hocones-meta-file_2.12/
implementation 'pl.muninn:hocones-meta-file_2.12:0.2'
// https://jarcasting.com/artifacts/pl.muninn/hocones-meta-file_2.12/
implementation ("pl.muninn:hocones-meta-file_2.12:0.2")
'pl.muninn:hocones-meta-file_2.12:jar:0.2'
<dependency org="pl.muninn" name="hocones-meta-file_2.12" rev="0.2">
  <artifact name="hocones-meta-file_2.12" type="jar" />
</dependency>
@Grapes(
@Grab(group='pl.muninn', module='hocones-meta-file_2.12', version='0.2')
)
libraryDependencies += "pl.muninn" % "hocones-meta-file_2.12" % "0.2"
[pl.muninn/hocones-meta-file_2.12 "0.2"]

Dependencies

compile (17)

Group / Artifact Type Version
org.scala-lang : scala-library jar 2.12.6
pl.muninn : hocones-parser_2.12 jar 0.2
pl.muninn : hocones-common_2.12 jar 0.2
com.typesafe.scala-logging : scala-logging_2.12 jar 3.9.0
com.lihaoyi : pprint_2.12 jar 0.5.3
ch.qos.logback : logback-classic jar 1.2.3
io.chrisdavenport : log4cats-core_2.12 jar 0.2.0
io.chrisdavenport : log4cats-extras_2.12 jar 0.2.0
io.chrisdavenport : log4cats-slf4j_2.12 jar 0.2.0
org.typelevel : cats-core_2.12 jar 1.3.1
org.typelevel : cats-effect_2.12 jar 1.0.0
com.chuusai : shapeless_2.12 jar 2.3.3
io.circe : circe-core_2.12 jar 0.9.0
io.circe : circe-generic_2.12 jar 0.9.0
io.circe : circe-parser_2.12 jar 0.9.0
io.circe : circe-yaml_2.12 jar 0.9.0
org.scalactic : scalactic_2.12 jar 3.0.5

test (2)

Group / Artifact Type Version
org.scalatest : scalatest_2.12 jar 3.0.5
org.scalamock : scalamock_2.12 jar 4.1.0

Project Modules

There are no modules declared in this project.

Hocones

Build Status

What is hocones?

Is CLI application and sbt-plugin for managing hocon format configuration in business environment.

It help's with:

  • creating, managing documentation for configurations
  • tracking changes in environments defined in configurations
  • understanding application configuration

What exactly it does?

It loads your configuration, analyse it and generate 4 files:

  • environment file with all application environments
  • yaml meta file with flat structure of configuration, where you can describe configuration, add some more context and possible values
  • Markdown file with environment files merged with values from meta file
  • Markdown file with documentation for whole configuration merged from meta file - it also includes information like environment files, default values etc.

Why?

Because configurations are often very complex and fragile parts of software - many times not managed properly, what can lead to many problems.

hocones is also big help for DevOps and QA Engineers

Limitations

  • describing elements in array
  • scraping descriptions from hocon file comments

Versions

Version
0.2