@@ -33,7 +33,19 @@ def self.return_value
33
33
end
34
34
35
35
def self . details
36
- 'Checks that the strings to be localised are updated from the libs into the main application file'
36
+ <<~DETAILS
37
+ Checks that the strings to be localised are updated from the libs into the main application file
38
+
39
+ For the `lib_strings_path` ConfigItem, it is an array of Hashes, each describing a library and
40
+ containing these specific keys:
41
+ - `:library`: The human readable name of the library, used to display in console messages
42
+ - `:strings_path`: The path to the strings.xml file of the library to merge into the main one
43
+ - `:exclusions`: An array of strings keys to exclude during merge. Any of those keys from the
44
+ library's `strings.xml` will be skipped and won't be merged into the main one.
45
+ - `:source_id`: An optional `String` which will be added as the `a8c-src-lib` XML attribute
46
+ to strings coming from this library, to help identify their source in the merged file.
47
+ - `:add_ignore_attr`: If set to `true`, will add `tools:ignore="UnusedResources"` to merged strings.
48
+ DETAILS
37
49
end
38
50
39
51
def self . available_options
@@ -44,7 +56,7 @@ def self.available_options
44
56
type : String ) ,
45
57
FastlaneCore ::ConfigItem . new ( key : :libs_strings_path ,
46
58
env_name : 'CHECK_LIBS_STRINGS_PATH' ,
47
- description : 'The list of libs to merge' ,
59
+ description : 'The list of libs to merge. This should be an array of Hashes. ' ,
48
60
optional : false ,
49
61
type : Array ) ,
50
62
FastlaneCore ::ConfigItem . new ( key : :diff_url ,
0 commit comments