Class: Xcodeproj::Project::Object::PBXShellScriptBuildPhase

Inherits:

AbstractBuildPhase

• Object
• AbstractObject
• AbstractBuildPhase
• Xcodeproj::Project::Object::PBXShellScriptBuildPhase

Defined in:

lib/xcodeproj/project/object/build_phase.rb

Overview

Note:

This phase can appear multiple times in a target.

A phase responsible of running a shell script (aka ‘Run Script`).

Attributes

• #dependency_file ⇒ String

  The discovered dependency file to use.

• #input_file_list_paths ⇒ Array<String>

  An array of input file list paths of the script.

• #input_paths ⇒ Array<String>

  An array of the paths to pass to the script.

• #name ⇒ String

  The name of the build phase.

• #output_file_list_paths ⇒ Array<String>

  An array of output file list paths of the script.

• #output_paths ⇒ Array<String>

  An array of output paths of the script.

• #shell_path ⇒ String

  The path to the script interpreter.

• #shell_script ⇒ String

  The actual script to perform.

• #show_env_vars_in_log ⇒ String

  Whether or not the ENV variables should be shown in the build log.

Attributes inherited from AbstractBuildPhase

#always_out_of_date, #build_action_mask, #comments, #run_only_for_deployment_postprocessing

Attributes inherited from AbstractObject

#isa, #project, #uuid

Attributes

• #pretty_print ⇒ Hash{String => Hash}

  A hash suitable to display the build phase to the user.

Methods inherited from AbstractBuildPhase

#add_file_reference, #ascii_plist_annotation, #build_file, #clear, #display_name, #file_display_names, #files, #files_references, #include?, #remove_build_file, #remove_file_reference, #sort

Methods inherited from AbstractObject

#<=>, #==, #ascii_plist_annotation, #display_name, #inspect, isa, #nested_object_for_hash, #remove_from_project, #sort, #sort_recursively, #to_ascii_plist, #to_hash

Instance Attribute Details

#dependency_file ⇒ String

Returns the discovered dependency file to use.

Returns:

• (String) —

  the discovered dependency file to use.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 337

attribute :dependency_file, String

#input_file_list_paths ⇒ Array<String>

Returns an array of input file list paths of the script.

Examples:

"$(SRCROOT)/newInputFile.xcfilelist"

Returns:

• (Array<String>) —

  an array of input file list paths of the script.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 302

attribute :input_file_list_paths, Array, []

#input_paths ⇒ Array<String>

Returns an array of the paths to pass to the script.

Examples:

"$(SRCROOT)/myfile"

Returns:

• (Array<String>) —

  an array of the paths to pass to the script.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 295

attribute :input_paths, Array, []

#name ⇒ String

Returns the name of the build phase.

Returns:

• (String) —

  the name of the build phase.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 288

attribute :name, String

#output_file_list_paths ⇒ Array<String>

Returns an array of output file list paths of the script.

Examples:

"$(SRCROOT)/newOutputFile.xcfilelist"

Returns:

• (Array<String>) —

  an array of output file list paths of the script.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 316

attribute :output_file_list_paths, Array, []

#output_paths ⇒ Array<String>

Returns an array of output paths of the script.

Examples:

"$(DERIVED_FILE_DIR)/myfile"

Returns:

• (Array<String>) —

  an array of output paths of the script.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 309

attribute :output_paths, Array, []

#shell_path ⇒ String

Note:

Defaults to ‘/bin/sh`.

Returns the path to the script interpreter.

Returns:

• (String) —

  the path to the script interpreter.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 322

attribute :shell_path, String, '/bin/sh'

#shell_script ⇒ String

Note:

Defaults to a comment string.

Returns the actual script to perform.

Returns:

• (String) —

  the actual script to perform.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 328

attribute :shell_script, String, "# Type a script or drag a script file from your workspace to insert its path.\n"

#show_env_vars_in_log ⇒ String

Returns whether or not the ENV variables should be shown in the build log.

Returns:

• (String) —

  whether or not the ENV variables should be shown in the build log.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 333

attribute :show_env_vars_in_log, String

Instance Method Details

#pretty_print ⇒ Hash{String => Hash}

Returns A hash suitable to display the build phase to the user.

Returns:

• (Hash{String => Hash}) —

  A hash suitable to display the build phase to the user.

# File 'lib/xcodeproj/project/object/build_phase.rb', line 342

def pretty_print
  {
    display_name => {
      'Input File List Paths' => input_file_list_paths || [],
      'Input Paths' => input_paths || [],
      'Output File List Paths' => output_file_list_paths || [],
      'Output Paths' => output_paths || [],
      'Shell Path' => shell_path,
      'Shell Script' => shell_script,
    },
  }
end