Is there a verbose environment variable?

[rakuyoMo]

Is there an environment variable, such as TUIST_VERBOSE. When its value is 1, all tuist-related commands will automatically add --verbose.

Just like MISE_VERBOSE.

If not, then I really hope to add this environment variable, which is very useful in the DEBUG mode of CI and can simplify our pipeline.

[pepicrft]

Hey @rakuyoMo,
There is, you can invoke every command with --verbose, and it'll have the same effect as using MISE_VERBOSE.

[rakuyoMo]

@pepicrft I would like to use MISE_VERBOSE to illustrate its convenience

Below is the contents of a Rakefile, which shows the contents when MISE_VERBOSE is not used.

module Tools
  def ci_debug_mode?
    ENV['RUNNER_DEBUG'] == '1' || ENV['ACTIONS_RUNNER_DEBUG'] == 'true'
  end

  def verbose_param
    ci_debug_mode? ? '--verbose' : ''
  end

  def mise_exec_prefix
    "mise #{verbose_param} exec --"
  end

  def tuist_prefix
    "tuist #{verbose_param}"
  end
end

namespace :tuist do
  include Tools

  desc 'Run Tuist Install'
  task :install do
    sh "#{mise_exec_prefix} #{tuist_prefix} install"
  end

  desc 'Run Tuist Install without Mise'
  task :install_without_mise do
    sh "#{tuist_prefix} install"
  end

  desc 'Run Tuist Generate'
  task :generate do
    sh "#{mise_exec_prefix} #{tuist_prefix} generate"
  end

  desc 'Run Tuist Generate without Mise'
  task :generate_without_mise do
    sh "#{tuist_prefix} generate"
  end
end

You can see that I need to use tuist_prefix instead of tuist command in every command. In fact, we will encapsulate many mise and tuist tools, far more than the ones listed above. Reusing these packages doesn't look that elegant, it's a bit counterintuitive. And we need to check each developer's submission to see if they use tuist_prefix instead of tuist.

Now try another way, let's use MISE_VERBOSE in CI.

...

jobs:
  build:
    name: Xcode ${{ matrix.xcode }} on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    ...
    steps:
      - name: Set up debug
        if: ${{ runner.debug == '1' }}
        run: echo "MISE_VERBOSE=1" >> "$GITHUB_ENV"
      - uses: actions/checkout@v4
      - uses: jdx/mise-action@v2
      - uses: maxim-lobanov/setup-xcode@v1
        with:
          xcode-version: ${{ matrix.xcode }}
      ...

The above is part of .github/workflows/build.yaml.

By setting MISE_VERBOSE in debug mode, we can make all mise commands output detailed logs, including those not in Rakefile. Developers can write commands in Rakefile just like commands and forget about the troublesome --verbose parameter.

Now let us assume that MISE_VERBOSE also exists, then Rakefile will be simplified to this:

namespace :tuist do
  desc 'Run Tuist Install'
  task :install do
    sh "mise exec -- tuist install"
  end

  desc 'Run Tuist Install without Mise'
  task :install_without_mise do
    sh "tuist install"
  end

  desc 'Run Tuist Generate'
  task :generate do
    sh "mise exec -- tuist generate"
  end

  desc 'Run Tuist Generate without Mise'
  task :generate_without_mise do
    sh "tuist generate"
  end
end

---

I hope the development team will reconsider adding TUIST_VERBOSE, it's really useful.

[fortmarek]

@rakuyoMo There's actually TUIST_CONFIG_VERBOSE that you can use. It's defined here:

tuist/Sources/TuistSupport/Constants.swift

Line 61 in 2d71fef

public static let verbose = "TUIST_CONFIG_VERBOSE"

It's not meant to be used by end users but it should work. If it does work for you, I think we can document it and no longer mark it as for dev purposes only.

[rakuyoMo]

It's exactly what I want, and I've tried it, and it works.