roc-lang / roc-lang/examples

example suggestion: avoiding `{} <-` `|> await` boilerplate

Open
#85 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

example suggestion
Dominant language
Shell
Stars
46
Forks
19
Avg merge
13h 38m
Merged PRs (30d)
19

Description

We should make an example for this once we figure it out ourselves :p

Example of a problematic case:

{} <- log "Extracting current rust version from rust-toolchain.toml..." |> await
{ stable: currentStable, nightly: currentNightly } <- getCurrentVersionsFromToml |> await
{} <- log "Found versions:\n\t- stable: \(versionToStr currentStable)\n\t- nightly with date: \(dateToStr currentNightly)" |> await
# TODO Task.map to avoid repeated `{} <-`?
{} <- log "Searching for nightly matching stable-\(newRustVersion)..." |> await

newNightly <-
    findMatchingNigthly (versionFromStr newRustVersion) currentNightly
    |> await

{} <- log "New nightly: nightly-\(dateToStr newNightly)" |> await

TODO can we avoid boiler plate of `{} <-` and `await` here?
{} <-
    Path.fromStr "rust-toolchain.toml"
    |> updateToml newRustVersion
    |> await

{} <-
    Path.fromStr "examples/platform-switching/rust-platform/rust-toolchain.toml"
    |> updateToml newRustVersion
    |> await

{} <-
    Path.fromStr "Earthfile"
    |> updateEarthFile newRustVersion
    |> await

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repeated pipeline snippets in the issue, including rust-toolchain.toml, examples/platform-switching/rust-platform/rust-toolchain.toml, and Earthfile. First determine whether the proposed boilerplate reduction is supported by the surrounding example code or requires an unresolved language change. Done means the intended approach is established and represented by a clear example covering the shown update and logging cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.