mirror of
https://github.com/rwinkhart/go-highlite.git
synced 2026-09-05 16:37:20 -04:00
Rename "syntax" package to "lexers"
This commit is contained in:
@@ -9,14 +9,14 @@ It is meant to be a more minimal version with the syntax files embedded in the G
|
||||
|
||||
Language support is determined at build time by using build tags. To include a language, you must build with the appropriate tag.
|
||||
For example, to include Go syntax highlighting, you must build with `-tags=stxGo`.
|
||||
You may combine as many tags as you like, or use `-tags=stxAll` to include all syntax layers.
|
||||
You may combine as many tags as you like, or use `-tags=stxAll` to include all lexers.
|
||||
|
||||
### Contributing
|
||||
If you would like to contribute a new syntax layer, please contribute to the parent repository [jessp01/gohighlight](https://github.com/jessp01/gohighlight).
|
||||
In an effort to minimize the size of this library, the syntax layers are modified to the point of being much less readable than the original.
|
||||
Because of this, the parent repository is the canonical source for syntax layers.
|
||||
If you would like to contribute a new lexer, please contribute to the parent repository [jessp01/gohighlight](https://github.com/jessp01/gohighlight).
|
||||
In an effort to minimize the size of this library, the lexers are modified to the point of being much less readable than the original.
|
||||
Because of this, the parent repository is the canonical source for lexers.
|
||||
|
||||
I will keep this repository up-to-date with any new syntax layers that are added to the parent repository, provided that they are for non-obsolete
|
||||
I will keep this repository up-to-date with any new lexers that are added to the parent repository, provided that they are for non-obsolete
|
||||
programming languages or config formats (support will not be extended to cover individual shell commands).
|
||||
|
||||
Other types of contributions are welcome as long as they do not go against the goal of keeping this library as lightweight as possible.
|
||||
@@ -29,7 +29,7 @@ $ go get github.com/rwinkhart/go-highlite
|
||||
## Basic Usage
|
||||
Below is a simple example for highlighting a Go snippet with ANSI colors.
|
||||
|
||||
It must be built with `-tags=stxGo` or `-tags=stxAll` to include the Go syntax layer.
|
||||
It must be built with `-tags=stxGo` or `-tags=stxAll` to include the Go lexer.
|
||||
|
||||
For a more advanced example on manually colorizing the output or colorizing it in a
|
||||
different, non-ANSI format, see the `ansi.Colorize` function.
|
||||
@@ -67,13 +67,15 @@ func helloWorld() {
|
||||
## Roadmap
|
||||
- [ ] Implement more comprehensive testing
|
||||
- [ ] Upgrade to gopkg.in/yaml.v3 **OR** remove the need for the dependency
|
||||
- [ ] Add Zig syntax layer (and upstream it)
|
||||
- [ ] Add lexers (and upstream them)
|
||||
- [ ] Zig
|
||||
- [ ] Kotlin
|
||||
- [ ] Upstream relevant changes
|
||||
- [ ] staticcheck warnings (f5367779eb4bcaaca0640f1ce7316001e34f41d8)
|
||||
- [ ] Modernization (depending on Go version support)
|
||||
- [ ] c884c602e382789bf1ccef251d0d85af43da03e0
|
||||
- [ ] 11161c71cdbbec95f6bacc3590b9077b4cac3668
|
||||
- [ ] Syntax layer changes
|
||||
- [ ] Lexer changes
|
||||
- [ ] ef2880834a545b5353a35c7d918310b23d39d4f3
|
||||
- [ ] bae08261278f21569fc2266b4a4933a6c85b9b25
|
||||
- [ ] 6e8f69839f82fe23a3442f7f9d62d166cac260e3 (maybe)
|
||||
|
||||
Reference in New Issue
Block a user