jstuyts / kotlin-multiplatform-recipes

Recipes for building multi-platform Kotlin modules.

NO LONGER RELEVANT

Multi-platform Kotlin has undergone signifcant changes after I stopped updating this. Please see the current documentation.

Recipes for Multi-Platform Kotlin Modules

This project is a testbed for multi-platform Kotlin modules. It shows how you could implement modules that have code that is common for all platforms, and that may need platform-specific code for (some of) its types and functions.

Note that you have to change settings in IntelliJ IDEA to be able to build the project and run the examples from your IDE. See the item about IntelliJ IDEA under current issues below.

Recipes for unit tests for common and platform-specific code are available. Execute the following command to run the Java tests. The test output can be found in jvm/build/reports/tests/test/index.html:

./gradlew :jvm:test

Execute the following command to run the JavaScript tests. The test output can be found in the build output:

./gradlew :js:test

Current Issues

Not everything is working as it should as multi-platform support is still being developed. This is the list of known issues:

• IntelliJ IDEA support using stable plug-ins is broken. The experience should be better with an EAP or development build, and using the associated Gradle plug-in and standard library from the Kotlin development repository:

  • You have to build and run the examples using the Gradle runner by enabling the following setting: Settings › Build, Execution, Deployment › Build Tools › Gradle › Runner › Delegate IDE build/run actions to gradle), or use the command line. To run the Java app:

      ./gradlew :jvm-app:run
    

    Or to run the JavaScript app:

      ./gradlew :js-app:runDceKotlinJs
    

    And open js-app/JsApp.html. The JavaScript has been mapped to the sources of the Kotlin standard library and module js, so you can set breakpoints in Kotlin code. Note that for some reason, the source maps are not available if you open the browser from within IntelliJ. Copy the file path of jsApp.html and paste that in the address bar of your browser.

    If you want to use the minified JavaScript run:

      ./gradlew :js-app:minifyJs
    

    And open js-app/JsApp-minified.html.

kotlin-multiplatform-recipes's Issues

Emphasize build instructions

Kotlin: Modifier 'impl' is only applicable to members that are initially declared in platform-independent code

Took me few times to read README.md to find the way to make build pass.

Test dependencies delegation

For example I have a project with modules:

• jvm(jvm platform), expectedBy project(':common')
• js(js platform), expectedBy project(':common')
• common(common platform), compile project(':util')
• util(common platform)

Then I want to add tests to util module, but the tests don't appear when i run :js:test. So i want to delegate tests. Thanks.

Add API docs and generation of HTML files

The Kotlin API documentation has very nice drop-down menus to select the platform and the API version. This project should show how you can generate the same for your own project. Add API docs to the types, properties and functions, and generate HTML for the API docs in the build.

Add JavaScript deadcode elimination tool

http://kotlinlang.org/docs/reference/javascript-dce.html

Check JavaScript tests can be run in IntelliJ IDEA

https://discuss.kotlinlang.org/t/multi-platform-project-javascript-unittest/6047/3

Wrong path for "Delegate IDE build/run actions to gradle"

In your list of Current Issues the path to Delegate IDE build/run actions to gradle is wrong.
It might have changed recently but in 2018.2.4 its in Build, Execution, Deployment >> Build Tools >> Gradle >> Runner

Add support for source maps of DCE

Source map rewriting is planned for the DCE tool. Adjust the build if needed when it has been implemented. See: https://youtrack.jetbrains.com/oauth?state=%2Fissue%2FKT-19821

Make use of improved JavaScript unit test support of 1.1.4

https://discuss.kotlinlang.org/t/unit-testing-in-kotlin-js/3943

Stick with QUnit, or create examples for all 7 (QUnit, Jasmine, Mocha, Jest, Karma, frontend-plugin, and Tape) test frameworks?

Add creation of source maps for JavaScript

https://www.html5rocks.com/en/tutorials/developertools/sourcemaps/

Create a branch for 1.2 beta, and document obsolete syntax in master branch

The syntax for multi-platform code has been changed in 1.2. Instead of header and impl, expect is used: http://kotlinlang.org/docs/reference/multiplatform.html

Create a branch for 1.2, and migrate the code.

Also add a clear warning to the documentation that the code that compiles on the current stable will no longer work from 1.2.

Add JavaScript minification

Kotlin/Native multi platform projects

From v0.6 Kotlin/Native supports multi platform projects which can be used for iOS application development. Is Kotlin/Native multi platform project support included in the scope of this project?

Create common library module (and implementations) that can be used by other (common) modules

The questions asked in #9 is valid, and the project should show how to do this properly. Create a common library, and show how this must be used in another common module, the JavaScript module and the JVM module. Also provide tests for the library module.