Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SnipMeDev/Highlights
Kotlin Multiplatform (KMM) syntax highlighting engine
https://github.com/SnipMeDev/Highlights
engine kmm kmm-library kotlin kotlin-multiplatform syntax-analysis syntax-highlighting syntax-theme
Last synced: 6 days ago
JSON representation
Kotlin Multiplatform (KMM) syntax highlighting engine
- Host: GitHub
- URL: https://github.com/SnipMeDev/Highlights
- Owner: SnipMeDev
- License: apache-2.0
- Created: 2023-05-23T05:38:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-01T20:02:40.000Z (7 days ago)
- Last Synced: 2024-11-01T20:25:22.625Z (7 days ago)
- Topics: engine, kmm, kmm-library, kotlin, kotlin-multiplatform, syntax-analysis, syntax-highlighting, syntax-theme
- Language: Kotlin
- Homepage:
- Size: 473 KB
- Stars: 96
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin-multiplatform - Highlights - Kotlin Multiplatform syntax highlighting engine. (Libraries / Network)
- kmp-awesome - Highlights - Kotlin Multiplatform syntax highlighting engine (Libraries / π§ Utils)
README
[](https://mvnrepository.com/artifact/dev.snipme)
[](http://kotlinlang.org)
[](http://www.apache.org/licenses/LICENSE-2.0)
# Highlights
Kotlin Multiplatform syntax highlighting engine.
## Installation β¬οΈ
```shell
repositories {
mavenCentral()
}
```
```shell
implementation("dev.snipme:highlights:1.0.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](https://bmc.link/SnipMeDev)
## 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
```kotlin
Highlights.default().apply {
setCode("public class ExampleClass {}")
// Keywords = [public, class], Marks = [{, }]
getCodeStructure()
// BoldHighlight, ColorHighlight
getHighlights()
}
```
There is also a possibility to handle result asynchronously
```kotlin
highlights.getHighlightsAsync(
object : DefaultHighlightsResultListener() {
// onStart
// onError
// onCancel
override fun onSuccess(result: List) {
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.
```kotlin
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](/sample).
## Languages π
`C`,
`C++`,
`DART`,
`JAVA`,
`KOTLIN`,
`RUST`,
`C#`,
`COFFEESCRIPT`,
`JAVASCRIPT`,
`PERL`,
`PYTHON`,
`RUBY`,
`SHELL`,
`SWIFT`,
`TYPESCRIPT`,
`GO`,
`PHP`
## Themes ποΈ
The library comes with predefined syntax coloring themes available in `SyntaxThemes`:
### Dark π
Darcula
Monokai
Notepad
Matrix
Pastel
Atom One
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
### Light π
Darcula
Monokai
Notepad
Matrix
Pastel
Atom One
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
-  Code
-  Keyword
-  String
-  Literal
-  Comment
-  Metadata
-  Multiline Comment
-  Punctuation
-  Mark
You can also prepare your own themes and use them. Just create the `SyntaxTheme` class:
```kotlin
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
Type
Name
Library
KodeView
Application
SnippLog
Application
FlowMVI Sample
## TODO π§
- [X] Migrate some lists to sets
- [X] 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 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.