-
Notifications
You must be signed in to change notification settings - Fork 2
/
PaketPluginExtension.groovy
199 lines (175 loc) · 5.06 KB
/
PaketPluginExtension.groovy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
* Copyright 2017 Wooga GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package wooga.gradle.paket.base
import wooga.gradle.paket.base.utils.PaketDependencies
/**
* Base extension point for paket plugins.
*/
interface PaketPluginExtension {
/**
* Returns the {@File} path to the paket directory.
* <p>
* The {@code .paket} is the place the plugin or the project stores the {@code paket.exe}
* and {@code paket.bootstrapper.exe} executables.
*
* @return the path to {@code paket} directory.
* @default {@code projectDir/.paket}
*/
File getPaketDirectory()
/**
* Sets the path to the paket directory.
* <p>
* The value can be anything that can be converted into a File/file path string.
* @param directory the path to the paket directory
*/
void setPaketDirectory(Object directory)
/**
* Sets the path to the paket directory.
* <p>
* The value can be anything that can be converted into a File/file path string.
* @param directory the path to the paket directory
* @return this
*/
PaketPluginExtension paketDirectory(Object directory)
/**
* Returns the paket version to use.
* <p>
* This version will be used to load a specific version of the paket binary.
* When empty, the bootstrapper will load the latest version available.
*
* @return the version for paket.
* @default ""
*/
String getVersion()
/**
* Sets version for the paket binary.
* <p>
* There is no version validation implemented.
* The behavior is undefined for invalid input.
*
* @param version the version string
*/
void setVersion(Object version)
/**
* Sets version for the paket binary.
* <p>
* There is no version validation implemented.
* The behavior is undefined for invalid input.
*
* @param version the version string
* @returns this
*/
PaketPluginExtension version(Object version)
/**
* Returns the file path to mono executable as String.
* <p>
* This value won't be used on windows.
*
* @return the path to mono executable
* @default "mono"
*/
String getMonoExecutable()
/**
* Sets the path to mono executable
*
* @param path to mono
*/
void setMonoExecutable(Object path)
/**
* Sets the path to mono executable
*
* @param path to mono
* @returns this
*/
PaketPluginExtension monoExecutable(Object path)
/**
* Returns the path to the paket tool executable
*
* @return executable path
*/
File getExecutable()
/**
* Sets the paket executable path
*
* @param executable
*/
void setExecutable(Object executable)
/**
* Sets the paket executable path
*
* @param executable
* @returns this
*/
PaketPluginExtension executable(Object executable)
/**
* Returns the path to the bootstrapper executable
*
* @return path to bootstrapper executable
*/
File getBootstrapperExecutable()
/**
* Sets the boostrapper executable path
*
* @param fileName
*/
void setBootstrapperExecutable(Object fileName)
/**
* Sets the boostrapper executable path
*
* @param fileName
* @return this
*/
PaketPluginExtension bootstrapperExecutable(Object fileName)
/**
* Returns an URL string to the bootstrapper download location
*
* @return the bootstrappere download URL
*/
String getPaketBootstrapperUrl()
/**
* Sets the bootstrapper download URL
*
* @param url
*/
void setPaketBootstrapperUrl(Object url)
/**
* Sets the bootstrapper download URL
*
* @param url
* @returns this
*/
PaketPluginExtension paketBootstrapperUrl(Object url)
/**
* Returns the {@link File} path to the {@code paket.dependencies} file within the project.
*
* @return path to {@code paket.dependencies} file.
*/
File getPaketDependenciesFile()
/**
* Returns the {@link File} path to the {@code paket.lock} file in the project.
*
* @return a {@link File} path to the {@code paket.lock} file in the project.
*/
File getPaketLockFile()
/**
* Returns the content of {@code paket.dependencies} parsed as {@link PaketDependencies} object.
*
* @return the parsed {@code paket.dependencies} file
* @see PaketDependencies
*/
PaketDependencies getPaketDependencies()
}