Skip to content

Latest commit

 

History

History
169 lines (125 loc) · 5.56 KB

README.md

File metadata and controls

169 lines (125 loc) · 5.56 KB
Raw

patch plugin

fastlane Plugin Badge Gem Downloads License CircleCI

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-patch, add it to your project by running:

fastlane add_plugin patch

About patch

Apply and revert pattern-based patches to any text file.

This is a very preliminary plugin to apply and revert patches to text files. One of the main intended use cases for this plugin is source-code modification, e.g. when automatically integrating an SDK.

Please provide any feedback via issues in this repo.

patch action

patch(
  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
  regexp: %r{^\s*</application>},
  mode: :prepend,
  text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n"
)

This action matches one or all occurrences of a specified regular expression and modifies the file contents based on the optional :mode parameter. By default, the action appends the specified text to the pattern match. It can also prepend the text or replace the pattern match with the text. Use an optional :global parameter to apply the patch to all instances of the regular expression.

The regexp, text, mode and global options may be specified in a YAML file to define a patch, e.g.:

patch.yaml:

regexp: '^\s*</application>'
mode: prepend
text: "        <meta-data android:name='foo' android:value='bar' />\n"
global: false

Fastfile:

patch(
  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
  patch: "patch.yaml"
)

Capture groups

Capture groups may be used within the text argument in any mode. Note that this works best without interpolation (single quotes or %q). If you use double quotes, the backslash must be escaped, e.g. text: "\\1\"MyOtherpod\"".

patch(
  files: "MyPod.podspec",
  regexp: /(s\.name\s*=\s*)"MyPod"/,
  text: '\1"MyOtherPod"',
  mode: :replace
)

Patches in :append mode using capture groups in the text argument may be reverted. This is not currently supported in :prepend mode.

Revert patches

Revert patches by passing the optional :revert parameter:

patch(
  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
  regexp: %r{^\s*</application>},
  mode: :prepend,
  text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n",
  revert: true
)
patch(
  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
  patch: "patch.yaml"
  revert: true
)

Patches using the :replace mode cannot be reverted.

Options

key description type optional default value
:files Absolute or relative path(s) to one or more files to patch Array or String no
:regexp A regular expression to match Regexp yes
:text Text to append to the match String yes
:global If true, patch all occurrences of the pattern Boolean yes false
:mode :append, :prepend or :replace Symbol yes :append
:offset Offset from which to start matching Integer yes 0
:patch A YAML file specifying patch data String yes
:revert Set to true to revert the specified patch rather than apply it Boolean yes false

The :regexp and :text options must be set either in a patch file specified using the :patch argument or via arguments in the Fastfile.

Note: The apply_patch and revert_patch actions have been deprecated in favor of a single patch action with an optional :revert parameter.

Example

Check out the example Fastfile to see how to use this plugin. Try it by cloning the repo, and running fastlane install_plugins.

The examples folder contains an empty Android project called PatchTestAndroid. There is an example patch at the repo root in patch.yaml that will add a meta-data key to the end of the application element in the Android project's manifest. The Fastfile includes two lanes: apply and revert.

Apply the patch to examples/PatchTestAndroid/app/src/main/AndroidManifest.xml:

fastlane apply

Revert the patch:

fastlane revert

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.