jconfetti

A Java parser for the Confetti configuration language.

Confetti is a minimalistic, untyped, and unopinionated configuration language designed for human-editable configuration files. See the specification and examples to learn more.

Features

• Zero external dependencies
• Java 8+ compatible
• Full Confetti 1.0 specification compliance (passes the entire conformance test suite)
• All three official extensions: C-style comments, expression arguments, and punctuator arguments
• Strict UTF-8 validation
• Single entry-point API via Confetti
• Raw parsed access via ConfigurationUnit and Directive
• Reflection-based object mapping

Installation

Gradle

dependencies {
    implementation("io.github.welandaz:jconfetti:1.0.0")
}

Maven

<dependency>
    <groupId>io.github.welandaz</groupId>
    <artifactId>jconfetti</artifactId>
    <version>1.0.0</version>
</dependency>

Quick start

Given a configuration file app.conf:

server {
    host 127.0.0.1
    port 8080
}

database {
    url "jdbc:postgresql://localhost/mydb"
    pool_size 10
}

Parse it in Java:

import io.github.welandaz.Confetti;
import io.github.welandaz.ConfigurationUnit;
import io.github.welandaz.Directive;

import java.nio.file.Paths;

final Confetti confetti = new Confetti();
final ConfigurationUnit configurationUnit = confetti.parse(Paths.get("app.conf"));

for (final Directive directive : configurationUnit.directives()) {
    System.out.println(directive.name());

    for (final Directive child : directive.subdirectives()) {
        System.out.println("  " + child.name() + " = " + child.value(0));
    }
}

You can also parse a string directly:

import io.github.welandaz.Confetti;
import io.github.welandaz.ConfigurationUnit;

final Confetti confetti = new Confetti();
final ConfigurationUnit configurationUnit = confetti.parse("login johndoe ; password somepass123");

Or create a parser with custom default options:

import io.github.welandaz.Confetti;
import io.github.welandaz.ConfettiOptions;
import io.github.welandaz.ConfigurationUnit;

import java.nio.file.Paths;

final Confetti confetti = new Confetti(
        ConfettiOptions.builder()
                .cStyleComments(true)
                .build()
);

final ConfigurationUnit configurationUnit = confetti.parse(Paths.get("app.conf"));

Extensions

Confetti defines three optional extensions. Enable them via ConfettiOptions:

import io.github.welandaz.Confetti;
import io.github.welandaz.ConfettiOptions;
import io.github.welandaz.ConfigurationUnit;

import java.nio.file.Paths;

final ConfettiOptions confettiOptions = ConfettiOptions.builder()
        .cStyleComments(true)          // C-style // and /* */ comments
        .expressionArguments(true)     // Parenthesized expressions: func(x + 1)
        .punctuators("=", ":=", "+=")  // Custom punctuator arguments
        .build();

final ConfigurationUnit configurationUnit = new Confetti(options).parse(Paths.get("app.conf"));

Object mapping

The library can also map a parsed configuration directly onto Java objects using reflection:

import io.github.welandaz.Confetti;
import io.github.welandaz.ConfettiName;

import java.nio.file.Paths;

class AppConfig {
    Server server;
    Database database;
}

class Server {
    String host;
    int port;
    boolean debug;
}

class Database {
    String url;

    @ConfettiName("pool_size")
    int poolSize;
}

final AppConfig appConfig = new Confetti().map(Paths.get("app.conf"), AppConfig.class);

System.out.println(appConfig.server.host);
System.out.println(appConfig.server.port);
System.out.println(appConfig.database.poolSize);

If you want to inspect the raw directives before mapping, parse into a ConfigurationUnit first and then map that unit with the same Confetti instance.

Supported field types

Type	Mapping
String, CharSequence, Object	Bound from exactly one directive value argument
int / Integer, long / Long, double / Double, float / Float	Parsed from exactly one directive value argument
boolean / Boolean	Accepts true/false, yes/no, on/off, 1/0
Any class with no-arg constructor	Populated from subdirectives
List<T> and concrete List implementations	Collect repeated directives with the same name
Map<String, String> and concrete Map implementations	Populated from name key [value] directives

Building from source

./gradlew build

Running tests

The test suite runs the full Confetti conformance tests:

./gradlew test

Publishing

This project is configured to publish as:

• groupId: io.github.welandaz
• artifactId: jconfetti

The release workflow is located at .github/workflows/publish.yml.

Before publishing, update the version in build.gradle.kts and push that commit to GitHub.

Then run the workflow manually from the GitHub Actions UI.

The workflow:

1. reads the version from build.gradle.kts
2. runs the test suite
3. publishes that version to Maven Central
4. creates and pushes a Git tag with the same version only after publishing succeeds

The publish step runs:

./gradlew test publishToCentral

The task uploads the signed Maven publication and then requests automatic publication through Sonatype Central. If build.gradle.kts contains version = "1.0.0", the workflow will publish 1.0.0 and then create the Git tag 1.0.0.

License

MIT