https://github.com/ibilon/highlighter
Tool used to highlight text according to a textmate tmLanguage file
https://github.com/ibilon/highlighter
language-grammars syntax-highlighting
Last synced: about 2 months ago
JSON representation
Tool used to highlight text according to a textmate tmLanguage file
- Host: GitHub
- URL: https://github.com/ibilon/highlighter
- Owner: ibilon
- License: mit
- Created: 2018-04-07T16:01:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T08:31:58.000Z (9 months ago)
- Last Synced: 2025-01-18T06:10:09.938Z (4 months ago)
- Topics: language-grammars, syntax-highlighting
- Language: Haxe
- Size: 29.3 KB
- Stars: 10
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Highlighter
Tool used to highlight text according to a textmate tmLanguage file.
Output CSS and HTML code.
The built-in themes are from [VSCode](https://github.com/Microsoft/vscode).
## Compilation
Get the required dependencies with:
```
npm install
haxelib install build.hxml
```
Then compile with:
```
haxe build.hxml
```
## Usage as a tool
### Get CSS
This will output the css styling necessary to display the highlighted content.
```
node bin/highlighter.js css [--theme=light|dark|/path/to/file]
```
By default the light theme is used.
### Highlight a file
This will apply syntax highlighting to the whole file and output the result on the console.
```
node bin/highlighter.js highlight --grammar=/path/to/file --input=stdin|file [--file=/path/to/file] [--theme=light|dark|/path/to/file]
```
By default the light theme is used.
If you use `--input=file` you need to specify the `--file` argument.
## Usage as a lib
You need to target nodejs, add `-lib highlighter` to your command.
To create and use a highlighter:
```haxe
highlighter.Highlighter.loadHighlighter("grammar/someGrammar.tmLanguage", function(h) {
var s = h.runContent("class C { }"); // Highlight a string
var s = h.runFile("test/some.file"); // Highlight a file
var s = h.runStdin(); // Highlight the content of stdin, if you pipe a file
});
```
To get the css rules for the style you are using:
```haxe
highlighter.Highlighter.loadHighlighter("grammar/someGrammar.tmLanguage", function(h) {
var s = h.runCss();
});
```
Patching will parse a html file, or a folder of it, and apply syntax highlighting to the following blocks:
```html
```
```haxe
var getLang = function (classText) return classText.substr(12); // To filter class="prettyprint haxe" into "haxe"
highlighter.Highlighter.loadHighlighters(["haxe" => "grammars/haxe.tmLanguage"], function(grammars) {
var missingGrammars = Highlighter.patchFile("some.file", grammars, getLang); // Patch a single file
var recursive = true;
var missingGrammars = Highlighter.patchDirectory("/some/path", grammars, getLang, recursive); // Patch a folder recursively (or not).
})
```
## License
[MIT](LICENSE.md)