git 4.4.6 → 6.0.0

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 (275) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/CHANGELOG.md +348 -39
  4. data/CONTRIBUTING.md +1014 -144
  5. data/README.md +386 -504
  6. data/UPGRADING.md +1822 -0
  7. data/git.gemspec +102 -22
  8. data/lib/git/author_info.rb +65 -0
  9. data/lib/git/branch_delete_failure.rb +34 -0
  10. data/lib/git/branch_delete_result.rb +66 -0
  11. data/lib/git/branch_info.rb +237 -0
  12. data/lib/git/command_line/base.rb +247 -0
  13. data/lib/git/command_line/capturing.rb +308 -0
  14. data/lib/git/command_line/result.rb +88 -0
  15. data/lib/git/command_line/streaming.rb +236 -0
  16. data/lib/git/command_line.rb +45 -323
  17. data/lib/git/commands/add.rb +139 -0
  18. data/lib/git/commands/am/abort.rb +43 -0
  19. data/lib/git/commands/am/apply.rb +263 -0
  20. data/lib/git/commands/am/continue.rb +43 -0
  21. data/lib/git/commands/am/quit.rb +43 -0
  22. data/lib/git/commands/am/retry.rb +49 -0
  23. data/lib/git/commands/am/show_current_patch.rb +64 -0
  24. data/lib/git/commands/am/skip.rb +42 -0
  25. data/lib/git/commands/am.rb +33 -0
  26. data/lib/git/commands/apply.rb +242 -0
  27. data/lib/git/commands/archive/list_formats.rb +46 -0
  28. data/lib/git/commands/archive.rb +145 -0
  29. data/lib/git/commands/arguments.rb +4521 -0
  30. data/lib/git/commands/base.rb +522 -0
  31. data/lib/git/commands/branch/copy.rb +102 -0
  32. data/lib/git/commands/branch/create.rb +177 -0
  33. data/lib/git/commands/branch/delete.rb +88 -0
  34. data/lib/git/commands/branch/list.rb +178 -0
  35. data/lib/git/commands/branch/move.rb +102 -0
  36. data/lib/git/commands/branch/set_upstream.rb +86 -0
  37. data/lib/git/commands/branch/show_current.rb +49 -0
  38. data/lib/git/commands/branch/unset_upstream.rb +53 -0
  39. data/lib/git/commands/branch.rb +34 -0
  40. data/lib/git/commands/cat_file/batch.rb +385 -0
  41. data/lib/git/commands/cat_file/filtered.rb +105 -0
  42. data/lib/git/commands/cat_file/raw.rb +203 -0
  43. data/lib/git/commands/cat_file.rb +49 -0
  44. data/lib/git/commands/checkout/branch.rb +153 -0
  45. data/lib/git/commands/checkout/files.rb +116 -0
  46. data/lib/git/commands/checkout.rb +38 -0
  47. data/lib/git/commands/checkout_index.rb +106 -0
  48. data/lib/git/commands/clean.rb +102 -0
  49. data/lib/git/commands/clone.rb +241 -0
  50. data/lib/git/commands/commit.rb +273 -0
  51. data/lib/git/commands/commit_tree.rb +101 -0
  52. data/lib/git/commands/config_option_syntax/add.rb +86 -0
  53. data/lib/git/commands/config_option_syntax/get.rb +121 -0
  54. data/lib/git/commands/config_option_syntax/get_all.rb +118 -0
  55. data/lib/git/commands/config_option_syntax/get_color.rb +95 -0
  56. data/lib/git/commands/config_option_syntax/get_color_bool.rb +96 -0
  57. data/lib/git/commands/config_option_syntax/get_regexp.rb +119 -0
  58. data/lib/git/commands/config_option_syntax/get_urlmatch.rb +111 -0
  59. data/lib/git/commands/config_option_syntax/list.rb +111 -0
  60. data/lib/git/commands/config_option_syntax/remove_section.rb +79 -0
  61. data/lib/git/commands/config_option_syntax/rename_section.rb +83 -0
  62. data/lib/git/commands/config_option_syntax/replace_all.rb +109 -0
  63. data/lib/git/commands/config_option_syntax/set.rb +119 -0
  64. data/lib/git/commands/config_option_syntax/unset.rb +92 -0
  65. data/lib/git/commands/config_option_syntax/unset_all.rb +94 -0
  66. data/lib/git/commands/config_option_syntax.rb +56 -0
  67. data/lib/git/commands/describe.rb +156 -0
  68. data/lib/git/commands/diff.rb +657 -0
  69. data/lib/git/commands/diff_files.rb +519 -0
  70. data/lib/git/commands/diff_index.rb +499 -0
  71. data/lib/git/commands/fetch.rb +354 -0
  72. data/lib/git/commands/fsck.rb +138 -0
  73. data/lib/git/commands/gc.rb +134 -0
  74. data/lib/git/commands/grep.rb +339 -0
  75. data/lib/git/commands/init.rb +101 -0
  76. data/lib/git/commands/log.rb +634 -0
  77. data/lib/git/commands/ls_files.rb +195 -0
  78. data/lib/git/commands/ls_remote.rb +161 -0
  79. data/lib/git/commands/ls_tree.rb +135 -0
  80. data/lib/git/commands/maintenance/register.rb +73 -0
  81. data/lib/git/commands/maintenance/run.rb +105 -0
  82. data/lib/git/commands/maintenance/start.rb +67 -0
  83. data/lib/git/commands/maintenance/stop.rb +56 -0
  84. data/lib/git/commands/maintenance/unregister.rb +80 -0
  85. data/lib/git/commands/maintenance.rb +29 -0
  86. data/lib/git/commands/merge/abort.rb +44 -0
  87. data/lib/git/commands/merge/continue.rb +44 -0
  88. data/lib/git/commands/merge/quit.rb +46 -0
  89. data/lib/git/commands/merge/start.rb +250 -0
  90. data/lib/git/commands/merge.rb +28 -0
  91. data/lib/git/commands/merge_base.rb +91 -0
  92. data/lib/git/commands/mv.rb +82 -0
  93. data/lib/git/commands/name_rev.rb +119 -0
  94. data/lib/git/commands/pull.rb +382 -0
  95. data/lib/git/commands/push.rb +251 -0
  96. data/lib/git/commands/read_tree.rb +154 -0
  97. data/lib/git/commands/remote/add.rb +96 -0
  98. data/lib/git/commands/remote/get_url.rb +68 -0
  99. data/lib/git/commands/remote/list.rb +56 -0
  100. data/lib/git/commands/remote/prune.rb +63 -0
  101. data/lib/git/commands/remote/remove.rb +52 -0
  102. data/lib/git/commands/remote/rename.rb +76 -0
  103. data/lib/git/commands/remote/set_branches.rb +70 -0
  104. data/lib/git/commands/remote/set_head.rb +89 -0
  105. data/lib/git/commands/remote/set_url.rb +78 -0
  106. data/lib/git/commands/remote/set_url_add.rb +70 -0
  107. data/lib/git/commands/remote/set_url_delete.rb +71 -0
  108. data/lib/git/commands/remote/show.rb +77 -0
  109. data/lib/git/commands/remote/update.rb +79 -0
  110. data/lib/git/commands/remote.rb +42 -0
  111. data/lib/git/commands/repack.rb +281 -0
  112. data/lib/git/commands/reset.rb +154 -0
  113. data/lib/git/commands/rev_parse.rb +304 -0
  114. data/lib/git/commands/revert/abort.rb +45 -0
  115. data/lib/git/commands/revert/continue.rb +62 -0
  116. data/lib/git/commands/revert/quit.rb +47 -0
  117. data/lib/git/commands/revert/skip.rb +44 -0
  118. data/lib/git/commands/revert/start.rb +158 -0
  119. data/lib/git/commands/revert.rb +29 -0
  120. data/lib/git/commands/rm.rb +113 -0
  121. data/lib/git/commands/show.rb +632 -0
  122. data/lib/git/commands/show_ref/exclude_existing.rb +119 -0
  123. data/lib/git/commands/show_ref/exists.rb +75 -0
  124. data/lib/git/commands/show_ref/list.rb +149 -0
  125. data/lib/git/commands/show_ref/verify.rb +122 -0
  126. data/lib/git/commands/show_ref.rb +42 -0
  127. data/lib/git/commands/stash/apply.rb +81 -0
  128. data/lib/git/commands/stash/branch.rb +67 -0
  129. data/lib/git/commands/stash/clear.rb +43 -0
  130. data/lib/git/commands/stash/create.rb +60 -0
  131. data/lib/git/commands/stash/drop.rb +73 -0
  132. data/lib/git/commands/stash/list.rb +43 -0
  133. data/lib/git/commands/stash/pop.rb +87 -0
  134. data/lib/git/commands/stash/push.rb +112 -0
  135. data/lib/git/commands/stash/show.rb +158 -0
  136. data/lib/git/commands/stash/store.rb +72 -0
  137. data/lib/git/commands/stash.rb +38 -0
  138. data/lib/git/commands/status.rb +174 -0
  139. data/lib/git/commands/symbolic_ref/delete.rb +72 -0
  140. data/lib/git/commands/symbolic_ref/read.rb +99 -0
  141. data/lib/git/commands/symbolic_ref/update.rb +79 -0
  142. data/lib/git/commands/symbolic_ref.rb +38 -0
  143. data/lib/git/commands/tag/create.rb +142 -0
  144. data/lib/git/commands/tag/delete.rb +57 -0
  145. data/lib/git/commands/tag/list.rb +146 -0
  146. data/lib/git/commands/tag/verify.rb +71 -0
  147. data/lib/git/commands/tag.rb +26 -0
  148. data/lib/git/commands/update_ref/batch.rb +145 -0
  149. data/lib/git/commands/update_ref/delete.rb +90 -0
  150. data/lib/git/commands/update_ref/update.rb +103 -0
  151. data/lib/git/commands/update_ref.rb +42 -0
  152. data/lib/git/commands/version.rb +60 -0
  153. data/lib/git/commands/worktree/add.rb +139 -0
  154. data/lib/git/commands/worktree/list.rb +64 -0
  155. data/lib/git/commands/worktree/lock.rb +58 -0
  156. data/lib/git/commands/worktree/management_base.rb +51 -0
  157. data/lib/git/commands/worktree/move.rb +66 -0
  158. data/lib/git/commands/worktree/prune.rb +67 -0
  159. data/lib/git/commands/worktree/remove.rb +63 -0
  160. data/lib/git/commands/worktree/repair.rb +71 -0
  161. data/lib/git/commands/worktree/unlock.rb +47 -0
  162. data/lib/git/commands/worktree.rb +43 -0
  163. data/lib/git/commands/write_tree.rb +68 -0
  164. data/lib/git/commands.rb +88 -0
  165. data/lib/git/config.rb +64 -1
  166. data/lib/git/config_entry_info.rb +106 -0
  167. data/lib/git/configuring.rb +795 -0
  168. data/lib/git/detached_head_info.rb +57 -0
  169. data/lib/git/diff.rb +295 -12
  170. data/lib/git/diff_file_numstat_info.rb +31 -0
  171. data/lib/git/diff_file_patch_info.rb +136 -0
  172. data/lib/git/diff_file_raw_info.rb +129 -0
  173. data/lib/git/diff_info.rb +162 -0
  174. data/lib/git/diff_path_status.rb +80 -19
  175. data/lib/git/diff_result.rb +34 -0
  176. data/lib/git/diff_stats.rb +66 -14
  177. data/lib/git/dirstat_info.rb +102 -0
  178. data/lib/git/encoding_utils.rb +57 -1
  179. data/lib/git/errors.rb +107 -26
  180. data/lib/git/escaped_path.rb +55 -3
  181. data/lib/git/execution_context/global.rb +31 -0
  182. data/lib/git/execution_context/repository.rb +151 -0
  183. data/lib/git/execution_context.rb +559 -0
  184. data/lib/git/factories.rb +1049 -0
  185. data/lib/git/file_ref.rb +77 -0
  186. data/lib/git/fsck_object.rb +17 -9
  187. data/lib/git/fsck_result.rb +27 -16
  188. data/lib/git/log.rb +172 -65
  189. data/lib/git/object.rb +323 -108
  190. data/lib/git/parsers/branch.rb +240 -0
  191. data/lib/git/parsers/cat_file.rb +111 -0
  192. data/lib/git/parsers/config_entry.rb +110 -0
  193. data/lib/git/parsers/diff.rb +792 -0
  194. data/lib/git/parsers/fsck.rb +144 -0
  195. data/lib/git/parsers/grep.rb +42 -0
  196. data/lib/git/parsers/ls_remote.rb +79 -0
  197. data/lib/git/parsers/ls_tree.rb +58 -0
  198. data/lib/git/parsers/remote.rb +162 -0
  199. data/lib/git/parsers/stash.rb +292 -0
  200. data/lib/git/parsers/status.rb +251 -0
  201. data/lib/git/parsers/tag.rb +341 -0
  202. data/lib/git/parsers/worktree.rb +185 -0
  203. data/lib/git/path_resolver.rb +274 -0
  204. data/lib/git/remote_info.rb +203 -0
  205. data/lib/git/repository/branching.rb +796 -0
  206. data/lib/git/repository/committing.rb +221 -0
  207. data/lib/git/repository/context_helpers.rb +454 -0
  208. data/lib/git/repository/diffing.rb +743 -0
  209. data/lib/git/repository/inspecting.rb +252 -0
  210. data/lib/git/repository/logging.rb +410 -0
  211. data/lib/git/repository/maintenance.rb +65 -0
  212. data/lib/git/repository/merging.rb +429 -0
  213. data/lib/git/repository/object_operations.rb +1334 -0
  214. data/lib/git/repository/remote_operations.rb +772 -0
  215. data/lib/git/repository/shared_private.rb +120 -0
  216. data/lib/git/repository/staging.rb +409 -0
  217. data/lib/git/repository/stashing.rb +619 -0
  218. data/lib/git/repository/status_operations.rb +196 -0
  219. data/lib/git/repository/worktree_operations.rb +252 -0
  220. data/lib/git/repository.rb +204 -1
  221. data/lib/git/stash_info.rb +102 -0
  222. data/lib/git/status_file_info.rb +258 -0
  223. data/lib/git/status_info.rb +189 -0
  224. data/lib/git/system_call_guard.rb +95 -0
  225. data/lib/git/tag_delete_failure.rb +34 -0
  226. data/lib/git/tag_delete_result.rb +66 -0
  227. data/lib/git/tag_info.rb +99 -0
  228. data/lib/git/url.rb +12 -5
  229. data/lib/git/version.rb +111 -2
  230. data/lib/git/version_constraint.rb +85 -0
  231. data/lib/git/worktree_info.rb +128 -0
  232. data/lib/git.rb +319 -332
  233. metadata +318 -74
  234. data/.commitlintrc.yml +0 -38
  235. data/.github/copilot-instructions.md +0 -2733
  236. data/.github/issue_template.md +0 -15
  237. data/.github/pull_request_template.md +0 -17
  238. data/.github/workflows/continuous_integration.yml +0 -120
  239. data/.github/workflows/enforce_conventional_commits.yml +0 -29
  240. data/.github/workflows/experimental_continuous_integration.yml +0 -59
  241. data/.github/workflows/release.yml +0 -53
  242. data/.gitignore +0 -15
  243. data/.husky/commit-msg +0 -1
  244. data/.release-please-manifest.json +0 -3
  245. data/.rubocop.yml +0 -55
  246. data/.rubocop_todo.yml +0 -12
  247. data/Gemfile +0 -5
  248. data/Rakefile +0 -18
  249. data/lib/git/args_builder.rb +0 -111
  250. data/lib/git/author.rb +0 -16
  251. data/lib/git/base.rb +0 -1140
  252. data/lib/git/branch.rb +0 -423
  253. data/lib/git/branches.rb +0 -68
  254. data/lib/git/command_line_result.rb +0 -92
  255. data/lib/git/index.rb +0 -6
  256. data/lib/git/lib.rb +0 -2333
  257. data/lib/git/path.rb +0 -38
  258. data/lib/git/remote.rb +0 -39
  259. data/lib/git/stash.rb +0 -26
  260. data/lib/git/stashes.rb +0 -56
  261. data/lib/git/status.rb +0 -159
  262. data/lib/git/working_directory.rb +0 -6
  263. data/lib/git/worktree.rb +0 -39
  264. data/lib/git/worktrees.rb +0 -47
  265. data/package.json +0 -10
  266. data/redesign/1_architecture_existing.md +0 -66
  267. data/redesign/2_architecture_redesign.md +0 -130
  268. data/redesign/3_architecture_implementation.md +0 -138
  269. data/redesign/index.md +0 -34
  270. data/release-please-config.json +0 -36
  271. data/tasks/gem_tasks.rake +0 -10
  272. data/tasks/rubocop.rake +0 -12
  273. data/tasks/test.rake +0 -13
  274. data/tasks/test_gem.rake +0 -12
  275. data/tasks/yard.rake +0 -23
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ # Remove untracked files from the working tree
8
+ #
9
+ # Cleans the working tree by recursively removing files that are not under
10
+ # version control. Only files unknown to Git are removed by default; with
11
+ # `:x` also removes ignored files; with `:X` removes only ignored files.
12
+ #
13
+ # @example Typical usage
14
+ # clean = Git::Commands::Clean.new(execution_context)
15
+ # clean.call(force: true)
16
+ # clean.call(force: true, d: true)
17
+ # clean.call(force: 2)
18
+ # clean.call(dry_run: true)
19
+ # clean.call(force: true, exclude: '*.log')
20
+ # clean.call(force: true, X: true)
21
+ # clean.call(force: true, pathspec: ['tmp/', 'build/'])
22
+ #
23
+ # @note `arguments` block audited against https://git-scm.com/docs/git-clean/2.53.0
24
+ #
25
+ # @see Git::Commands
26
+ #
27
+ # @see https://git-scm.com/docs/git-clean git-clean
28
+ #
29
+ # @api private
30
+ #
31
+ class Clean < Git::Commands::Base
32
+ arguments do
33
+ literal 'clean'
34
+ flag_option :d
35
+ flag_option %i[force f], max_times: 2
36
+ flag_option %i[dry_run n]
37
+ flag_option %i[quiet q]
38
+ value_option %i[exclude e], inline: true, repeatable: true
39
+ flag_option :x
40
+ flag_option :X
41
+ execution_option :chdir
42
+ end_of_options
43
+ value_option :pathspec, as_operand: true, repeatable: true
44
+ end
45
+
46
+ # @overload call(**options)
47
+ #
48
+ # Execute the git clean command
49
+ #
50
+ # @param options [Hash] command options
51
+ #
52
+ # @option options [Boolean, nil] :d (nil) recurse into untracked directories
53
+ #
54
+ # @option options [Boolean, Integer, nil] :force (nil) force the removal of untracked files
55
+ #
56
+ # When `clean.requireForce` is not set to `false`, git-clean will refuse to
57
+ # delete files or directories unless this option is given.
58
+ #
59
+ # Pass `true` or `1` to emit `--force` once. Pass `2` to emit `--force --force`,
60
+ # which also removes untracked nested git repositories (directories with a
61
+ # `.git` subdirectory).
62
+ #
63
+ # Alias: `:f`
64
+ #
65
+ # @option options [Boolean, nil] :dry_run (nil) don't actually remove anything, just
66
+ # show what would be done
67
+ #
68
+ # Alias: `:n`
69
+ #
70
+ # @option options [Boolean, nil] :quiet (nil) be quiet, only report errors
71
+ #
72
+ # Alias: `:q`
73
+ #
74
+ # @option options [String, Array<String>] :exclude (nil) use the given exclude
75
+ # pattern in addition to the standard ignore rules
76
+ #
77
+ # May be specified multiple times. Alias: `:e`
78
+ #
79
+ # @option options [Boolean, nil] :x (nil) don't use the standard ignore rules
80
+ #
81
+ # @option options [Boolean, nil] :X (nil) remove only files ignored by Git
82
+ #
83
+ # @option options [String, Array<String>] :pathspec (nil) limit cleaning to files
84
+ # matching the given pathspec(s)
85
+ #
86
+ # @option options [String, nil] :chdir (nil) change to this directory before
87
+ # running git; not passed to the git CLI
88
+ #
89
+ # @return [Git::CommandLine::Result] the result of calling `git clean`
90
+ #
91
+ # @raise [ArgumentError] if unsupported options are provided
92
+ #
93
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
94
+ #
95
+ # @api public
96
+ #
97
+ def call(*, **)
98
+ super
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,241 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ # Implements the `git clone` command
8
+ #
9
+ # Clones a repository into a newly created directory.
10
+ #
11
+ # @example Typical usage
12
+ # clone = Git::Commands::Clone.new(execution_context)
13
+ # clone.call('https://github.com/user/repo.git')
14
+ # clone.call('https://github.com/user/repo.git', 'local-dir')
15
+ # clone.call('https://github.com/user/repo.git', 'local-dir', bare: true)
16
+ # clone.call('https://github.com/user/repo.git', 'local-dir', depth: 1)
17
+ #
18
+ # @note `arguments` block audited against https://git-scm.com/docs/git-clone/2.53.0
19
+ #
20
+ # @see https://git-scm.com/docs/git-clone git-clone
21
+ #
22
+ # @see Git::Commands
23
+ #
24
+ # @api private
25
+ #
26
+ class Clone < Git::Commands::Base
27
+ arguments do
28
+ literal 'clone'
29
+ value_option :template, inline: true
30
+ flag_option %i[local l], negatable: true
31
+ flag_option %i[shared s]
32
+ flag_option :no_hardlinks
33
+ flag_option %i[quiet q]
34
+ flag_option %i[verbose v]
35
+ flag_option :progress
36
+ flag_option %i[no_checkout n]
37
+ flag_option :bare
38
+ flag_option :mirror
39
+ value_option %i[origin o]
40
+ value_option %i[branch b]
41
+ value_option :revision, inline: true
42
+ value_option %i[upload_pack u]
43
+ value_option :reference, repeatable: true
44
+ value_option :reference_if_able, repeatable: true
45
+ flag_option :dissociate
46
+ value_option :separate_git_dir, inline: true
47
+ value_option :server_option, inline: true, repeatable: true
48
+ value_option :depth
49
+ value_option :shallow_since, inline: true
50
+ value_option :shallow_exclude, inline: true, repeatable: true
51
+ flag_option :single_branch, negatable: true
52
+ flag_option :tags, negatable: true
53
+ flag_or_value_option :recurse_submodules, inline: true, repeatable: true
54
+ flag_option :shallow_submodules, negatable: true
55
+ flag_option :remote_submodules, negatable: true
56
+ value_option %i[jobs j]
57
+ flag_option :sparse
58
+ flag_option :reject_shallow, negatable: true
59
+ value_option :filter, inline: true
60
+ flag_option :also_filter_submodules
61
+ value_option %i[config c], repeatable: true
62
+ value_option :bundle_uri, inline: true
63
+ value_option :ref_format, inline: true
64
+ end_of_options
65
+ operand :repository, required: true
66
+ operand :directory
67
+ execution_option :timeout
68
+ execution_option :chdir
69
+ end
70
+
71
+ # @overload call(repository, directory = nil, **options)
72
+ #
73
+ # Execute the `git clone` command
74
+ #
75
+ # @param repository [String] the URL or path of the repository to clone
76
+ #
77
+ # @param directory [String, nil] the directory to clone into; git derives the
78
+ # name from the repository URL when omitted
79
+ #
80
+ # @param options [Hash] command options
81
+ #
82
+ # @option options [String] :template (nil) directory from which templates
83
+ # will be used
84
+ #
85
+ # @option options [Boolean, nil] :local (nil) bypass the normal Git-aware transport
86
+ # for local clones (`--local`)
87
+ #
88
+ # Alias: `:l`
89
+ #
90
+ # @option options [Boolean, nil] :no_local (nil) disable the local optimization
91
+ # and use the normal transport (`--no-local`)
92
+ #
93
+ # @option options [Boolean, nil] :shared (nil) set up a shared clone using
94
+ # alternates instead of hardlinks
95
+ #
96
+ # Alias: `:s`
97
+ #
98
+ # @option options [Boolean, nil] :no_hardlinks (nil) force file-copy instead of
99
+ # hardlinks when cloning from a local filesystem
100
+ #
101
+ # @option options [Boolean, nil] :quiet (nil) suppress progress output to stderr
102
+ #
103
+ # Alias: `:q`
104
+ #
105
+ # @option options [Boolean, nil] :verbose (nil) run verbosely
106
+ #
107
+ # Alias: `:v`
108
+ #
109
+ # @option options [Boolean, nil] :progress (nil) force progress status even when
110
+ # stderr is not a terminal
111
+ #
112
+ # @option options [Boolean, nil] :no_checkout (nil) skip checking out HEAD after
113
+ # the clone
114
+ #
115
+ # Alias: `:n`
116
+ #
117
+ # @option options [Boolean, nil] :bare (nil) clone as a bare repository
118
+ #
119
+ # @option options [Boolean, nil] :mirror (nil) set up a mirror clone (implies
120
+ # --bare)
121
+ #
122
+ # @option options [String] :origin (nil) name of the remote to use instead of
123
+ # "origin"
124
+ #
125
+ # Alias: `:o`
126
+ #
127
+ # @option options [String] :branch (nil) branch to check out after cloning
128
+ #
129
+ # Alias: `:b`
130
+ #
131
+ # @option options [String] :revision (nil) detach HEAD at the given revision
132
+ # after cloning; incompatible with :branch and :mirror
133
+ #
134
+ # @option options [String] :upload_pack (nil) path to git-upload-pack on the
135
+ # remote (ssh only)
136
+ #
137
+ # Alias: `:u`
138
+ #
139
+ # @option options [String, Array<String>] :reference (nil) borrow objects from
140
+ # one or more reference repositories
141
+ #
142
+ # @option options [String, Array<String>] :reference_if_able (nil) like
143
+ # :reference but skip with a warning when the reference does not exist
144
+ #
145
+ # @option options [Boolean, nil] :dissociate (nil) stop borrowing from reference
146
+ # repositories after the clone is complete
147
+ #
148
+ # @option options [String] :separate_git_dir (nil) place the git directory at
149
+ # the given path and create a gitfile symlink in the working tree
150
+ #
151
+ # @option options [String, Array<String>] :server_option (nil) protocol-v2
152
+ # server options
153
+ #
154
+ # @option options [Integer, String] :depth (nil) create a shallow clone with
155
+ # the specified number of commits
156
+ #
157
+ # @option options [String] :shallow_since (nil) create a shallow clone with
158
+ # history after the specified date
159
+ #
160
+ # @option options [String, Array<String>] :shallow_exclude (nil) exclude
161
+ # commits reachable from the specified remote branch or tag
162
+ #
163
+ # @option options [Boolean, nil] :single_branch (nil) clone only the history for
164
+ # one branch (`--single-branch`)
165
+ #
166
+ # @option options [Boolean, nil] :no_single_branch (nil) clone history for all
167
+ # branches (`--no-single-branch`)
168
+ #
169
+ # @option options [Boolean, nil] :tags (nil) include tags in the clone (`--tags`)
170
+ #
171
+ # @option options [Boolean, nil] :no_tags (nil) exclude tags from the clone
172
+ # (`--no-tags`)
173
+ #
174
+ # @option options [Boolean, String, Array<String>, nil] :recurse_submodules (nil)
175
+ # initialize submodules after cloning; pass true for all submodules or a
176
+ # pathspec string/array for a subset
177
+ #
178
+ # @option options [Boolean, nil] :shallow_submodules (nil) clone submodules with
179
+ # depth 1 (`--shallow-submodules`)
180
+ #
181
+ # @option options [Boolean, nil] :no_shallow_submodules (nil) clone submodules
182
+ # with full history (`--no-shallow-submodules`)
183
+ #
184
+ # @option options [Boolean, nil] :remote_submodules (nil) use submodule
185
+ # remote-tracking branch status (`--remote-submodules`)
186
+ #
187
+ # @option options [Boolean, nil] :no_remote_submodules (nil) use the locally
188
+ # recorded SHA-1 for submodules (`--no-remote-submodules`)
189
+ #
190
+ # @option options [Integer, String] :jobs (nil) number of submodules fetched
191
+ # concurrently
192
+ #
193
+ # Alias: `:j`
194
+ #
195
+ # @option options [Boolean, nil] :sparse (nil) enable sparse checkout with
196
+ # top-level files only
197
+ #
198
+ # @option options [Boolean, nil] :reject_shallow (nil) fail if source is shallow
199
+ # (`--reject-shallow`)
200
+ #
201
+ # @option options [Boolean, nil] :no_reject_shallow (nil) allow cloning from
202
+ # shallow sources (`--no-reject-shallow`)
203
+ #
204
+ # @option options [String] :filter (nil) specify a partial clone filter
205
+ # (e.g., 'blob:none', 'tree:0')
206
+ #
207
+ # @option options [Boolean, nil] :also_filter_submodules (nil) apply the partial
208
+ # clone filter to submodules; requires :filter and :recurse_submodules
209
+ #
210
+ # @option options [String, Array<String>] :config (nil) set configuration
211
+ # variables in the newly-created repository
212
+ #
213
+ # Alias: `:c`
214
+ #
215
+ # @option options [String] :bundle_uri (nil) fetch a bundle from the given URI
216
+ # before fetching from the remote
217
+ #
218
+ # @option options [String] :ref_format (nil) specify the ref storage format
219
+ # (e.g., 'files', 'reftable')
220
+ #
221
+ # @option options [Numeric, nil] :timeout (nil) the number of seconds to wait
222
+ # for the command to complete; if nil, uses the global timeout from
223
+ # {Git::Config}; if 0, no timeout is enforced
224
+ #
225
+ # @option options [String, nil] :chdir (nil) the working directory in which to
226
+ # run the git clone command
227
+ #
228
+ # @return [Git::CommandLine::Result] the result of calling `git clone`
229
+ #
230
+ # @raise [ArgumentError] if unsupported options are provided
231
+ #
232
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
233
+ #
234
+ # @api public
235
+ #
236
+ def call(*, **)
237
+ super
238
+ end
239
+ end
240
+ end
241
+ end
@@ -0,0 +1,273 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ # Implements the `git commit` command
8
+ #
9
+ # This command records changes to the repository by creating a new commit
10
+ # with the staged changes.
11
+ #
12
+ # @example Typical usage
13
+ # commit = Git::Commands::Commit.new(execution_context)
14
+ # commit.call(message: 'Initial commit')
15
+ # commit.call(message: 'Add feature', all: true, author: 'Jane <jane@example.com>')
16
+ # commit.call(amend: true, no_verify: true) # emits --no-verify
17
+ # commit.call('src/foo.rb', message: 'Update foo')
18
+ #
19
+ # @note `arguments` block audited against https://git-scm.com/docs/git-commit/2.53.0
20
+ #
21
+ # @see https://git-scm.com/docs/git-commit git-commit
22
+ #
23
+ # @see Git::Commands
24
+ #
25
+ # @api private
26
+ #
27
+ class Commit < Git::Commands::Base
28
+ arguments do
29
+ literal 'commit'
30
+
31
+ # Stage selection
32
+ flag_option %i[all a]
33
+
34
+ # Message source and editing
35
+ flag_option %i[edit e], negatable: true
36
+ flag_option :amend
37
+ value_option %i[reuse_message C], inline: true
38
+ value_option :fixup, inline: true
39
+ value_option :squash, inline: true
40
+ value_option %i[message m], inline: true, allow_empty: true
41
+ value_option %i[file F], inline: true
42
+ value_option %i[template t], inline: true
43
+
44
+ # Author / date
45
+ flag_option :reset_author
46
+ value_option :author, inline: true
47
+ value_option :date, inline: true, type: String
48
+
49
+ # Message cleanup and trailers
50
+ value_option :cleanup, inline: true
51
+ value_option :trailer, repeatable: true
52
+
53
+ # Hooks
54
+ flag_option %i[verify n], negatable: true
55
+
56
+ # Behavior
57
+ flag_option :allow_empty
58
+ flag_option :allow_empty_message
59
+ flag_option :no_post_rewrite
60
+ flag_option %i[include i]
61
+ flag_option %i[only o]
62
+
63
+ # Output / dry-run
64
+ flag_option :dry_run
65
+ flag_option :short
66
+ flag_option :branch
67
+ flag_option :porcelain
68
+ flag_option :long
69
+ flag_option %i[null z]
70
+ flag_option %i[verbose v], max_times: 2
71
+ flag_option %i[quiet q]
72
+ flag_option :status, negatable: true
73
+
74
+ # Verbose diff options
75
+ value_option %i[unified U], inline: true, type: Integer
76
+ value_option :inter_hunk_context, inline: true, type: Integer
77
+
78
+ # Signoff
79
+ flag_option %i[signoff s], negatable: true
80
+
81
+ # GPG signing
82
+ flag_or_value_option %i[gpg_sign S], negatable: true, inline: true
83
+
84
+ # Untracked files
85
+ flag_or_value_option %i[untracked_files u], inline: true
86
+
87
+ # Pathspec from file
88
+ value_option :pathspec_from_file, inline: true
89
+ flag_option :pathspec_file_nul
90
+
91
+ # Path selection
92
+ end_of_options
93
+ operand :pathspec, repeatable: true
94
+ end
95
+
96
+ # @overload call(*pathspec, **options)
97
+ #
98
+ # Execute the `git commit` command.
99
+ #
100
+ # @param pathspec [Array<String>] zero or more paths to commit
101
+ #
102
+ # When given, only changes to the listed paths are committed, ignoring
103
+ # staged changes for other paths.
104
+ #
105
+ # @param options [Hash] command options
106
+ #
107
+ # @option options [Boolean, nil] :all (nil) automatically stage modified and deleted
108
+ # files before committing
109
+ #
110
+ # Alias: `:a`
111
+ #
112
+ # @option options [Boolean, nil] :edit (nil) open an editor for the commit message (`--edit`)
113
+ #
114
+ # Alias: `:e`
115
+ #
116
+ # @option options [Boolean, nil] :no_edit (nil) suppress the editor (`--no-edit`)
117
+ #
118
+ # @option options [Boolean, nil] :amend (nil) replace the tip of the current branch
119
+ # with a new commit
120
+ #
121
+ # @option options [String] :reuse_message (nil) reuse the log message and
122
+ # authorship from the given commit without invoking an editor
123
+ #
124
+ # Alias: `:C`
125
+ #
126
+ # @option options [String] :fixup (nil) create a fixup or amend commit targeting
127
+ # the given commit
128
+ #
129
+ # Pass `<commit>` for a plain "fixup!" commit, `amend:<commit>` to also replace
130
+ # the log message, or `reword:<commit>` to replace only the log message.
131
+ #
132
+ # @option options [String] :squash (nil) construct a "squash!" commit message for
133
+ # use with `git rebase --autosquash`
134
+ #
135
+ # @option options [String] :message (nil) use the given string as the commit message
136
+ #
137
+ # Alias: `:m`
138
+ #
139
+ # @option options [String] :file (nil) read the commit message from the given file;
140
+ # use `-` to read from standard input
141
+ #
142
+ # Alias: `:F`
143
+ #
144
+ # @option options [String] :template (nil) start the editor with the contents of
145
+ # the given file as the commit message template
146
+ #
147
+ # Alias: `:t`
148
+ #
149
+ # @option options [Boolean, nil] :reset_author (nil) when used with `:reuse_message`
150
+ # or `:amend`, declare the committer as the new author
151
+ #
152
+ # @option options [String] :author (nil) override the commit author
153
+ #
154
+ # @option options [String] :date (nil) override the author date
155
+ #
156
+ # @option options [String] :cleanup (nil) how to clean up the commit message before
157
+ # committing; one of `strip`, `whitespace`, `verbatim`, `scissors`, or `default`
158
+ #
159
+ # @option options [String, Array<String>] :trailer (nil) add one or more
160
+ # `<token>[=<value>]` trailers to the commit message
161
+ #
162
+ # @option options [Boolean, nil] :verify (nil) run pre-commit and commit-msg hooks (`--verify`)
163
+ #
164
+ # Alias: `:n`
165
+ #
166
+ # @option options [Boolean, nil] :no_verify (nil) bypass pre-commit and commit-msg hooks (`--no-verify`)
167
+ #
168
+ # @option options [Boolean, nil] :allow_empty (nil) allow committing with no changes
169
+ #
170
+ # @option options [Boolean, nil] :allow_empty_message (nil) allow committing with an
171
+ # empty message
172
+ #
173
+ # @option options [Boolean, nil] :no_post_rewrite (nil) bypass the post-rewrite hook
174
+ #
175
+ # @option options [Boolean, nil] :include (nil) stage the listed paths before
176
+ # committing in addition to already-staged contents
177
+ #
178
+ # Alias: `:i`
179
+ #
180
+ # @option options [Boolean, nil] :only (nil) commit only the listed paths from the
181
+ # working tree, ignoring staged changes for other paths
182
+ #
183
+ # Alias: `:o`
184
+ #
185
+ # @option options [Boolean, nil] :dry_run (nil) do not create a commit; show what
186
+ # would be committed
187
+ #
188
+ # @option options [Boolean, nil] :short (nil) show short-format dry-run output;
189
+ # implies `:dry_run`
190
+ #
191
+ # @option options [Boolean, nil] :branch (nil) show branch and tracking info in
192
+ # short-format dry-run output
193
+ #
194
+ # @option options [Boolean, nil] :porcelain (nil) show porcelain-format dry-run
195
+ # output; implies `:dry_run`
196
+ #
197
+ # @option options [Boolean, nil] :long (nil) show long-format dry-run output;
198
+ # implies `:dry_run`
199
+ #
200
+ # @option options [Boolean, nil] :null (nil) terminate dry-run output entries with
201
+ # NUL instead of LF
202
+ #
203
+ # Alias: `:z`
204
+ #
205
+ # @option options [Boolean, Integer, nil] :verbose (nil) show unified diff between
206
+ # HEAD and what would be committed at the bottom of the commit message template
207
+ #
208
+ # Pass `2` to also show the unified diff between staged and working-tree changes.
209
+ #
210
+ # Alias: `:v`
211
+ #
212
+ # @option options [Boolean, nil] :quiet (nil) suppress commit summary message
213
+ #
214
+ # Alias: `:q`
215
+ #
216
+ # @option options [Boolean, nil] :status (nil) include `git status` output in the
217
+ # commit message template (`--status`)
218
+ #
219
+ # @option options [Boolean, nil] :no_status (nil) omit `git status` output from the
220
+ # commit message template (`--no-status`)
221
+ #
222
+ # @option options [Integer] :unified (nil) generate verbose diff with the given
223
+ # number of context lines
224
+ #
225
+ # Alias: `:U`
226
+ #
227
+ # @option options [Integer] :inter_hunk_context (nil) show context between diff
228
+ # hunks up to the given number of lines (for use with `:verbose`)
229
+ #
230
+ # @option options [Boolean, nil] :signoff (nil) add a `Signed-off-by` trailer to
231
+ # the commit message (`--signoff`)
232
+ #
233
+ # Alias: `:s`
234
+ #
235
+ # @option options [Boolean, nil] :no_signoff (nil) suppress the `Signed-off-by` trailer (`--no-signoff`)
236
+ #
237
+ # @option options [Boolean, String, nil] :gpg_sign (nil) GPG-sign the commit (`--gpg-sign`)
238
+ #
239
+ # When `true`, uses the default key. When a `String`, uses the specified key ID.
240
+ #
241
+ # Alias: `:S`
242
+ #
243
+ # @option options [Boolean, nil] :no_gpg_sign (nil) disable GPG signing, overriding
244
+ # `commit.gpgSign` config (`--no-gpg-sign`)
245
+ #
246
+ # @option options [Boolean, String, nil] :untracked_files (nil) show untracked files
247
+ # in the dry-run status output
248
+ #
249
+ # When `true`, uses git's default mode (`all`). Pass a `String` (`"no"`,
250
+ # `"normal"`, or `"all"`) to set the mode explicitly.
251
+ #
252
+ # Alias: `:u`
253
+ #
254
+ # @option options [String] :pathspec_from_file (nil) read pathspec from the given
255
+ # file instead of the command line
256
+ #
257
+ # @option options [Boolean, nil] :pathspec_file_nul (nil) pathspec elements in
258
+ # `:pathspec_from_file` are NUL-separated instead of newline-separated
259
+ #
260
+ # @return [Git::CommandLine::Result] the result of calling `git commit`
261
+ #
262
+ # @raise [ArgumentError] if unsupported options are provided
263
+ #
264
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
265
+ #
266
+ # @api public
267
+ #
268
+ def call(*, **)
269
+ super
270
+ end
271
+ end
272
+ end
273
+ end