Settings Gradle Task Configuration (settings_gradle)
Modify settings.gradle file
The settings_gradle task is designed to facilitate modifications to the settings.gradle files in Android projects. It is the main entry file of
the android application. This task provides the flexibility to make changes to different sections of the settings.gradle file.
Task Properties
| Property | Type | Description |
|---|---|---|
| task | "settings_gradle", required | Specifies the task type, which should be set to "settings_gradle" for this task. |
| name | string | An optional name for the task. If provided, the task state will be saved as a variable. Visit Task and Action States page to learn more. |
| label | string | An optional label or description for the task. |
| when | object | Visit Conditional Tasks and Actions page to learn how to execute task conditionally. |
| actions | Array<Action>, required | An array of action items that define the modifications to be made in the file. Each action item contains the following fields: |
Action Properties
Common properties
| Property | Type | Description |
|---|---|---|
| name | string | An optional name for the task. If provided, the task state will be saved as a variable. Visit Task and Action States page to learn more. |
| when | object | Visit Conditional Tasks and Actions page to learn how to execute action conditionally. |
Context reduction properties
| Property | Type | Description |
|---|---|---|
| before | string or {regex: string, flags: string} | Text or code that is used to specify a point within the context where text should be inserted before. It can be a string or an object with a regex and flags field to perform a regex-based search. |
| after | string or {regex: string, flags: string} | Text or code that is used to specify a point within the context where text should be inserted after. It can be a string or an object with a regex and flags field to perform a regex-based search. |
| search | string or {regex: string, flags: string} | A string or object (with regex and flags) that narrows the context to a specific text within the method or file. |
Context modification properties
| Property | Type | Description |
|---|---|---|
| prepend | string or {file: string} | Text or code to prepend at the beginning of the specified context. It can be a string or an object with a file field that points to a file containing the code to prepend. |
| append | string or {file: string} | Text or code to append at the end of the specified context. It can be a string or an object with a file field that points to a file containing the code to append. |
| replace | string or {file: string} | Text or code to replace the entire specified context. It can be a string or an object with a file field that points to a file containing the code to replace. |
Other properties
| Property | Type | Description |
|---|---|---|
| exact | boolean | A boolean flag that modifies the whitespace and new line management. |
| strict | boolean | Specifies the behavior of the before and after fields. If set to true, the task will throw an error if the text in the before or after field is not found in the context, otherwise, it will ignore the field. |
| ifNotPresent | string | Indicates that the task should only be executed if the specified text or code is not present within the specified context. |
| comment | string | An optional comment to add before the inserted code or text. The comment is purely informational and does not affect the code's functionality. |
Example
task: settings_gradle
label: "Including code push"
actions:
- append: |-
include ':app', ':react-native-code-push'
project(':react-native-code-push').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-code-push/android/app')
In this example, the settings_gradle task adds an import to the file.