es-git 0.3.0-next.127 → 0.3.0-next.129

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +191 -0
  2. package/package.json +11 -11
package/index.d.ts CHANGED
@@ -109,6 +109,148 @@ export interface BranchesFilter {
109
109
  /** Branch type to filter. */
110
110
  type?: BranchType
111
111
  }
112
+ export interface CheckoutOptions {
113
+ /**
114
+ * Indicate that this checkout should perform a dry run by checking for
115
+ * conflicts but not make any actual changes.
116
+ */
117
+ dryRun?: boolean
118
+ /**
119
+ * Take any action necessary to get the working directory to match the
120
+ * target including potentially discarding modified files.
121
+ */
122
+ force?: boolean
123
+ /**
124
+ * Indicate that the checkout should be performed safely, allowing new
125
+ * files to be created but not overwriting existing files or changes.
126
+ *
127
+ * This is the default.
128
+ */
129
+ safe?: boolean
130
+ /**
131
+ * In safe mode, create files that don't exist.
132
+ *
133
+ * Defaults to false.
134
+ */
135
+ recreateMissing?: boolean
136
+ /**
137
+ * In safe mode, apply safe file updates even when there are conflicts
138
+ * instead of canceling the checkout.
139
+ *
140
+ * Defaults to false.
141
+ */
142
+ allowConflicts?: boolean
143
+ /**
144
+ * Remove untracked files from the working dir.
145
+ *
146
+ * Defaults to false.
147
+ */
148
+ removeUntracked?: boolean
149
+ /**
150
+ * Remove ignored files from the working dir.
151
+ *
152
+ * Defaults to false.
153
+ */
154
+ removeIgnored?: boolean
155
+ /**
156
+ * Only update the contents of files that already exist.
157
+ *
158
+ * If set, files will not be created or deleted.
159
+ *
160
+ * Defaults to false.
161
+ */
162
+ updateOnly?: boolean
163
+ /**
164
+ * Prevents checkout from writing the updated files' information to the
165
+ * index.
166
+ *
167
+ * Defaults to true.
168
+ */
169
+ updateIndex?: boolean
170
+ /**
171
+ * Indicate whether the index and git attributes should be refreshed from
172
+ * disk before any operations.
173
+ *
174
+ * Defaults to true,
175
+ */
176
+ refresh?: boolean
177
+ /**
178
+ * Skip files with unmerged index entries.
179
+ *
180
+ * Defaults to false.
181
+ */
182
+ skipUnmerged?: boolean
183
+ /**
184
+ * Indicate whether the checkout should proceed on conflicts by using the
185
+ * stage 2 version of the file ("ours").
186
+ *
187
+ * Defaults to false.
188
+ */
189
+ useOurs?: boolean
190
+ /**
191
+ * Indicate whether the checkout should proceed on conflicts by using the
192
+ * stage 3 version of the file ("theirs").
193
+ *
194
+ * Defaults to false.
195
+ */
196
+ useTheirs?: boolean
197
+ /**
198
+ * Indicate whether ignored files should be overwritten during the checkout.
199
+ *
200
+ * Defaults to true.
201
+ */
202
+ overwriteIgnored?: boolean
203
+ /**
204
+ * Indicate whether a normal merge file should be written for conflicts.
205
+ *
206
+ * Defaults to false.
207
+ */
208
+ conflictStyleMerge?: boolean
209
+ /**
210
+ * Indicates whether to include common ancestor data in diff3 format files
211
+ * for conflicts.
212
+ *
213
+ * Defaults to false.
214
+ */
215
+ conflictStyleDiff3?: boolean
216
+ /**
217
+ * Treat paths specified in `path` as exact file paths
218
+ * instead of as pathspecs.
219
+ */
220
+ disablePathspecMatch?: boolean
221
+ /** Indicate whether to apply filters like CRLF conversion. */
222
+ disableFilters?: boolean
223
+ /**
224
+ * Set the mode with which new directories are created.
225
+ *
226
+ * Default is 0755
227
+ */
228
+ dirPerm?: number
229
+ /**
230
+ * Set the mode with which new files are created.
231
+ *
232
+ * The default is 0644 or 0755 as dictated by the blob.
233
+ */
234
+ filePerm?: number
235
+ /**
236
+ * Add a path to be checked out.
237
+ *
238
+ * The path is a [pathspec](https://git-scm.com/docs/gitglossary.html#Documentation/gitglossary.txt-aiddefpathspecapathspec) pattern, unless
239
+ * `disablePathspecMatch` is set.
240
+ *
241
+ * If no paths are specified, then all files are checked out. Otherwise
242
+ * only these specified paths are checked out.
243
+ */
244
+ path?: string
245
+ /** Set the directory to check out to */
246
+ targetDir?: string
247
+ /** The name of the common ancestor side of conflicts */
248
+ ancestorLabel?: string
249
+ /** The name of the common our side of conflicts */
250
+ ourLabel?: string
251
+ /** The name of the common their side of conflicts */
252
+ theirLabel?: string
253
+ }
112
254
  export interface CommitOptions {
113
255
  updateRef?: string
114
256
  /**
@@ -3900,6 +4042,55 @@ export declare class Repository {
3900
4042
  * ```
3901
4043
  */
3902
4044
  branches(filter?: BranchesFilter | undefined | null): Branches
4045
+ /**
4046
+ * Updates files in the index and the working tree to match the content of
4047
+ * the commit pointed at by HEAD.
4048
+ *
4049
+ * @category Repository/Methods
4050
+ * @signature
4051
+ * ```ts
4052
+ * class Repository {
4053
+ * checkoutHead(options?: CheckoutOptions | undefined | null): void;
4054
+ * }
4055
+ * ```
4056
+ *
4057
+ * @param {CheckoutOptions} [options] - Options for checkout.
4058
+ */
4059
+ checkoutHead(options?: CheckoutOptions | undefined | null): void
4060
+ /**
4061
+ * Updates files in the working tree to match the content of the index.
4062
+ *
4063
+ * @category Repository/Methods
4064
+ * @signature
4065
+ * ```ts
4066
+ * class Repository {
4067
+ * checkoutIndex(
4068
+ * index?: Index | undefined | null,
4069
+ * options?: CheckoutOptions | undefined | null,
4070
+ * ): void;
4071
+ * }
4072
+ * ```
4073
+ *
4074
+ * @param {Index} [index] - Index to checkout. If not given, the repository's index will be used.
4075
+ * @param {CheckoutOptions} [options] - Options for checkout.
4076
+ */
4077
+ checkoutIndex(index?: Index | undefined | null, options?: CheckoutOptions | undefined | null): void
4078
+ /**
4079
+ * Updates files in the index and working tree to match the content of the
4080
+ * tree pointed at by the treeish.
4081
+ *
4082
+ * @category Repository/Methods
4083
+ * @signature
4084
+ * ```ts
4085
+ * class Repository {
4086
+ * checkoutTree(treeish: GitObject, options?: CheckoutOptions | undefined | null): void;
4087
+ * }
4088
+ * ```
4089
+ *
4090
+ * @param {GitObject} treeish - Git object which tree pointed.
4091
+ * @param {CheckoutOptions} [options] - Options for checkout.
4092
+ */
4093
+ checkoutTree(treeish: GitObject, options?: CheckoutOptions | undefined | null): void
3903
4094
  /**
3904
4095
  * Lookup a reference to one of the commits in a repository.
3905
4096
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "es-git",
3
- "version": "0.3.0-next.127+d1fac8f",
3
+ "version": "0.3.0-next.129+c063836",
4
4
  "main": "index.js",
5
5
  "types": "index.d.ts",
6
6
  "files": [
@@ -57,15 +57,15 @@
57
57
  "vitest": "^3.0.5"
58
58
  },
59
59
  "optionalDependencies": {
60
- "es-git-darwin-x64": "0.3.0-next.127+d1fac8f",
61
- "es-git-darwin-arm64": "0.3.0-next.127+d1fac8f",
62
- "es-git-win32-x64-msvc": "0.3.0-next.127+d1fac8f",
63
- "es-git-win32-arm64-msvc": "0.3.0-next.127+d1fac8f",
64
- "es-git-linux-x64-gnu": "0.3.0-next.127+d1fac8f",
65
- "es-git-linux-x64-musl": "0.3.0-next.127+d1fac8f",
66
- "es-git-android-arm64": "0.3.0-next.127+d1fac8f",
67
- "es-git-linux-arm64-gnu": "0.3.0-next.127+d1fac8f",
68
- "es-git-linux-arm64-musl": "0.3.0-next.127+d1fac8f",
69
- "es-git-android-arm-eabi": "0.3.0-next.127+d1fac8f"
60
+ "es-git-darwin-x64": "0.3.0-next.129+c063836",
61
+ "es-git-darwin-arm64": "0.3.0-next.129+c063836",
62
+ "es-git-win32-x64-msvc": "0.3.0-next.129+c063836",
63
+ "es-git-win32-arm64-msvc": "0.3.0-next.129+c063836",
64
+ "es-git-linux-x64-gnu": "0.3.0-next.129+c063836",
65
+ "es-git-linux-x64-musl": "0.3.0-next.129+c063836",
66
+ "es-git-android-arm64": "0.3.0-next.129+c063836",
67
+ "es-git-linux-arm64-gnu": "0.3.0-next.129+c063836",
68
+ "es-git-linux-arm64-musl": "0.3.0-next.129+c063836",
69
+ "es-git-android-arm-eabi": "0.3.0-next.129+c063836"
70
70
  }
71
71
  }