Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nishtahir/language-kotlin
Textmate language grammar for the Kotlin programming language
https://github.com/nishtahir/language-kotlin
grammar hacktoberfest kotlin syntax-highlighting textmate tmlanguage
Last synced: 23 days ago
JSON representation
Textmate language grammar for the Kotlin programming language
- Host: GitHub
- URL: https://github.com/nishtahir/language-kotlin
- Owner: nishtahir
- License: apache-2.0
- Created: 2018-03-13T03:06:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T04:58:57.000Z (2 months ago)
- Last Synced: 2024-10-24T22:39:59.777Z (2 months ago)
- Topics: grammar, hacktoberfest, kotlin, syntax-highlighting, textmate, tmlanguage
- Language: Kotlin
- Homepage:
- Size: 437 KB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Language Kotlin
A textmate compatible grammar for the Kotlin language.
[](https://codecov.io/gh/nishtahir/language-kotlin)
## Setup
This project is built using a couple of handy node scripts. Begin by installing the
required dependencies.
```
$ npm install
```
## Build
Changes to the grammar should be made in the `src` folder. These are merged at build
time and used to produce the final artifact.
Once you are satisfied with your changes, you will need to generate
`xml` and `json` variants for distribution.
There's a handy build script available to automate this process.
```
$ npm run build
```
This will outputs the merged sources to the `dist` directory. At this point
it's highly recommended that you test your changes using [GitHub Lightshow](https://github-lightshow.herokuapp.com/). There's some manual work involved in doing this however this is the closest
representation of what it would look like when it is deployed that is available at this time.
You can format your sources using the code formatting script.
```
$ npm run format
```
## Testing
> All changes to the grammar must be accompanied by tests covering relevant scopes.
Tests are run using [`vscode-tmgrammar-test`](https://github.com/PanAeon/vscode-tmgrammar-test).
Test cases and regression tests are available in the `/test` folder.
Generated snapshots are available in the `/snapshots` folder and should be updated with changes
to the grammar.
The test suite can be run using `npm`
```
$ npm test
```
## Useful resources
- [NovaLightshow](https://novalightshow.netlify.app/) - Useful for testing Grammar sources against Code to inspect the highlighting behavior. Thanks to [Nixinova](https://github.com/Nixinova/NovaLightshow)
- [Sublime Text scope naming reference](https://www.sublimetext.com/docs/3/scope_naming.html) - Reference on Textmate scope naming
## Code of Conduct
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md) which _must_ be observed in interactions with the project.