Integrate with core Git subcommand authoring features. by tomeon · Pull Request #43 · PotatoLabs/git-redate

tomeon · 2023-09-08T17:07:45Z

Thank you for this handy tool!

This PR introduces integration with git-sh-setup, a library included with the
core Git distribution. It provides conveniences for authoring shell-based Git
subcommands.

Summary of features:

Added help text (git redate -h).
Added CLI options sanitation (git redate now bails upon unrecognized options).
Updated to use $GIT_EDITOR / git var GIT_EDITOR for editing the re-dating specification file. This is a breaking change, though one that's likely to align git redate with the user's already-expressed preference (e.g. whatever they've defined as core.editor) rather than prompting them to express a preference interactively.
Added support for specifying git redate preferences in the Git client configuration file.
Added support for specifying arbitrary commit ranges.

Miscellaneous other changes:

Streamlined some code (e.g. removing repeated checks of the value of $ALL, $DEBUG, etc., instead using conditionally-defined functions).
Prevent trying to shift any arguments when $@ is already empty.
Added a dry-run mode, which was helpful for testing the other changes and perhaps useful for end users before re-dating For Real.
Fixed some shellcheck linting issues.
Formatted the code with shfmt.
Relocated the temporary file used for specifying date edits to the .git directory.

Thanks for your consideration!

rather than non-portable `/bin/bash`

with POSIX-compatible code.

iitzrohan · 2023-11-02T00:30:13Z

@tomeon Thanks for updating the tool.Can you add two more features.

Don't change the hash when redating.
Make it possible to sign commits with redating.

tomeon · 2023-11-03T15:44:25Z

Hello @iitzrohan -- thanks for your feedback/requests.

Don't change the hash when redating.

This is not possible.

Make it possible to sign commits with redating.

Done.

tomeon · 2023-11-06T13:51:02Z

@iitzrohan --

The latest changes doesn't opens the editor configured through gitconfig. Instead it uses the default editor nano.

I am unable to reproduce this; for me, git redate respects core.editor.

fatal: ambiguous argument [...]

Thanks; should be fixed now. I've updated git-redate to check the number of commits reachable from HEAD and choose the lower of (a) that number and (b) the number provided with git redate -c <count>. I've also updated git-redate to exit with nonzero status in case the provided commit range is invalid, or valid but causes git rev-list to emit no commits.

for features like CLI options processing and "am I in a git repo?" sanity-checks.

That is, remove redundant `shift` calls in the `--debug` and `--all` cases.

by conditionally defining a `debug` function based on whether the `-d/--debug` option was provided. If debugging is not enabled, the `debug` function is a NOP; otherwise, it echoes its arguments to stderr.

BREAKING CHANGE: diagnostic output no longer goes to stdout.

rather than custom editor selection code.

BREAKING CHANGE: introduces type-checking of `COMMITS`, `DEBUG`, and friends.

that provides a default value for the `COMMITS` variable. This variable is already guaranteed to be set to a positive integer (or else `git redate` will have exited).

within the body of the loop that applies the redate logic. Instead, conditionally define an `apply_redate` function depending on whether we saw `--all`, then call this function from within the loop.

rather than numbers of commits starting from HEAD (or all commits).

in help text

when generating the interactive commit selection list.

by passing the `-S`/`--gpg-sign` flag through to `commit-tree`.

by loading them via `git -c <name>=<value> --get <name>`.

BREAKING CHANGE: `git redate` exits with nonzero status in case no commits were identified.

tomeon · 2024-04-19T15:24:52Z

Ping @AaronVasquez @EdmundMai -- this changeset, besides being (IMHO 😉) worthwhile on its own merits, also likely fixes a number of issues. For instance:

Error, fatal ambiguous argument #6, Redate failed. #21, [Bug] [Critical] fatal: ambiguous argument 'HEAD~{some commits count}..HEAD' #39
[Bug] --all cli parameter → not works #38
Probably WARNING: Ref 'refs/heads/master' is unchanged #10, Not working 2022 #31, [Bug] --all cli parameter → not works #38

It also addresses or obviates several merge requests:

Is there anything I can do to help get this over the finish line? Thanks!

Adopt git-sh-setup and OPTIONS_SPEC for argument parsing. Benefits: - `git redate -h` now prints proper help text with examples. - Unknown options are rejected with a clear error rather than silently ignored (so typos like `--commmits` get caught). - Short flags can be combined: `-ad` works as `--all --debug`. - Every boolean flag gains a `--no-X` opt-out form, which is handy for shell aliases that bake in defaults. - The script can now be invoked from any subdirectory of the working tree, not just the repo root. Replace the bespoke interactive editor prompt and `~/.redate-settings` file with `git_editor`, which defers to the standard chain: $GIT_EDITOR, core.editor, $VISUAL, $EDITOR, then git's compiled fallback. Anyone who relied on the prompt is already covered by setting any of those. Reimplemented on top of our current base rather than cherry-picked because upstream PR PotatoLabs#43 also includes a bash->sh portability rewrite and a different signing implementation that would conflict with the touched-only signing scope from 80e8910. Original idea and most of the OPTIONS_SPEC layout from upstream PR PotatoLabs#43 by tomeon.

Prints the commits that would be rewritten and the exact filter-branch invocation that would run, then exits without making changes. Mostly for sanity-checking the scope-narrowing logic before letting it loose on a repo. Idea borrowed from upstream PR PotatoLabs#43 by tomeon.

Persistent defaults under redate.*, with CLI flags as overrides. Useful for setting up a global "always sign rewritten commits" preference, or a per-repo "default to -c 10" without aliasing. Supported keys: redate.all, redate.commits, redate.debug, redate.dryRun, redate.iKnowWhatImDoing, redate.sign, redate.signNow. The tri-state redate.sign maps true->yes, false->no, unset->auto (which then resolves against commit.gpgsign as before). Idea borrowed from upstream PR PotatoLabs#43 by tomeon.

`git redate HEAD~10..HEAD~5` (or any other rev-list expression) now opens an editor showing exactly those commits. Useful for surgically editing a window of history rather than always counting back from HEAD. Precedence: positional rev args > --all > -c N for choosing what to show. The filter-branch range is still derived from the oldest commit the user actually edited, so descendants between the top of the range and HEAD are necessarily rewritten (parent hashes change). Filter-branch can't avoid that without leaving the tip orphaned. Idea borrowed from upstream PR PotatoLabs#43 by tomeon, with different range semantics: theirs passes the range directly to filter-branch; ours treats it as editor scope and lets the existing oldest-touched logic decide the rewrite range.

No behavioural change for the happy path; the tr fix and the exit-code propagation are the only ones with any user-visible effect. - `tr -d '[[:space:]]'` was deleting literal `[` and `]` as well as whitespace. Replaced with the correct `tr -d '[:space:]'`. Hashes and ISO dates never contain brackets so it happened to work, but the intent was wrong. - Propagate filter-branch's exit code instead of always returning 0, so callers can detect failures. - Quote `$tmpfile` everywhere it's used as a redirect target or argument. - Backtick command substitution replaced with `$()`. - `read -r` everywhere so backslashes survive. - Replace the unused `message` variable with `_`. - Drop one useless `$(echo "$x")`. - Add shellcheck disables for two intentional patterns: OPTIONS_KEEPDASHDASH (consumed by sourced git-sh-setup) and the single-quoted COMMIT_FILTER strings (deliberately deferred expansion). The shellcheck pass itself is inspired by upstream PR PotatoLabs#43 by tomeon, who ran shfmt and addressed lints in a more sweeping reformat. We took just the substantive fixes and skipped the formatting reflow.

tomeon added 2 commits September 6, 2023 20:51

feat: use /bin/sh interpreter

31b043e

rather than non-portable `/bin/bash`

fix: replace Bash-specific code

cb735e0

with POSIX-compatible code.

tomeon force-pushed the git-sh-setup-integration branch from e270ba1 to e694418 Compare November 6, 2023 13:41

plasticrake reviewed Nov 10, 2023

View reviewed changes

Comment thread git-redate Outdated

tomeon added 21 commits November 10, 2023 15:33

feat: integrate with git's core shell library

79b0b57

for features like CLI options processing and "am I in a git repo?" sanity-checks.

feat: put tmpfile in .git

2ef2f30

chore: fix shellcheck linting errors

f452ac1

fix: do not attempt to shift > ARGC arguments

7c10c33

That is, remove redundant `shift` calls in the `--debug` and `--all` cases.

chore: simplify debugging code

ab3edd4

by conditionally defining a `debug` function based on whether the `-d/--debug` option was provided. If debugging is not enabled, the `debug` function is a NOP; otherwise, it echoes its arguments to stderr.

feat: add dry-run mode

af8bb17

chore: send diagnostics to stderr

3a86bc1

BREAKING CHANGE: diagnostic output no longer goes to stdout.

BREAKING CHANGE: use $GIT_EDITOR for date edits

6347f40

rather than custom editor selection code.

feat: support redate.<param> git config settings

0b8f0fb

BREAKING CHANGE: introduces type-checking of `COMMITS`, `DEBUG`, and friends.

chore: remove redundant git log

f6ef871

that provides a default value for the `COMMITS` variable. This variable is already guaranteed to be set to a positive integer (or else `git redate` will have exited).

feat: remove repeated --all option checks

addeaf1

within the body of the loop that applies the redate logic. Instead, conditionally define an `apply_redate` function depending on whether we saw `--all`, then call this function from within the loop.

chore: format code with shfmt

9469ef0

fix: add message for last chunk to be collected

5feb939

feat: permit specifying commit ranges

cbd8736

rather than numbers of commits starting from HEAD (or all commits).

chore: remove extraneous whitespace

0104765

feat: show examples of usage modes

0cdd22e

in help text

doc: describe new options and configuration params

486b531

fix: omit previously-filtered commits

a9b06b7

when generating the interactive commit selection list.

feat: support signing rewritten commits

7ca6aec

by passing the `-S`/`--gpg-sign` flag through to `commit-tree`.

fix: normalize Git configuration settings

7f121e1

by loading them via `git -c <name>=<value> --get <name>`.

fix: exit if no commits matched selection criteria

96e51ea

BREAKING CHANGE: `git redate` exits with nonzero status in case no commits were identified.

tomeon force-pushed the git-sh-setup-integration branch from e694418 to 96e51ea Compare November 10, 2023 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate with core Git subcommand authoring features.#43

Integrate with core Git subcommand authoring features.#43
tomeon wants to merge 23 commits into
PotatoLabs:masterfrom
tomeon:git-sh-setup-integration

tomeon commented Sep 8, 2023 •

edited

Loading

Uh oh!

iitzrohan commented Nov 2, 2023

Uh oh!

tomeon commented Nov 3, 2023

Uh oh!

tomeon commented Nov 6, 2023

Uh oh!

Uh oh!

tomeon commented Apr 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

tomeon commented Sep 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iitzrohan commented Nov 2, 2023

Uh oh!

tomeon commented Nov 3, 2023

Uh oh!

tomeon commented Nov 6, 2023

Uh oh!

Uh oh!

tomeon commented Apr 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tomeon commented Sep 8, 2023 •

edited

Loading