luciano/coffi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expand the examples of using -J and :jvm-opts in readme

Browse source
This commit is contained in:
Joshua Suskalo 2022-02-03 13:47:45 -06:00
parent cd7761b595
commit 3aa5f17e59
1 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -35,8 +35,23 @@ following JVM arguments to your application.
--add-modules=jdk.incubator.foreign --enable-native-access=ALL-UNNAMED --add-modules=jdk.incubator.foreign --enable-native-access=ALL-UNNAMED
``` ```
JVM arguments can be added to your project with -J in the Clojure CLI arguments, You can specify JVM arguments in a particular invocation of the Clojure CLI with
or in the `:jvm-opts` key of an alias in your `deps.edn` file. the -J flag like so:
``` sh
clj -J--add-modules=jdk.incubator.foreign -J--enable-native-access=ALL-UNNAMED
```
You can also specify them in an alias in your `deps.edn` file under the
`:jvm-opts` key (see the next example) and then invoking the CLI with that alias
using `-M`, `-A`, or `-X`.
``` clojure
{:aliases {:dev {:jvm-opts ["--add-modules=jdk.incubator.foreign" "--enable-native-access=ALL-UNNAMED"]}}}
```
Other build tools should provide similar functionality if you check their
documentation.
Coffi also includes support for the linter clj-kondo. If you use clj-kondo and Coffi also includes support for the linter clj-kondo. If you use clj-kondo and
this library's macros are not linting correctly, you may need to install the this library's macros are not linting correctly, you may need to install the