https://github.com/laughedelic/scalajs-probot
🤖Scala.js facades for the Probot framework
https://github.com/laughedelic/scalajs-probot
facades github-apps github-bot probot scala scala-js scalajs scalajs-facade
Last synced: 3 months ago
JSON representation
🤖Scala.js facades for the Probot framework
- Host: GitHub
- URL: https://github.com/laughedelic/scalajs-probot
- Owner: laughedelic
- License: mpl-2.0
- Created: 2018-05-08T01:25:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-03T01:06:38.000Z (about 7 years ago)
- Last Synced: 2025-02-28T10:03:17.740Z (4 months ago)
- Topics: facades, github-apps, github-bot, probot, scala, scala-js, scalajs, scalajs-facade
- Language: Scala
- Homepage: https://probot.github.io
- Size: 40 KB
- Stars: 7
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# [Scala.js] facades for the [Probot] framework :robot:
[
](https://www.npmjs.com/package/probot/v/7.0.0-typescript.4)
[
](https://www.scala-js.org)
[](https://travis-ci.com/laughedelic/scalajs-probot)
[](https://github.com/laughedelic/scalajs-probot/releases/latest)
[](https://www.tldrlegal.com/l/mpl-2.0)
[](https://gitter.im/laughedelic/scalajs-probot)
This project contains Scala.js facades for the [Probot] framework used to build GitHub Apps on Node.js.
## 🚧 WORK IN PROGRESS 🚧
_This project is in active development, there are no published releases yet. Things may break without a warning, so don't rely on it._
If you want to experiment with it and write a GitHub bot in Scala.js, don't hesitate to write to the [Gitter chat](https://gitter.im/laughedelic/scalajs-probot) and ask any questions. And if you're looking for ideas, check out the dedicated [probot/ideas](https://github.com/probot/ideas) repo.
## Usage
First of all you should head to the [Probot docs](https://probot.github.io/docs/) and read at least the Getting Started part. It explains the basics very well and gives you a general understanding of how this framework functions.
For interacting with the GitHub API this library depends on the Scala.js facades for the Octokit library: [scalajs-octokit](https://github.com/laughedelic/scalajs-octokit).
For the usage example refer to the [scalafmt-probot](https://github.com/laughedelic/scalafmt-probot) project. The project setup will be simplified in the future.
### Installation
🛠Check installation instructions later, when there is a published release...
1. Add Probot dependency to your project. It's important that the version of the underlying JS library matches the one this facade is built for.
* If it's a Node.js project where you manage dependencies with npm, run
```shell
npm install probot@next --save
```
* If it's a Scala.js project use [scalajs-bundler] and add to your `build.sbt`:
```scala
Compile/npmDependencies += "probot" -> "next"
```
These facades are based on the [TypeScript version of Probot](https://github.com/probot/probot/pull/372) which is not released yet, but is available under the `next` version tag.
2. Add facades dependency to your `build.sbt`:
```scala
resolvers += Resolver.jcenterRepo
libraryDependencies += "laughedelic" %%% "scalajs-probot" % ""
```
(see the latest release version on the badge above)
3. To turn the project into a runnable application add to your `build.sbt`:
```scala
scalaJSUseMainModuleInitializer := true
```
Then in the code implement a `Probot.Plugin` (which is a function `Application => Unit`) and define a `main` method:
```scala
import laughedelic.probot._
object ProbotApp {
def plugin(app: Application): Unit = ???
def main(args: Array[String]): Unit = ProbotApp.run(plugin)
}
```
See the [example](#example) below.
4. (Optionally) for local testing you may want to add a dependency on the smee-client
```scala
Compile/npmDependencies += "smee-client" -> "1.0.1"
```
Then you can run the application with `sbt run` it should work the same as the `npm start` (=`probot run ./lib/index.js`) from the [Probot docs](https://probot.github.io/docs/development/#running-the-app-locally). The only difference is that it ignores any command line args, so I have to set environment variables. You can set them in the `.env` file.
### Example
Here's a translation of the [Hello World example](https://probot.github.io/docs/hello-world/) from the Probot docs to Scala:
```scala
import laughedelic.probot._
import scala.scalajs.concurrent.JSExecutionContext.Implicits.queue
object HelloWorld {
def plugin(app: Application): Unit = {
app.on("issues.opened") { context =>
// Post a comment on every new issue
context.github.issues.createComment(
owner = context.issue().owner,
repo = context.issue().repo,
number = context.issue().number,
body = "Hello World! 👋"
)
}
}
def main(args: Array[String]): Unit = Probot.run(plugin)
}
```
The translation from JavaScript is pretty straightforward. A couple of things to notice:
* In JS all GitHub API parameters are just objects, so it's possible to reuse `context.issue` and write
```javascript
context.github.issues.createComment(
// context.issue appends given object to { owner: ..., repo: ..., number: ... }
context.issue({body: 'Hello World!'})
)
```
In Scala `createComment` method has typed arguments, so we have to pass those values from the context explicitly. I don't think it's too verbose, but if anybody has an idea how to improve it, let me know.
* `{ context => ... }` callback returns a `Future` which is converted to a `js.Promise`, this is why the execution context import is needed.
For a more complex example and the general project setup refer to the [scalafmt-probot](https://github.com/laughedelic/scalafmt-probot) project.
[Scala.js]: https://www.scala-js.org
[Probot]: https://probot.github.io