{"id":13536701,"url":"https://github.com/SnipMeDev/Highlights","last_synced_at":"2025-04-02T03:30:59.621Z","repository":{"id":168712017,"uuid":"644238604","full_name":"SnipMeDev/Highlights","owner":"SnipMeDev","description":"Kotlin Multiplatform (KMM) syntax highlighting engine","archived":false,"fork":false,"pushed_at":"2024-11-01T20:02:40.000Z","size":484,"stargazers_count":96,"open_issues_count":8,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-01T20:25:22.625Z","etag":null,"topics":["engine","kmm","kmm-library","kotlin","kotlin-multiplatform","syntax-analysis","syntax-highlighting","syntax-theme"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SnipMeDev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-23T05:38:44.000Z","updated_at":"2024-10-31T03:14:53.000Z","dependencies_parsed_at":"2024-01-16T15:40:23.865Z","dependency_job_id":"4251faea-ef33-4583-b36e-adfb8868c935","html_url":"https://github.com/SnipMeDev/Highlights","commit_stats":null,"previous_names":["snipmedev/highlights"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnipMeDev%2FHighlights","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnipMeDev%2FHighlights/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnipMeDev%2FHighlights/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnipMeDev%2FHighlights/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SnipMeDev","download_url":"https://codeload.github.com/SnipMeDev/Highlights/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246750976,"owners_count":20827812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["engine","kmm","kmm-library","kotlin","kotlin-multiplatform","syntax-analysis","syntax-highlighting","syntax-theme"],"created_at":"2024-08-01T09:00:47.500Z","updated_at":"2025-04-02T03:30:59.218Z","avatar_url":"https://github.com/SnipMeDev.png","language":"Kotlin","funding_links":[],"categories":["Libraries"],"sub_categories":["Network","🔧 Utils"],"readme":"![highlights_banner_opaque](https://github.com/SnipMeDev/Highlights/assets/8405055/e123ce0f-6f58-451a-9e0a-893c0809b909)\n\n[![Maven Central](https://img.shields.io/maven-central/v/dev.snipme/highlights)](https://mvnrepository.com/artifact/dev.snipme)\n[![Kotlin](https://img.shields.io/badge/kotlin-2.0.20-blue.svg?logo=kotlin)](http://kotlinlang.org)\n[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)\n\n# Highlights\nKotlin Multiplatform syntax highlighting engine.\n\n## Installation ⬇️\n```shell\nrepositories {\n    mavenCentral()\n}\n```\n\n```shell\nimplementation(\"dev.snipme:highlights:1.0.0\")\n```\n\n## Features ✨\n- Code component analysis (Keyword, comment, etc.)\n- Multiple syntax languages (Java, Swift, Kotlin, C, ...)\n- Themes\n- Text bolding (emphasis)\n- Result caching and support for incremental changes\n- Written in pure Kotlin, so available for many platforms 📱 💻 🖥️\n- Sync or async mode\n\n## Support ☕\nKotlin Multiplatform is a fresh environment and developing for it is neither fast nor easy 🥲\n\nIf you feel that any of our project has saved you a time or effort, then consider supporting us via:  \n[🧋 Buy Me A Coffee](https://bmc.link/SnipMeDev)\n\n## Usage ✍️\n\n\u003e 💡 As each Highlights instance caches code analysis, it is recommended to re-use the same instance for small code changes.\n\nTo start, simply put any code snippet in the default builder\n\n```kotlin\nHighlights.default().apply {\n    setCode(\"public class ExampleClass {}\")\n    // Keywords = [public, class], Marks = [{, }]\n    getCodeStructure()\n    // BoldHighlight, ColorHighlight\n    getHighlights()\n}\n```\n\nThere is also a possibility to handle result asynchronously\n\n```kotlin\nhighlights.getHighlightsAsync(\n    object : DefaultHighlightsResultListener() {\n        // onStart\n        // onError\n        // onCancel\n        override fun onSuccess(result: List\u003cCodeHighlight\u003e) {\n            emitResult(highlights)\n        }\n    }\n)\n```\n\nYou can also set language, theme and phrase emphasis. \nLanguage and theme has impact on the ColorHighlight and emphasis is represented by the BoldHighlight.\n\n```kotlin\nHighlights.Builder()\n    .code(\"public class ExampleClass {}\")\n    .theme(SyntaxThemes.monokai())\n    .language(SyntaxLanguage.JAVA)\n    .emphasis(PhraseLocation(13, 25)) // ExampleClass\n    .build()\n    .run {\n        getHighlights()\n    }\n```\n\nMore advance usage of this library is shown [here](/sample).\n\n## Languages 🌍\n\n`C`,\n`C++`,\n`DART`,\n`JAVA`,\n`KOTLIN`,\n`RUST`,\n`C#`,\n`COFFEESCRIPT`,\n`JAVASCRIPT`,\n`PERL`,\n`PYTHON`,\n`RUBY`,\n`SHELL`,\n`SWIFT`,\n`TYPESCRIPT`,\n`GO`,\n`PHP`\n\n## Themes 🖌️\n\nThe library comes with predefined syntax coloring themes available in `SyntaxThemes`:\n\n### Dark 🌚\n\n\u003ctable\u003e\n    \u003cth\u003eDarcula\u003c/th\u003e\n    \u003cth\u003eMonokai\u003c/th\u003e\n    \u003cth\u003eNotepad\u003c/th\u003e\n    \u003cth\u003eMatrix\u003c/th\u003e\n    \u003cth\u003ePastel\u003c/th\u003e\n    \u003cth\u003eAtom One\u003c/th\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\n\n- ![#EDEDED](https://placehold.co/15x15/EDEDED/EDEDED.png) Code\n- ![#CC7832](https://placehold.co/15x15/CC7832/CC7832.png) Keyword\n- ![#6A8759](https://placehold.co/15x15/6A8759/6A8759.png) String\n- ![#6897BB](https://placehold.co/15x15/6897BB/6897BB.png) Literal\n- ![#909090](https://placehold.co/15x15/909090/909090.png) Comment\n- ![#BBB529](https://placehold.co/15x15/BBB529/BBB529.png) Metadata\n- ![#629755](https://placehold.co/15x15/629755/629755.png) Multiline Comment\n- ![#CC7832](https://placehold.co/15x15/CC7832/CC7832.png) Punctuation\n- ![#EDEDED](https://placehold.co/15x15/EDEDED/EDEDED.png) Mark\n        \u003c/td\u003e\n\u003ctd\u003e\n\n- ![#F8F8F2](https://placehold.co/15x15/F8F8F2/F8F8F2.png) Code\n- ![#F92672](https://placehold.co/15x15/F92672/F92672.png) Keyword\n- ![#E6DB74](https://placehold.co/15x15/E6DB74/E6DB74.png) String\n- ![#AE81FF](https://placehold.co/15x15/AE81FF/AE81FF.png) Literal\n- ![#FD971F](https://placehold.co/15x15/FD971F/FD971F.png) Comment\n- ![#B8F4B8](https://placehold.co/15x15/B8F4B8/B8F4B8.png) Metadata\n- ![#FD971F](https://placehold.co/15x15/FD971F/FD971F.png) Multiline Comment\n- ![#F8F8F2](https://placehold.co/15x15/F8F8F2/F8F8F2.png) Punctuation\n- ![#F8F8F2](https://placehold.co/15x15/F8F8F2/F8F8F2.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#000080](https://placehold.co/15x15/000080/000080.png) Code\n- ![#0000FF](https://placehold.co/15x15/0000FF/0000FF.png) Keyword\n- ![#808080](https://placehold.co/15x15/808080/808080.png) String\n- ![#FF8000](https://placehold.co/15x15/FF8000/FF8000.png) Literal\n- ![#008000](https://placehold.co/15x15/008000/008000.png) Comment\n- ![#000080](https://placehold.co/15x15/000080/000080.png) Metadata\n- ![#008000](https://placehold.co/15x15/008000/008000.png) Multiline Comment\n- ![#AA2C8C](https://placehold.co/15x15/AA2C8C/AA2C8C.png) Punctuation\n- ![#AA2C8C](https://placehold.co/15x15/AA2C8C/AA2C8C.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Code\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Keyword\n- ![#269926](https://placehold.co/15x15/269926/269926.png) String\n- ![#39E639](https://placehold.co/15x15/39E639/39E639.png) Literal\n- ![#67E667](https://placehold.co/15x15/67E667/67E667.png) Comment\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Metadata\n- ![#67E667](https://placehold.co/15x15/67E667/67E667.png) Multiline Comment\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Punctuation\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#DFDEE0](https://placehold.co/15x15/DFDEE0/DFDEE0.png) Code\n- ![#729FCF](https://placehold.co/15x15/729FCF/729FCF.png) Keyword\n- ![#93CF55](https://placehold.co/15x15/93CF55/93CF55.png) String\n- ![#8AE234](https://placehold.co/15x15/8AE234/8AE234.png) Literal\n- ![#888A85](https://placehold.co/15x15/888A85/888A85.png) Comment\n- ![#5DB895](https://placehold.co/15x15/5DB895/5DB895.png) Metadata\n- ![#888A85](https://placehold.co/15x15/888A85/888A85.png) Multiline Comment\n- ![#CB956D](https://placehold.co/15x15/CB956D/CB956D.png) Punctuation\n- ![#CB956D](https://placehold.co/15x15/CB956D/CB956D.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#DFDEE0](https://placehold.co/15x15/BBBBBB/BBBBBB.png) Code\n- ![#729FCF](https://placehold.co/15x15/D55FDE/D55FDE.png) Keyword\n- ![#93CF55](https://placehold.co/15x15/89CA78/89CA78.png) String\n- ![#8AE234](https://placehold.co/15x15/D19A66/D19A66.png) Literal\n- ![#888A85](https://placehold.co/15x15/5C6370/5C6370.png) Comment\n- ![#5DB895](https://placehold.co/15x15/E5C07B/E5C07B.png) Metadata\n- ![#888A85](https://placehold.co/15x15/5C6370/5C6370.png) Multiline Comment\n- ![#CB956D](https://placehold.co/15x15/EF596F/EF596F.png) Punctuation\n- ![#CB956D](https://placehold.co/15x15/2BBAC5/2BBAC5.png) Mark\n\n\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n### Light 🌞\n\n\u003ctable\u003e\n    \u003cth\u003eDarcula\u003c/th\u003e\n    \u003cth\u003eMonokai\u003c/th\u003e\n    \u003cth\u003eNotepad\u003c/th\u003e\n    \u003cth\u003eMatrix\u003c/th\u003e\n    \u003cth\u003ePastel\u003c/th\u003e\n    \u003cth\u003eAtom One\u003c/th\u003e\n    \u003ctr\u003e\n\u003ctd\u003e\n\n- ![#121212](https://placehold.co/15x15/121212/121212.png) Code\n- ![#CC7832](https://placehold.co/15x15/CC7832/CC7832.png) Keyword\n- ![#6A8759](https://placehold.co/15x15/6A8759/6A8759.png) String\n- ![#6897BB](https://placehold.co/15x15/6897BB/6897BB.png) Literal\n- ![#909090](https://placehold.co/15x15/909090/909090.png) Comment\n- ![#BBB529](https://placehold.co/15x15/BBB529/BBB529.png) Metadata\n- ![#629755](https://placehold.co/15x15/629755/629755.png) Multiline Comment\n- ![#CC7832](https://placehold.co/15x15/CC7832/CC7832.png) Punctuation\n- ![#121212](https://placehold.co/15x15/121212/121212.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#07070D](https://placehold.co/15x15/07070D/07070D.png) Code\n- ![#F92672](https://placehold.co/15x15/F92672/F92672.png) Keyword\n- ![#E6DB74](https://placehold.co/15x15/E6DB74/E6DB74.png) String\n- ![#AE81FF](https://placehold.co/15x15/AE81FF/AE81FF.png) Literal\n- ![#FD971F](https://placehold.co/15x15/FD971F/FD971F.png) Comment\n- ![#B8F4B8](https://placehold.co/15x15/B8F4B8/B8F4B8.png) Metadata\n- ![#FD971F](https://placehold.co/15x15/FD971F/FD971F.png) Multiline Comment\n- ![#07070D](https://placehold.co/15x15/07070D/07070D.png) Punctuation\n- ![#07070D](https://placehold.co/15x15/07070D/07070D.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#000080](https://placehold.co/15x15/000080/000080.png) Code\n- ![#0000FF](https://placehold.co/15x15/0000FF/0000FF.png) Keyword\n- ![#808080](https://placehold.co/15x15/808080/808080.png) String\n- ![#FF8000](https://placehold.co/15x15/FF8000/FF8000.png) Literal\n- ![#008000](https://placehold.co/15x15/008000/008000.png) Comment\n- ![#000080](https://placehold.co/15x15/000080/000080.png) Metadata\n- ![#008000](https://placehold.co/15x15/008000/008000.png) Multiline Comment\n- ![#AA2C8C](https://placehold.co/15x15/AA2C8C/AA2C8C.png) Punctuation\n- ![#AA2C8C](https://placehold.co/15x15/AA2C8C/AA2C8C.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Code\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Keyword\n- ![#269926](https://placehold.co/15x15/269926/269926.png) String\n- ![#39E639](https://placehold.co/15x15/39E639/39E639.png) Literal\n- ![#67E667](https://placehold.co/15x15/67E667/67E667.png) Comment\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Metadata\n- ![#67E667](https://placehold.co/15x15/67E667/67E667.png) Multiline Comment\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Punctuation\n- ![#008500](https://placehold.co/15x15/008500/008500.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#20211F](https://placehold.co/15x15/20211F/20211F.png) Code\n- ![#729FCF](https://placehold.co/15x15/729FCF/729FCF.png) Keyword\n- ![#93CF55](https://placehold.co/15x15/93CF55/93CF55.png) String\n- ![#8AE234](https://placehold.co/15x15/8AE234/8AE234.png) Literal\n- ![#888A85](https://placehold.co/15x15/888A85/888A85.png) Comment\n- ![#5DB895](https://placehold.co/15x15/5DB895/5DB895.png) Metadata\n- ![#888A85](https://placehold.co/15x15/888A85/888A85.png) Multiline Comment\n- ![#CB956D](https://placehold.co/15x15/CB956D/CB956D.png) Punctuation\n- ![#CB956D](https://placehold.co/15x15/CB956D/CB956D.png) Mark\n\u003c/td\u003e\n\u003ctd\u003e\n\n- ![#DFDEE0](https://placehold.co/15x15/383A42/383A42.png) Code\n- ![#729FCF](https://placehold.co/15x15/A626A4/A626A4.png) Keyword\n- ![#93CF55](https://placehold.co/15x15/50A14F/50A14F.png) String\n- ![#8AE234](https://placehold.co/15x15/986801/986801.png) Literal\n- ![#888A85](https://placehold.co/15x15/A1A1A1/A1A1A1.png) Comment\n- ![#5DB895](https://placehold.co/15x15/C18401/C18401.png) Metadata\n- ![#888A85](https://placehold.co/15x15/A1A1A1/A1A1A1.png) Multiline Comment\n- ![#CB956D](https://placehold.co/15x15/E45649/E45649.png) Punctuation\n- ![#CB956D](https://placehold.co/15x15/526FFF/526FFF.png) Mark\n\n\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\nYou can also prepare your own themes and use them. Just create the `SyntaxTheme` class:\n\n```kotlin\nSyntaxTheme(\n    key = \"MY_THEME\",\n    code = 0xEDEDED,\n    keyword = 0xCC7832,\n    string = 0x6A8759,\n    literal = 0x6897BB,\n    comment = 0x909090,\n    metadata = 0xBBB529,\n    multilineComment = 0x629755,\n    punctuation = 0xCC7832,\n    mark = 0xEDEDED\n)\n```\n\n## Popular uses 🙌\n\nIf your project uses this code, please write me or add your info\n\n\u003ctable\u003e\n    \u003cth\u003eType\u003c/th\u003e\n    \u003cth\u003eName\u003c/th\u003e\n    \u003ctr\u003e\n        \u003ctd\u003eLibrary\u003c/td\u003e\n        \u003ctd\u003e\n            \u003ca href=\"https://github.com/SnipMeDev/KodeView\"\u003eKodeView\u003c/a\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003eApplication\u003c/td\u003e\n        \u003ctd\u003e \u003ca href=\"https://play.google.com/store/apps/details?id=pl.tkadziolka.snipbook\"\u003eSnippLog\u003c/a\u003e \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003eApplication\u003c/td\u003e\n        \u003ctd\u003e \u003ca href=\"https://opensource.respawn.pro/FlowMVI/sample/\"\u003eFlowMVI Sample\u003c/a\u003e \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n## TODO 🚧\n- [X] Migrate some lists to sets\n- [X] Optimize code analysis\n- [ ] Add more themes and languages\n- [ ] Support italic and underline text style\n\n## Contribution 💻\nAny form of support is very welcomed. \nBugs, problems and new feature requests should be placed in the `Issues` tab with proper labeling.\nNew feature can be also submitted via `Pull Requests`. \nThen make sure:\n- Current and added tests have passed\n- CHANGELOG and README have been updated\n- New code matches library's vision and code style\n\nLicense 🖋️\n=======\n\n    Copyright 2023-2024 Tomasz Kądziołka.\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnipMeDev%2FHighlights","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSnipMeDev%2FHighlights","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnipMeDev%2FHighlights/lists"}