nbirillo / arrow-meta

Functional companion to Kotlin's Compiler

Λrrow Meta

Functional companion to Kotlin's Compiler & IDE

Getting started

Λrrow Meta is a meta-programming library that cooperates with the Kotlin compiler in all it's phases bringing its full power to the community.

Writing compiler plugins, source transformations, IDEA plugins, linters, type search engines, automatic code refactoring,... are just a few of the use cases of the things that can be accomplished with Meta.

Λrrow Meta examples

Take a look at arrow-meta-examples repository for getting more details.

Build and run in your local environment

Pre-requirements: JDK 8

Build and run tests

./gradlew buildMeta

Build and run test + IDE plugin

./gradlew publishAndRunIde

Generate API Doc and validate it

./gradlew buildMetaDoc

Run the docs in your local server

./gradlew buildMetaDoc
bundle install --gemfile docs/Gemfile --path vendor/bundle
BUNDLE_GEMFILE=docs/Gemfile bundle exec jekyll serve -s docs/build/site/

Testing

Λrrow Meta provides an easy way to write tests about plugins, quotes, etc. thanks to Kotlin Compile Testing, a library developed by Thilo Schuchort.

Contributing

Λrrow Meta is an inclusive community powered by awesome individuals like you. As an actively growing ecosystem, Λrrow Meta and its associated libraries and toolsets are in need of new contributors! We have issues suited for all levels, from entry to advanced, and our maintainers are happy to provide 1:1 mentoring. All are welcome in Λrrow Meta.

If you’re looking to contribute, have questions, or want to keep up-to-date about what’s happening, please follow us here and say hello!

• #arrow-meta on Kotlin Slack

Licence

Copyright (C) 2017 The Λrrow Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.