Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edadma/highlighter
Syntax highlighter written in Scala
https://github.com/edadma/highlighter
Last synced: 14 days ago
JSON representation
Syntax highlighter written in Scala
- Host: GitHub
- URL: https://github.com/edadma/highlighter
- Owner: edadma
- License: isc
- Created: 2018-06-22T23:57:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-18T20:45:14.000Z (over 2 years ago)
- Last Synced: 2024-11-19T10:12:50.308Z (3 months ago)
- Language: Scala
- Size: 282 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Highlighter
===========
[](https://www.travis-ci.org/edadma/highlighter)
[](https://ci.appveyor.com/project/edadma/highlighter)
[](https://coveralls.io/github/edadma/highlighter?branch=master)
[](https://github.com/edadma/highlighter/blob/master/LICENSE)
[](https://github.com/edadma/highlighter/releases/tag/v0.1.7)
*Highlighter* is a regular expression based syntax highlighter library written in [Scala](http://scala-lang.org). Highlighter is inspired by [Pygments](http://pygments.org/), and it is not difficult to port Pygments lexers to Highlighter. Highlighter has a convenient definition language to make it easier to develop new highlighters.
Examples
--------
### Highlighter Definition
Here's an example of a typical Highlighter definition and the result of applying it to a small HTML document. This definition is a port of the [Pygments HTML Lexer](https://bitbucket.org/birkenfeld/pygments-main/src/default/pygments/lexers/html.py) which includes CSS highlighting for `style` elements.
#### Definition
```
highlighter
name: HTML
options
regex: dotall ignorecase
templates
default: {{ \escape\text }}
states
root:
&\S*?; => Name.Entity
\<\!\[CDATA\[.*?\]\]\> => Comment.Preproc
=> Comment ^
- => Comment
tag:
([\w:-]+)\s*(=)\s* => (Name.Attribute Operator) >attr
[\w:-]+ => Name.Attribute
(/?)\s*(>) => (Punctuation Punctuation) ^
script-content:
(<)\s*(/)\s*(script)\s*(>) => (Punctuation Punctuation Name.Tag Punctuation) ^
.+?(?=<\s*/\s*script\s*>) => [javascript]
style-content:
(<)\s*(/)\s*(style)\s*(>) => (Punctuation Punctuation Name.Tag Punctuation) ^
.+?(?=<\s*/\s*style\s*>) => [css]
attr:
".*?" => String ^
'.*?' => String ^
[^\s>]+ => String ^
```
#### Input
```
body {background-color: powderblue;}
p {color: red;}
<paragraph>
```
#### Output
The styling that was used for the highlighting was Pygments "friendly" theme.
Usage
-----
### Library
Use the following definition to use Highlighter in your Maven project:
```xml
hyperreal
https://dl.bintray.com/edadma/maven
io.github.edadma
highlighter
0.1.7
```
Add the following to your `build.sbt` file to use Highlighter in your SBT project:
```sbt
resolvers += "Hyperreal Repository" at "https://dl.bintray.com/edadma/maven"
libraryDependencies += "io.github.edadma" %% "highlighter" % "0.1.0"
```
### Executable
An executable can be downloaded from [here](https://dl.bintray.com/edadma/generic/highlighter-0.1.7.jar). *You do not need* the Scala library for it to work because the JAR already contains all dependencies. You just need Java 8+ installed.
Run it as a normal Java executable JAR with the command `java -jar highlighter-0.1.7.jar ... []` in the folder where you downloaded the file, where *definition* is the name of the highlighter definition file, and is the file containing the code to be highlighted. If multiple definition files are given, the first one is used for highlighting and the others are passed to it as dependencies.
Building
--------
### Requirements
- Java 8
- SBT 1.1.5+
- Scala 2.12.6+
### Clone and Assemble Executable
```bash
git clone git://github.com/edadma/highlighter.git
cd highlighter
sbt assembly
```
The command `sbt assembly` also runs all the unit tests.
License
-------
ISC © 2018 Edward A. Maxedon, Sr.