Module: OS::Mac::CLT Private

Extended by:
Utils::Output::Mixin
Defined in:
os/mac/xcode.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper module for querying macOS Command Line Tools information.

Constant Summary collapse

EXECUTABLE_PKG_ID =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

The original Mavericks CLT package ID

"com.apple.pkg.CLTools_Executables"
MAVERICKS_NEW_PKG_ID =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

obsolete

"com.apple.pkg.CLTools_Base"
PKG_PATH =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"/Library/Developer/CommandLineTools"

Class Method Summary collapse

Methods included from Utils::Output::Mixin

odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled

Class Method Details

.below_minimum_version? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


366
367
368
369
370
 
# File 'os/mac/xcode.rb', line 366

def self.below_minimum_version?
  return false unless installed?

  version < minimum_version
end

.detect_clang_version ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



381
382
383
384
 
# File 'os/mac/xcode.rb', line 381

def self.detect_clang_version
  version_output = Utils.popen_read("#{PKG_PATH}/usr/bin/clang", "--version")
  version_output[/clang-(\d+(\.\d+)+)/, 1]
end

.detect_version ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



409
410
411
412
413
414
415
416
417
418
419
 
# File 'os/mac/xcode.rb', line 409

def self.detect_version
  version = T.let(nil, T.nilable(String))
  [EXECUTABLE_PKG_ID, MAVERICKS_NEW_PKG_ID].each do |id|
    next unless File.exist?("#{PKG_PATH}/usr/bin/clang")

    version = MacOS.pkgutil_info(id)[/version: (.+)$/, 1]
    return version if version
  end

  detect_version_from_clang_version
end

.detect_version_from_clang_version ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



387
388
389
390
391
392
 
# File 'os/mac/xcode.rb', line 387

def self.detect_version_from_clang_version
  clang_version = detect_clang_version
  return if clang_version.nil?

  MacOS::Xcode.detect_version_from_clang_version(Version.new(clang_version))
end

.installation_instructions ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'os/mac/xcode.rb', line 280

def self.installation_instructions
  if OS::Mac.version.prerelease?
    <<~EOS
      Install the Command Line Tools for Xcode #{minimum_version.split(".").first} from:
        #{Formatter.url(MacOS::Xcode::APPLE_DEVELOPER_DOWNLOAD_URL)}
    EOS
  else
    <<~EOS
      Install the Command Line Tools:
        xcode-select --install
    EOS
  end
end

.installation_then_reinstall_instructions ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



325
326
327
328
329
330
 
# File 'os/mac/xcode.rb', line 325

def self.installation_then_reinstall_instructions
  <<~EOS
    #{installation_instructions}
    #{reinstall_instructions}
  EOS
end

.installed? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns true even if outdated tools are installed.

Returns:

  • (Boolean) 


254
255
256
 
# File 'os/mac/xcode.rb', line 254

def self.installed?
  !version.null?
end

.latest_clang_version ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Bump these when the new version is distributed through Software Update and our CI systems have been updated.

Returns:



335
336
337
338
339
340
341
342
343
344
345
 
# File 'os/mac/xcode.rb', line 335

def self.latest_clang_version
  case MacOS.version
  when "26" then "1700.3.19.1"
  when "15" then "1700.0.13.5"
  when "14" then "1600.0.26.6"
  when "13" then "1500.1.0.2.5"
  when "12"    then "1400.0.29.202"
  when "11"    then "1300.0.29.30"
  else              "1200.0.32.29"
  end
end

.minimum_version ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Bump these if things are badly broken (e.g. no SDK for this macOS) without this. Generally this will be the first stable CLT release on that macOS version.

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'os/mac/xcode.rb', line 351

def self.minimum_version
  macos = MacOS.version
  case macos
  when "15" then "16.0.0"
  when "14" then "15.0.0"
  when "13" then "14.0.0"
  when "12" then "13.0.0"
  when "11" then "12.5.0"
  when "10.15" then "11.0.0"
  else
    "#{macos}.0.0"
  end
end

.outdated? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


373
374
375
376
377
378
 
# File 'os/mac/xcode.rb', line 373

def self.outdated?
  clang_version = detect_clang_version
  return false unless clang_version

  ::Version.new(clang_version) < latest_clang_version
end

.reinstall_instructions(reason: "resolve your issues") ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • reason (String) (defaults to: "resolve your issues")

Returns:



295
296
297
298
299
300
301
302
303
304
305
 
# File 'os/mac/xcode.rb', line 295

def self.reinstall_instructions(reason: "resolve your issues")
  <<~EOS
    If that doesn't #{reason}, run:
      sudo rm -rf /Library/Developer/CommandLineTools
      sudo xcode-select --install

    Alternatively, manually download them from:
      #{Formatter.url(MacOS::Xcode::APPLE_DEVELOPER_DOWNLOAD_URL)}.
    You should download the Command Line Tools for Xcode #{MacOS::Xcode.latest_version}.
  EOS
end

.sdk(version = nil) ⇒ SDK?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



270
271
272
 
# File 'os/mac/xcode.rb', line 270

def self.sdk(version = nil)
  sdk_locator.sdk_if_applicable(version)
end

.sdk_locator ⇒ CLTSDKLocator

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



265
266
267
 
# File 'os/mac/xcode.rb', line 265

def self.sdk_locator
  @sdk_locator ||= T.let(CLTSDKLocator.new, T.nilable(OS::Mac::CLTSDKLocator))
end

.sdk_path(version = nil) ⇒ Pathname?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



275
276
277
 
# File 'os/mac/xcode.rb', line 275

def self.sdk_path(version = nil)
  sdk(version)&.path
end

.separate_header_package? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


259
260
261
262
 
# File 'os/mac/xcode.rb', line 259

def self.separate_header_package?
  odeprecated "MacOS::CLT.separate_header_package?"
  true
end

.update_instructions ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'os/mac/xcode.rb', line 308

def self.update_instructions
  return installation_instructions if OS::Mac.version.prerelease?

  software_update_location = if MacOS.version >= "13"
    "System Settings"
  else
    "System Preferences"
  end

  <<~EOS
    Update them from Software Update in #{software_update_location}.

    #{reinstall_instructions(reason: "show you any updates")}
  EOS
end

.version ⇒ ::Version

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Version string (a pretty long one) of the CLT package. Note that the different ways of installing the CLTs lead to different version numbers.

Returns:



400
401
402
403
404
405
406
 
# File 'os/mac/xcode.rb', line 400

def self.version
  if @version ||= T.let(detect_version, T.nilable(String))
    ::Version.new @version
  else
    ::Version::NULL
  end
end