Highlights

1.1.0indexed

Syntax highlighting engine supports multiple programming languages, customizable themes, and efficient incremental updates. Emphasizes keywords, comments, and other code components, with built-in caching for optimal performance.

JSJVMNativeWasm·SnipMeDev/Highlights

187

Stars

Used by

dependents

—

Health

/ 100

highlights_banner_opaque

Highlights

Kotlin Multiplatform syntax highlighting engine.

Installation ⬇️

repositories {
    mavenCentral()
}

implementation("dev.snipme:highlights:1.1.0")

Features ✨

Code component analysis (Keyword, comment, etc.)
Multiple syntax languages (Java, Swift, Kotlin, C, ...)
Themes
Text bolding (emphasis)
Result caching and support for incremental changes
Written in pure Kotlin, so available for many platforms 📱 💻 🖥️
Sync or async mode

Support ☕

Kotlin Multiplatform is a fresh environment and developing for it is neither fast nor easy 🥲

If you feel that any of our project has saved you a time or effort, then consider supporting us via:
🧋 Buy Me A Coffee

Usage ✍️

💡 As each Highlights instance caches code analysis, it is recommended to re-use the same instance for small code changes.

To start, simply put any code snippet in the default builder

Highlights.default().apply {
    setCode("public class ExampleClass {}")
    // Keywords = [public, class], Marks = [{, }]
    getCodeStructure()
    // BoldHighlight, ColorHighlight
    getHighlights()
}

There is also a possibility to handle result asynchronously

highlights.getHighlightsAsync(
    object : DefaultHighlightsResultListener() {
        // onStart
        // onError
        // onCancel
        override fun onSuccess(result: List<CodeHighlight>) {
            emitResult(highlights)
        }
    }
)

You can also set language, theme and phrase emphasis. Language and theme has impact on the ColorHighlight and emphasis is represented by the BoldHighlight.

Highlights.Builder()
    .code("public class ExampleClass {}")
    .theme(SyntaxThemes.monokai())
    .language(SyntaxLanguage.JAVA)
    .emphasis(PhraseLocation(13, 25)) // ExampleClass
    .build()
    .run {
        getHighlights()
    }

More advance usage of this library is shown here.

Languages 🌍

, , , , , , , , , , , , , , , ,

Themes 🖌️

The library comes with predefined syntax coloring themes available in SyntaxThemes:

Dark 🌚

Light 🌞

You can also prepare your own themes and use them. Just create the SyntaxTheme class:

SyntaxTheme(
    key = "MY_THEME",
    code = 0xEDEDED,
    keyword = 0xCC7832,
    string = 0x6A8759,
    literal = 0x6897BB,
    comment = 0x909090,
    metadata = 0xBBB529,
    multilineComment = 0x629755,
    punctuation = 0xCC7832,
    mark = 0xEDEDED
)

Popular uses 🙌

If your project uses this code, please write me or add your info

TODO 🚧

Migrate some lists to sets
Optimize code analysis
Add more themes and languages
Support italic and underline text style

Contribution 💻

Any form of support is very welcomed. Bugs, problems and new feature requests should be placed in the Issues tab with proper labeling. New feature can be also submitted via Pull Requests. Then make sure:

Current and added tests have passed
CHANGELOG and README have been updated
New code matches library's vision and code style

License 🖋️

Copyright 2023-2024 Tomasz Kądziołka.

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

   http:

Unless   applicable law  agreed to  writing, software
distributed under the License  distributed  an  BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express  implied.
See the License  the specific language governing permissions 
limitations under the License.

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

annotation★ 6.0k

androidxExposes metadata to help tools and developers understand code, offering common API annotations (including Java-compatible OptIn) and dependency artifacts for easy integration.Shared: utility

RSS-Parser★ 613

prof18Parses RSS and Atom feeds, extracting data like titles, descriptions, links, and various multimedia attributes. Supports custom configurations for networking and character sets, and integrates with Java projects using CompletableFuture.Shared: utility

colormath★ 370

ajaltLibrary for color manipulation and conversion, supporting various color models and spaces. Includes features like color mixing, chromatic adaptation, WCAG contrast, perceptual difference calculations, gradient generation, and CSS-compatible color string rendering.Shared: utility

byte-size★ 209

saketSimplifies handling of file and data sizes, supporting conversions between units like bytes, kilobytes, megabytes, and gigabytes, along with arithmetic operations and human-readable formatting.Shared: utility

alchemist★ 176

kevincianfariniFacilitates type-safe arithmetic operations for physical quantities using SI units, enabling logical modeling of quantities and customizable unit extensions with easy extensibility for custom formulas.Shared: utility

kotlin-semver★ 155

z4kn4feinImplements semantic versioning specification, enabling parsing, comparing, incrementing, and validating semantic versions. Supports constraints, range conditions, and provides detailed handling of version components.Shared: utility

Type	Name
Library	KodeView
Application	SnippLog
Application	FlowMVI Sample