KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

ResourcesPoet

★ 111 Open GitHub ↗

Kotlin API for generating Android XML Resources

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ResourcePoet

Kotlin API for generating Android XML Resources

[![Maven Central](https://img.shields.io/maven-central/v/com.commit451/resourcespoet.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/com.commit451/resourcespoet)

## Gradle

```groovy
dependencies {
    implementation("com.commit451:resourcespoet:latest.release.here")
}
```

## Basic Usage

Write variables to the poet like:

```kotlin
val poet = ResourcesPoet.create()
    .addString("app_name", "Test")
    .addColor("color_primary", "#FF0000")
    .addBool("is_cool", true)
    .addComment("This is a comment")
    .addDrawable("logo", "@drawable/logo")
    .addStyle("AppTheme.Dark", "Base.AppTheme.Dark")
    // etc
    .indent(true)
val xml: String = poet.build()
println(xml)
```

which would output this XML:

```xml
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<resources>
    <string name="app_name">Test</string>
    <color name="color_primary">#FF0000</color>
    <bool name="is_cool">true</bool>
    
    <drawable name="logo">@drawable/logo</drawable>
    <style name="AppTheme.Dark" parent="Base.AppTheme.Dark"/>
</resources>
```

To get the XML result as a file:

```kotlin
val valuesFolder = File(resFolderPath + File.separator + "values")
valuesFolder.mkdirs()
val configXml = File(valuesFolder, "config.xml")
configXml.createNewFile()
poet.build(configXml)
```

You can even start with and modify an existing resource file:

```kotlin
val file = File("some/path/to/file")
val poet = ResourcesPoet.create(file)
    .remove(Type.STRING, "app_name")
    .addString("app_name", "Even Better App Name")
    .add(Type.BOOL, "is_cool", "true")
```

## Supported Types

Most [resource types](https://developer.android.com/guide/topics/resources/available-resources.html) are supported. All
look similar in usage:

```kotlin
val poet = ResourcesPoet.create()
    .addBool("is_cool", true)
    .addColor("color_primary", "#FF0000")
    .addComment("This is a comment")
    .addDimension("margin", "2dp")
    .addDrawable("logo", "@drawable/logo")
    .addId("some_id")
    .addInteger("number", 0)
    .addIntegerArray("numbers", numbers)
    .addPlurals("songs", plurals)
    .addString("app_name", "Test")
    .addStringArray("stuff", strings, translatable = false)
    .addStyle("AppTheme.Dark", "Base.AppTheme.Dark")
    .addTypedArray("some_typed_array", typedArray, translatable = false)
    .addFraction("width", "50%p")
    .addReference("my_ref", Reference("drawable", "logo"))
```

We do not allow configuration of more complicated resources like `drawable` and `anim` in the creation sense.

## Suppressing Lint Warnings

You can add `tools:ignore` to suppress Android lint warnings on individual resources or at the top level:

```kotlin
// Per-resource ignore
val poet = ResourcesPoet.create()
    .addString("app_name", "Test", toolsIgnore = "UnusedResource")
    .addColor("color_primary", "#FF0000", toolsIgnore = "UnusedIds")
```

```xml
<resources xmlns:tools="http://schemas.android.com/tools">
    <string name="app_name" tools:ignore="UnusedResource">Test</string>
    <color name="color_primary" tools:ignore="UnusedIds">#FF0000</color>
</resources>
```

You can also set `tools:ignore` at the top-level `<resources>` element to suppress warnings for all resources in the file:

```kotlin
val poet = ResourcesPoet.create()
    .toolsIgnore("UnusedResource,TypographyDashes")
    .addString("somekey", "something-else")
    .addString("anotherkey", "another-value")
```

```xml
<resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="UnusedResource,TypographyDashes">
    <string name="somekey">something-else</string>
    <string name="anotherkey">another-value</string>
</resources>
```

Top-level and per-element ignores can be combined — the top-level applies to all children, and per-element ignores override or add to it.

## Additional Features

### Translatable Attribute on Arrays

Mark string-arrays and typed-arrays as non-translatable:

```kotlin
val poet = ResourcesPoet.create()
    .addStringArray("countries", listOf("US", "UK"), translatable = false)
    .addTypedArray("items", listOf("@string/a", "@string/b"), translatable = false)
```

### Style Format Attribute

Add a `format` attribute to styles:

```kotlin
val poet = ResourcesPoet.create()
    .addStyle("MyStyle", parentRef = "Base.Style",
              styleItems = listOf(StyleItem("android:background", "@color/white")),
              format = "string|reference")
```

### Build to ByteArray

Get the XML as a `ByteArray` for in-memory processing:

```kotlin
val bytes: ByteArray = poet.buildBytes()
```

### Load Font-Family Files

Use `create(file, indent, elementType)` to load existing font-family XML files:

```kotlin
val file = File("res/font/my_fonts.xml")
val poet = ResourcesPoet.create(file, indent = true, elementType = ResourcesPoet.ELEMENT.FONT_FAMILIES)
```

License
--------

Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

ResourcesPoet

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README