socketry / async

An awesome asynchronous event-driven reactor for Ruby.
MIT License
2.04k stars 85 forks source link

Update readme.md - fixing a typo #313

Closed peychinov closed 3 months ago

peychinov commented 3 months ago

Just a typo fix.

ioquatix commented 3 months ago

Thanks!

To fix this properly, please fix the source document: https://github.com/socketry/async/tree/main/guides/getting-started

Then run:

bundle exec bake utopia:project:readme:update

Then submit both files in this PR. Thanks!

peychinov commented 3 months ago

Thanks!

To fix this properly, please fix the source document: https://github.com/socketry/async/tree/main/guides/getting-started

Then run:

bundle exec bake utopia:project:readme:update

Then submit both files in this PR. Thanks!

Thank you for answering!

I just fixed the other file (in a fixup commit) but when I tried to run the command you suggested I got this error:

dimitar@async fix-typo-in-readme $ bundle exec bake utopia:project:readme:update
  0.0s    error: Bake::Command [ec=0x4b0] [pid=62141] [2024-04-05 11:06:53 +0300]
               |   ArgumentError: Could not find recipe for utopia:project:readme:update!
               |   → /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bake-0.19.0/lib/bake/context.rb:108 in `call'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bake-0.19.0/lib/bake/command/call.rb:33 in `call'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bake-0.19.0/lib/bake/command/top.rb:61 in `call'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/samovar-2.3.0/lib/samovar/command.rb:21 in `call'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bake-0.19.0/lib/bake/command.rb:12 in `call'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bake-0.19.0/bin/bake:29 in `<top (required)>'
               |     /Users/dimitar/.rbenv/versions/3.2.2/bin/bake:25 in `load'
               |     /Users/dimitar/.rbenv/versions/3.2.2/bin/bake:25 in `<top (required)>'
               |     /Users/dimitar/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.5.6/lib/bundler/cli/exec.rb:58 in `load'

I tried to figure it out on my own - I googled it, I checked your gems https://github.com/ioquatix/bake and https://socketry.github.io/utopia-project/guides/getting-started/index.html - but I could not find a solution.

The only hint I got is that the command from utopia-project's getting-started fails with the same error - so I assume it's something more generic (like a setup step) that I'm missing, it's not the command itself:

dimitar@async fix-typo-in-readme $ bake utopia:project:serve
  0.0s    error: Bake::Command [ec=0x5a0] [pid=63658] [2024-04-05 11:13:38 +0300]
               |   ArgumentError: Could not find recipe for utopia:project:serve!

PS: I know this PR is just about a typo and you can do the fix far more quickly yourself. But maybe this error now with the bake recipe is worth a short hint/explanation so that next time somebody hits it Google would return something useful. :)

olleolleolle commented 3 months ago

@peychinov Perhaps, group :maintenance, optional: true do the gems that have these recipes, perhaps they're not included in your current installation?

So, to get those:

bundle config with maintenance
bundle

On my machine, I need to install cmake, I did brew install cmake.

After that,

bundle show utopia-project
ioquatix commented 3 months ago

@olleolleolle is correct - in the past, I've had problems installing gems which I use for release management, documentation, and general maintenance in CI infrastructure, so I decided to split it out into an optional group. Sorry it caused confusion and thanks for giving it a go!