Add a CLI check that all the tuono versions in the projects are aligned

[marcalexiei]

Within a tuono app, there are plenty of reference to the tuono:

• the tuono CLI
• the tuono crate in Cargo.toml
• the tuono package in package.json

In order to prevent wrong mismatch between packages/CLI versions, we could add warning on tuono build and tuono dev command to highlight such a mismatch.

Additional context

• ci(docs): use tuono 0.17.3 in docs workflows #404

[jacobhq]

Can I look into this one?

[marcalexiei]

Yes,
before starting your work I would like to add a consideration:

we could add warning on tuono build and tuono dev command to highlight such a mismatch.

The warning is not blocking,
however to avoid version mismatch in CI environment (like #404)
an error would be more appropriate IMHO since it will cause the CI to fail.

Solution 1

• Add the warning to tuono dev and tuono lint
• Add a new command tuono check (?) that performs preflight checks.
  (At the current status only version consistency will be checked)

Solution 2

Add --check-version CLI argument on tuono dev and tuono build
If set to version mismatch throws an error, otherwise it logs a warning.

Solution 3

Starting setup a check (?) config option.
The first available option inside check will be versionMismatch (?)
If set to true version mismatch throws an error, otherwise it logs a warning.

I would consider to set this option to true by default.

// tuono.config.ts
import type { TuonoConfig } from 'tuono/config'

const config: TuonoConfig = {
  // ...
  check: {
    versionMismatch: true,
  }
}

export default config

Additional features related to this approach:

• add --no-checks on tuono dev and tuono build to avoid / override config checks
• add new tuono check which will just perform the check without running additional commands

---

I personally like solution 3 because gives us more space for additional checks in the future.

Let me know what do you think about this!

[Valerioageno]

Hey guys! I'd descope this task since next in line for development for the CLI are:

• Better error handling when tuono dev | tuono build is run in a non-tuono directory #393
  (just to define the prompt to show back to the user)
• [Feature request]: tuono dev/tuono build seems kind of slow #285
  (requires to be defined the CLI UI - open for suggestions)

[marcalexiei]

I moved this issue and all the relevant content inside a "Add a CLI check that all the tuono versions in the projects are aligned" draft item of V1 project

[jacobhq]

I think we should add some kind of remedy for this, especially since old CLI versions don't work in new tuono projects.

Demo repro (from 'apps/documentation`):

cargo install --version 0.17.5 tuono
tuono dev

This gives an error (docs currently on 0.17.6)

error[E0599]: no method named `start` found for opaque type `impl Future<Output = tuono_lib::Server>` in the current scope
  --> .tuono/main.rs:27:32
   |
27 |     Server::init(router, MODE).start().await
   |                                ^^^^^ method not found in `impl Future<Output = Server>`
   |
help: consider `await`ing on the `Future` and calling the method on its `Output`
   |
27 |     Server::init(router, MODE).await.start().await
   |                                ++++++

For more information about this error, try `rustc --explain E0599`.
error: could not compile `tuono` (bin "tuono") due to 1 previous error

Maybe we should do this after we've finished writing the rest of the docs?

[Valerioageno]

Yeah, when there are breaking changes in the CLI/server contract, it is very easy that a version mismatch breaks the build.
Thanks for raising! I'm refactoring the prioritization framework, but the task is already in the backlog!