Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kijuky/sbt-yamory
yamory for sbt.
https://github.com/kijuky/sbt-yamory
sbt-plugin scala
Last synced: 3 days ago
JSON representation
yamory for sbt.
- Host: GitHub
- URL: https://github.com/kijuky/sbt-yamory
- Owner: kijuky
- License: apache-2.0
- Created: 2021-06-05T13:08:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T01:17:12.000Z (2 months ago)
- Last Synced: 2024-11-08T14:13:14.364Z (about 2 months ago)
- Topics: sbt-plugin, scala
- Language: Scala
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sbt-yamory
[yamory](https://yamory.io/) for sbt.
## Usage
This plugin requires `bash`, and sbt 1.6+
plugins.sbt:
```sbt
addSbtPlugin("io.github.kijuky" % "sbt-yamory" % version)
```
### for Scala project
Set environment variable: `PROJECT_GROUP_KEY` and `YAMORY_API_KEY`.
build.sbt:
```sbt
yamorySbtScriptUrl := "https://yamory/script/..."
```
and run
```shell
sbt yamory
```
then scan results are recorded in yamory.
You should set `yamorySbtScriptUrl`. if it is empty, the `yamory` task do nothing.
### for [Scala.js](https://www.scala-js.org/) project
[Since yamory supports the npm project](https://yamory.io/docs/command-scan-npm/),
you can scan [the node packages](https://www.npmjs.com/) used by your scala.js project.
Set environment variable: `PROJECT_GROUP_KEY` and `YAMORY_API_KEY`.
build.sbt:
```sbt
yamoryNpmScriptUrl := "https://yamory/script/..."
```
- Share `yamoryProjectGroupKey` and `yamoryApiKey`.
- If you are using [scalajs-bundler](https://github.com/scalacenter/scalajs-bundler)
and you are using [`npmDependencies`](https://scalacenter.github.io/scalajs-bundler/reference.html#npm-dependencies),
you need to add the following settings:
```sbt
yamoryNpmManifest := "./target/scala-2.12/scalajs-bundler/main/package.json"
```
If you omit this setting, `./package.json` will be referenced.
and run
```shell
sbt yamoryNpm
```
You should set `yamoryNpmScriptUrl`. if it is empty, the `yamoryNpm` task do nothing.
- For [a multi-project build](https://www.scala-sbt.org/1.x/docs/Multi-Project.html),
specify the project and execute:
```shell
sbt client/yamoryNpm
```
then scan results are recorded in yamory.
## for Developers
### Testing
Run `test` for regular unit tests.
Run `scripted` for [sbt script tests](http://www.scala-sbt.org/1.x/docs/Testing-sbt-plugins.html).
### Publishing
1. push tag `vX.Y.Z`